add docu + small fixes

Author: JasperGeurtz

src/main/java/bwem/Asserter.java

@@ -18,14 +18,16 @@ void throwIllegalStateException(String message) {
             try {
                 throw exception;
             } catch (IllegalStateException e) {
-                try {
-                    outStream.write(Arrays
-                            .stream(e.getStackTrace())
-                            .map(s -> s.toString() + "\n")
-                            .collect(Collectors.joining())
-                            .getBytes());
-                } catch (IOException ex) {
-                    ex.printStackTrace();
+                if (outStream != null) {
+                    try {
+                        outStream.write(Arrays
+                                .stream(e.getStackTrace())
+                                .map(s -> s.toString() + "\n")
+                                .collect(Collectors.joining())
+                                .getBytes());
+                    } catch (IOException ex) {
+                        ex.printStackTrace();
+                    }
                 }
             }
         }

src/main/java/bwem/BWEM.java

@@ -23,6 +23,8 @@
  * By default BWEM throws when an invalid state is encountered.
  * But if you know what you are doing, you can skip these throws by setting
  * {@link #setFailOnError} to `false`.
+ * These errors will then be outputted to {@link System.err}, but this can also be changed
+ * with {@link #setFailOutputStream} (if you set it to `null` the errors will be completely ignored).
  */
 public final class BWEM {
     private final BWMap map;

src/main/java/bwem/BWMap.java

@@ -37,7 +37,7 @@ public abstract class BWMap {
     Altitude highestAltitude;
     final Asserter asserter;
 
-    BWMap(final Game game, Asserter asserter) {
+    BWMap(final Game game, final Asserter asserter) {
         this.game = game;
         this.players = game.getPlayers();
         this.mineralPatches = game.getMinerals();

src/main/java/bwem/MiniTile.java

@@ -42,9 +42,9 @@ public final class MiniTile {
             areaId; // 0 -> unwalkable  ;  > 0 -> index of some Area  ;  < 0 -> some walkable terrain, but
     // too small to be part of an Area
 
-    private Asserter asserter;
+    private final Asserter asserter;
 
-    MiniTile(Asserter asserter) {
+    MiniTile(final Asserter asserter) {
         this.altitude = Altitude.UNINITIALIZED;
         this.areaId = UNINITIALIZED;
         this.asserter = asserter;

src/main/java/bwem/TempAreaInfo.java

@@ -33,7 +33,7 @@ class TempAreaInfo {
 
     private final Asserter asserter;
 
-    TempAreaInfo(Asserter asserter) {
+    TempAreaInfo(final Asserter asserter) {
         this.isValid = false;
         this.id = AreaId.ZERO;
         this.walkPositionWithHighestAltitude = new WalkPosition(0, 0);

src/main/java/bwem/Tile.java

@@ -41,7 +41,7 @@ public final class Tile {
     private boolean isBuildable;
     private boolean isDoodad;
 
-    private Asserter asserter;
+    private final Asserter asserter;
 
     Tile(final Asserter asserter) {
         this.markable = new Markable(Tile.staticMarkable);

src/main/java/bwem/TileData.java

@@ -19,7 +19,7 @@ final class TileData {
 
     final Asserter asserter;
 
-    TileData(final int tileCount, final int miniTileCount, Asserter asserter) {
+    TileData(final int tileCount, final int miniTileCount, final Asserter asserter) {
         tiles = new Tile[tileCount];
         this.asserter = asserter;
         for (int i = 0; i < tileCount; ++i) {