Explicit requirement of mapping format identifier

changelogs/0.6.0.md

@@ -50,6 +50,14 @@ extension with the new multiple file extension functionality (detailed below).
 
 ## Mapping Formats
 
+### Registration
+
+Mapping Formats are still registered by use of service loaders, populating a registry in
+`MappingFormats` - however their registration key (identifier) is now more explicit, and
+formats are able to provide a name. Implementations must now provide the following:
+- Name (can be used by tools such as Symphony)
+- Identifier (used as the registration key)
+
 ### File extensions
 
 Mapping Formats can now specify multiple file extensions that are typical, this will allow

lorenz-io-enigma/src/main/java/org/cadixdev/lorenz/io/enigma/EnigmaMappingFormat.java

@@ -44,6 +44,16 @@
  */
 public class EnigmaMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "enigma";
+    }
+
+    @Override
+    public String getName() {
+        return "Enigma";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new EnigmaReader(reader);
@@ -67,9 +77,4 @@ public Collection<String> getFileExtensions() {
         ));
     }
 
-    @Override
-    public String toString() {
-        return "enigma";
-    }
-
 }

lorenz-io-gson/src/main/java/org/cadixdev/lorenz/io/gson/JsonMappingFormat.java

@@ -41,6 +41,16 @@
  */
 public class JsonMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "gson";
+    }
+
+    @Override
+    public String getName() {
+        return "Lorenz JSON";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new JsonReader(reader);
@@ -56,9 +66,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(JsonConstants.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "gson";
-    }
-
 }

lorenz-io-jam/src/main/java/org/cadixdev/lorenz/io/jam/JamMappingFormat.java

@@ -41,6 +41,16 @@
  */
 public class JamMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "jam";
+    }
+
+    @Override
+    public String getName() {
+        return "JAM";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new JamReader(reader);
@@ -56,9 +66,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(JamConstants.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "jam";
-    }
-
 }

lorenz-io-kin/src/main/java/org/cadixdev/lorenz/io/kin/KinMappingFormat.java

@@ -42,6 +42,16 @@
  */
 public class KinMappingFormat implements MappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "kin";
+    }
+
+    @Override
+    public String getName() {
+        return "Kin";
+    }
+
     @Override
     public MappingsReader createReader(final InputStream stream) throws IOException {
         return new KinReader(stream);
@@ -57,9 +67,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(KinConstants.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "kin";
-    }
-
 }

lorenz-io-proguard/src/main/java/org/cadixdev/lorenz/io/proguard/ProGuardFormat.java

@@ -41,6 +41,16 @@
  */
 public class ProGuardFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "proguard";
+    }
+
+    @Override
+    public String getName() {
+        return "ProGuard";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new ProGuardReader(reader);
@@ -56,9 +66,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.empty();
     }
 
-    @Override
-    public String toString() {
-        return "proguard";
-    }
-
 }

lorenz/src/main/java/org/cadixdev/lorenz/io/MappingFormat.java

@@ -44,6 +44,24 @@
  */
 public interface MappingFormat {
 
+    /**
+     * Gets the internal identifier for this mapping format.
+     * <p>
+     * This will be used as the registration identifier for the format registry.
+     *
+     * @return The identifier
+     * @since 0.6.0
+     */
+    String getIdentifier();
+
+    /**
+     * Gets the name of this mapping format.
+     *
+     * @return The name
+     * @since 0.6.0
+     */
+    String getName();
+
     /**
      * Creates a {@link MappingsReader} from the given {@link InputStream}
      * for the mapping format.

lorenz/src/main/java/org/cadixdev/lorenz/io/MappingFormats.java

@@ -45,7 +45,7 @@ public final class MappingFormats {
     static {
         // Populate the registry
         for (final MappingFormat format : ServiceLoader.load(MappingFormat.class)) {
-            REGISTRY.register(format.toString(), format);
+            REGISTRY.register(format.getIdentifier(), format);
         }
     }
 

lorenz/src/main/java/org/cadixdev/lorenz/io/srg/SrgMappingFormat.java

@@ -41,6 +41,16 @@
  */
 public class SrgMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "srg";
+    }
+
+    @Override
+    public String getName() {
+        return "SRG";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new SrgReader(reader);
@@ -56,9 +66,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(SrgConstants.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "srg";
-    }
-
 }

lorenz/src/main/java/org/cadixdev/lorenz/io/srg/csrg/CSrgMappingFormat.java

@@ -42,6 +42,16 @@
  */
 public class CSrgMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "csrg";
+    }
+
+    @Override
+    public String getName() {
+        return "CSRG";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new CSrgReader(reader);
@@ -57,9 +67,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(SrgConstants.CSrg.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "csrg";
-    }
-
 }

lorenz/src/main/java/org/cadixdev/lorenz/io/srg/tsrg/TSrgMappingFormat.java

@@ -42,6 +42,16 @@
  */
 public class TSrgMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "tsrg";
+    }
+
+    @Override
+    public String getName() {
+        return "TSRG";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new TSrgReader(reader);
@@ -57,9 +67,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(SrgConstants.TSrg.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "tsrg";
-    }
-
 }

lorenz/src/main/java/org/cadixdev/lorenz/io/srg/xsrg/XSrgMappingFormat.java

@@ -42,6 +42,16 @@
  */
 public class XSrgMappingFormat implements TextMappingFormat {
 
+    @Override
+    public String getIdentifier() {
+        return "xsrg";
+    }
+
+    @Override
+    public String getName() {
+        return "XSRG";
+    }
+
     @Override
     public MappingsReader createReader(final Reader reader) {
         return new XSrgReader(reader);
@@ -57,9 +67,4 @@ public Optional<String> getStandardFileExtension() {
         return Optional.of(SrgConstants.XSrg.STANDARD_EXTENSION);
     }
 
-    @Override
-    public String toString() {
-        return "xsrg";
-    }
-
 }