Update to v0.1.2 (#4)

Author: gmitch215

.gitignore

@@ -1,4 +1,6 @@
 .idea
 .gradle/
 build
-.DS_Store
+.DS_Store
+bin/
+.vscode/

README.md

@@ -2,8 +2,8 @@
 
 > Java & Kotlin Parser & API For LevelZ File Format
 
-[![](https://jitpack.io/v/LevelZ-File/java-bindings.svg)](https://jitpack.io/#LevelZ-File/java-bindings)
-[![JitCi](https://jitci.com/gh/LevelZ-File/java-bindings/svg)](https://jitci.com/gh/LevelZ-File/java-bindings)
+[![JitPack](https://jitpack.io/v/LevelZ-File/java-bindings.svg)](https://jitpack.io/#LevelZ-File/java-bindings)
+![GitHub Release](https://img.shields.io/github/v/release/LevelZ-File/java-bindings)
 
 ## Overview
 

build.gradle.kts

@@ -10,7 +10,7 @@ plugins {
 val jvm = JavaVersion.VERSION_11
 
 group = "me.gamercoder215.calcgames"
-version = "0.1.1"
+version = "0.1.2"
 
 java {
     sourceCompatibility = jvm

javadoc.sh

@@ -7,6 +7,7 @@ if [ ! -d "docs" ]; then
 fi;
 
 cp -Rfv build/docs/javadoc/* ./docs/
+cp -Rfv src/main/javadoc/favicon.ico ./docs/
 
 git switch -f gh-pages
 

src/main/java/me/gamercoder215/calcgames/levelz/Level2D.java

@@ -7,7 +7,6 @@
 
 import java.util.*;
 import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 /**
  * Represents a 2D level.

src/main/java/me/gamercoder215/calcgames/levelz/LevelExporter.java

@@ -7,6 +7,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.HashMap;
+import java.util.List;
 
 /**
  * Represents a class that exports a LevelZ Level to a file.
@@ -67,8 +70,19 @@ public String writeToString() {
         }
 
         if (includeData) {
-            for (LevelObject block : level.getBlocks())
-                builder.append(block.toString()).append(lineSeparator);
+            Map<Block, String> blockMap = new HashMap<>();
+            List<LevelObject> blocks = level.getBlocks().stream()
+                .sorted()
+                .collect(Collectors.toList());
+            
+            for (LevelObject block : blocks)
+                if (blockMap.containsKey(block.getBlock()))
+                    blockMap.put(block.getBlock(), blockMap.get(block.getBlock()) + "*" + block.getCoordinate().toString());
+                else
+                    blockMap.put(block.getBlock(), block.getCoordinate().toString());
+            
+            for (Map.Entry<Block, String> entry : blockMap.entrySet())
+                builder.append(entry.getKey()).append(": ").append(entry.getValue()).append(lineSeparator);
         }
 
         builder.append("end");

src/main/java/me/gamercoder215/calcgames/levelz/LevelObject.java

@@ -8,7 +8,7 @@
 /**
  * Utility Object for representing a Level Block and its Coordinate.
  */
-public final class LevelObject {
+public final class LevelObject implements Comparable<LevelObject> {
 
     private final Block block;
     private final Coordinate coordinate;
@@ -58,4 +58,9 @@ public int hashCode() {
     public String toString() {
         return block + ": " + coordinate;
     }
+
+    @Override
+    public int compareTo(LevelObject o) {
+        return coordinate.compareTo(o.coordinate);
+    }
 }

src/main/java/me/gamercoder215/calcgames/levelz/builder/LevelBuilder.java

@@ -5,6 +5,7 @@
 import me.gamercoder215.calcgames.levelz.coord.Coordinate2D;
 import me.gamercoder215.calcgames.levelz.coord.Coordinate3D;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
 
 import java.util.HashMap;
@@ -71,15 +72,40 @@ public LevelBuilder spawn(int[] coords) {
         return spawn(Coordinate.fromArray(coords));
     }
 
+    /**
+     * Sets the scroll direction for the level.
+     * @param scroll Scroll Direction
+     * @return this class, for chaining
+     * @throws IllegalArgumentException If the level is not 2D
+     */
+    @NotNull
+    public LevelBuilder scroll(@Nullable Scroll scroll) throws IllegalArgumentException {
+        if (!dimension.is2D())
+            throw new IllegalArgumentException("Scroll is only supported for 2D levels");
+        
+        if (scroll == null) 
+            headers.remove("scroll");
+        else 
+            headers.put("scroll", scroll.name().toLowerCase());
+        
+        return this;
+    }
+
     /**
      * Sets a header value.
      * @param key Header Key
-     * @param value Header Value
+     * @param value Header Value, can be null
      * @return this class, for chaining
+     * @throws IllegalArgumentException If the key is null
      */
     @NotNull
-    public LevelBuilder header(@NotNull String key, @NotNull String value) {
-        headers.put(key, value);
+    public LevelBuilder header(@NotNull String key, @Nullable String value) throws IllegalArgumentException {
+        if (key == null) throw new IllegalArgumentException("Key cannot be null");
+
+        if (value == null)
+            headers.remove(key);
+        else 
+            headers.put(key, value);
         return this;
     }
 

src/main/java/me/gamercoder215/calcgames/levelz/coord/Coordinate.java

@@ -6,7 +6,7 @@
 /**
  * Represents a Game Coordinate.
  */
-public interface Coordinate {
+public interface Coordinate extends Comparable<Coordinate> {
 
     /**
      * Gets the magnitude of the Coordinate.
@@ -38,4 +38,8 @@ static Coordinate fromArray(int[] coords) {
         throw new IllegalArgumentException("Invalid Coordinate Length");
     }
 
+    default int compareTo(@NotNull Coordinate o) {
+        return Double.compare(getMagnitude(), o.getMagnitude());
+    }
+
 }

src/main/java/me/gamercoder215/calcgames/levelz/coord/Coordinate2D.java

@@ -124,7 +124,11 @@ public int hashCode() {
 
     @Override
     public String toString() {
-        return "[" + x + ", " + y + "]";
+        int xInt = (int) x, yInt = (int) y;
+        String xs = x == xInt ? String.valueOf(xInt) : String.valueOf(x);
+        String ys = y == yInt ? String.valueOf(yInt) : String.valueOf(y);
+
+        return "[" + xs + ", " + ys + "]";
     }
 
     /**