[LIB-9] Add SAN, NAG, move number and result PGN tokens

[chesshog.git] / chesshog-format / src / main / java / org / hedgecode / chess / pgn / nag / Glyph.java

diff --git a/chesshog-format/src/main/java/org/hedgecode/chess/pgn/nag/Glyph.java b/chesshog-format/src/main/java/org/hedgecode/chess/pgn/nag/Glyph.java
new file mode 100644 (file)
index 0000000..b343300
--- /dev/null
+++ b/chesshog-format/src/main/java/org/hedgecode/chess/pgn/nag/Glyph.java
@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2018-2020. Developed by Hedgecode.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.hedgecode.chess.pgn.nag;
+
+/**
+ * Numeric Annotation Glyph (NAG) Enum.
+ *
+ * @author Dmitry Samoshin aka gotty
+ */
+public enum Glyph {
+
+    NULL               ( 0, null, "null annotation" ),
+    GOOD_MOVE          ( 1, "!",  "good move" ),
+    POOR_MOVE          ( 2, "?",  "poor move" ),
+    VERY_GOOD_MOVE     ( 3, "!!", "very good move" ),
+    VERY_POOR_MOVE     ( 4, "??", "very poor move" ),
+    SPECULATIVE_MOVE   ( 5, "!?", "speculative move" ),
+    QUESTIONABLE_MOVE  ( 6, "?!", "questionable move" );
+    // todo: ...
+
+    private int number;
+    private String symbol;
+    private String interpretation;
+
+    Glyph(int number, String symbol, String interpretation) {
+        this.number = number;
+        this.symbol = symbol;
+        this.interpretation = interpretation;
+    }
+
+    public int number() {
+        return number;
+    }
+
+    public String symbol() {
+        return symbol;
+    }
+
+    public String interpretation() {
+        return interpretation;
+    }
+
+    public static Glyph byNumber(int number) {
+        for (Glyph glyph : Glyph.values()) {
+            if (glyph.number == number) {
+                return glyph;
+            }
+        }
+        return null;
+    }
+
+    public static Glyph bySymbol(String symbol) {
+        if (symbol == null) return NULL;
+        for (Glyph glyph : Glyph.values()) {
+            if (symbol.equals(glyph.symbol)) {
+                return glyph;
+            }
+        }
+        return null;
+    }
+
+}