Adds static methods for flexibility purposes

Author: SpaiR

src/main/java/io/github/spair/byond/dmi/DmiComparator.java

@@ -17,6 +17,19 @@
  */
 public final class DmiComparator {
 
+    /**
+     * Static method to compare two dmi's. Same as {@link #compare(Dmi, Dmi)},
+     * with {@link DmiComparator} instantiation under the hood.
+     *
+     * @param oldDmi old {@link io.github.spair.byond.dmi.Dmi} object or null
+     * @param newDmi new {@link io.github.spair.byond.dmi.Dmi} object or null
+     * @return {@link io.github.spair.byond.dmi.DmiDiff} object
+     */
+    @Nonnull
+    public static DmiDiff compareDmi(@Nullable final Dmi oldDmi, @Nullable final Dmi newDmi) {
+        return new DmiComparator().compare(oldDmi, newDmi);
+    }
+
     /**
      * Compares two {@link io.github.spair.byond.dmi.Dmi} objects. One of argument may be null,
      * which will be interpreted as if another Dmi created if null is the first parameter or deleted if vice versa.

src/main/java/io/github/spair/byond/dmi/DmiSlurper.java

@@ -14,13 +14,51 @@
 import java.util.Map;
 
 /**
- * Class to extract {@link io.github.spair.byond.dmi.Dmi} object from file/base64 string/raw input stream.
+ * Class to extract {@link io.github.spair.byond.dmi.Dmi} object from file, base64 string or raw input stream.
  */
 public final class DmiSlurper {
 
     private final MetaExtractor metaExtractor = new MetaExtractor();
     private final StateExtractor stateExtractor = new StateExtractor();
 
+    /**
+     * Static method to process file. Same as {@link #slurpUp(File)},
+     * with {@link DmiSlurper} instantiation under the hood.
+     *
+     * @param dmiFile file to deserialize
+     * @return {@link io.github.spair.byond.dmi.Dmi} object
+     */
+    @Nonnull
+    public static Dmi slurpUpFile(final File dmiFile) {
+        return new DmiSlurper().slurpUp(dmiFile);
+    }
+
+    /**
+     * Static method to process file. Same as {@link #slurpUp(String, String)},
+     * with {@link DmiSlurper} instantiation under the hood.
+     *
+     * @param dmiName the name of resulted {@link io.github.spair.byond.dmi.Dmi} object
+     * @param base64content base64 string to deserialize
+     * @return {@link io.github.spair.byond.dmi.Dmi} object
+     */
+    @Nonnull
+    public static Dmi slurpUpBase64(final String dmiName, final String base64content) {
+        return new DmiSlurper().slurpUp(dmiName, base64content);
+    }
+
+    /**
+     * Static method to process file. Same as {@link #slurpUp(String, InputStream)},
+     * with {@link DmiSlurper} instantiation under the hood.
+     *
+     * @param dmiName the name of resulted {@link io.github.spair.byond.dmi.Dmi} object
+     * @param input raw input stream to deserialize
+     * @return {@link io.github.spair.byond.dmi.Dmi} object
+     */
+    @Nonnull
+    public static Dmi slurpUpStream(final String dmiName, final InputStream input) {
+        return new DmiSlurper().slurpUp(dmiName, input);
+    }
+
     /**
      * @param dmiFile file to deserialize
      * @return {@link io.github.spair.byond.dmi.Dmi} object

src/main/java/io/github/spair/byond/dmi/MetaExtractor.java

@@ -18,9 +18,6 @@
 
 final class MetaExtractor {
 
-    MetaExtractor() {
-    }
-
     private static final String PNG_MIME = "image/png";
 
     private static final String META_ELEMENT_TAG = "TextEntry";

src/main/java/io/github/spair/byond/dmi/StateExtractor.java

@@ -11,9 +11,6 @@
 
 final class StateExtractor {
 
-    StateExtractor() {
-    }
-
     Map<String, DmiState> extractStates(final BufferedImage dmiImage, final DmiMeta dmiMeta) {
         final int dmiWidth = dmiImage.getWidth();
         final int spriteWidth = dmiMeta.getSpritesWidth();

src/test/java/io/github/spair/byond/dmi/DmiComparatorTest.java

@@ -18,6 +18,17 @@ public class DmiComparatorTest {
     private static final String ROLLERBED_ORIGINAL_PATH = "src/test/resources/rollerbed_original.dmi";
     private static final String ROLLERBED_DIFF_PATH = "src/test/resources/rollerbed_original_diff.dmi";
 
+    @Test
+    public void testStaticCompare() {
+        Dmi original = dmiSlurper.slurpUp(new File(ROLLERBED_ORIGINAL_PATH));
+        Dmi modified = dmiSlurper.slurpUp(new File(ROLLERBED_DIFF_PATH));
+
+        DmiDiff diffSimple = dmiComparator.compare(original, modified);
+        DmiDiff diffStatic = DmiComparator.compareDmi(original, modified);
+
+        assertEquals(diffSimple, diffStatic);
+    }
+
     @Test
     public void testCompareWhenNotSame() {
         Dmi original = dmiSlurper.slurpUp(new File(ROLLERBED_ORIGINAL_PATH));

src/test/java/io/github/spair/byond/dmi/DmiSlurperTest.java

@@ -16,6 +16,27 @@ public class DmiSlurperTest {
 
     private final DmiSlurper dmiSlurper = new DmiSlurper();
 
+    @Test
+    public void testStaticSlurpUpFromFile() {
+        File dmiFile = new File("src/test/resources/rollerbed_original.dmi");
+        Dmi dmi = DmiSlurper.slurpUpFile(dmiFile);
+        commonDmiAssertion(dmi);
+    }
+
+    @Test
+    public void testStaticSlurpUpFromBase64Content() throws Exception {
+        String filePath = "src/test/resources/rollerbed_original_base64.txt";
+        Dmi dmi = DmiSlurper.slurpUpBase64("rollerbed_original.dmi", new String(Files.readAllBytes(Paths.get(filePath))));
+        commonDmiAssertion(dmi);
+    }
+
+    @Test
+    public void testStaticSlurpUpFromInputStream() throws Exception {
+        File dmiFile = new File("src/test/resources/rollerbed_original.dmi");
+        Dmi dmi = DmiSlurper.slurpUpStream("rollerbed_original.dmi", new FileInputStream(dmiFile));
+        commonDmiAssertion(dmi);
+    }
+
     @Test
     public void testSlurpUpFromFile() {
         File dmiFile = new File("src/test/resources/rollerbed_original.dmi");