remove dependency on apache.commons

Author: JasperGeurtz

pom.xml

@@ -59,13 +59,6 @@
             <version>4.5.2</version>
         </dependency>
 
-        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-lang3</artifactId>
-            <version>3.8.1</version>
-        </dependency>
-
         <!-- https://mvnrepository.com/artifact/junit/junit -->
         <dependency>
             <groupId>junit</groupId>

src/main/java/bwapi/Pair.java

@@ -0,0 +1,67 @@
+package bwapi;
+
+import java.util.Objects;
+
+public class Pair<K,V> {
+    private K first;
+    private V second;
+
+    public Pair(final K first, final V second) {
+        this.first = first;
+        this.second = second;
+    }
+
+    //BWMIRROR SUPPORT
+    public K getFirst() {
+        return first;
+    }
+
+    public V getSecond() {
+        return second;
+    }
+
+    //BWEM SUPPORT
+    public K getLeft() {
+        return first;
+    }
+
+    public V getRight() {
+        return second;
+    }
+
+    public void setLeft(final K left) {
+        first = left;
+    }
+
+    public void setRight(final V right) {
+        second = right;
+    }
+
+    //MAP.ENTRY SUPPORT
+    public K getKey() {
+        return first;
+    }
+
+    public V getValue() {
+        return second;
+    }
+
+    @Override
+    public String toString() {
+        return "{" + first + ", " + second + "}";
+    }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (o instanceof Pair) {
+            final Pair op = (Pair)o;
+            return first.equals(op.first) && second.equals(op.second);
+        }
+        return false;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(first, second);
+    }
+}

src/main/java/bwapi/UnitType.java

@@ -266,7 +266,7 @@ public Race getRace() {
         return UnitTypeContainer.unitRace[id];
     }
 
-    public Entry<UnitType, Integer> whatBuilds() {
+    public Pair<UnitType, Integer> whatBuilds() {
         // Retrieve the type
         final UnitType type = UnitTypeContainer.whatBuilds[id];
         int count = 1;
@@ -277,7 +277,7 @@ public Entry<UnitType, Integer> whatBuilds() {
             count = 2;
         }
         // Return the desired pair
-        return new AbstractMap.SimpleEntry<>(type, count);
+        return new Pair<>(type, count);
     }
 
     public Map<UnitType, Integer> requiredUnits() {

src/main/java/bwapi/UnitTypeContainer.java

@@ -1455,7 +1455,7 @@ private static List<Map<UnitType, Integer>> reqUnitsInit() {
         // Add the whatBuilds types to the required units map
         for (final UnitType i : UnitType.values()) {
             req.add(new HashMap<>());
-            final Map.Entry<UnitType, Integer> wb = i.whatBuilds();
+            final Pair<UnitType, Integer> wb = i.whatBuilds();
             if (wb.getKey() != UnitType.None) {
                 req.get(i.id).put(wb.getKey(), wb.getValue());
             }

src/main/java/bwem/ChokePoint.java

@@ -16,7 +16,7 @@
 import bwem.area.Area;
 import bwem.typedef.CPPath;
 import bwem.unit.Neutral;
-import org.apache.commons.lang3.tuple.Pair;
+import bwapi.Pair;
 
 import java.util.List;
 

src/main/java/bwem/ChokePointImpl.java

@@ -20,9 +20,9 @@
 import bwem.typedef.CPPath;
 import bwem.typedef.Index;
 import bwem.unit.Neutral;
-import org.apache.commons.lang3.tuple.ImmutablePair;
-import org.apache.commons.lang3.tuple.MutablePair;
-import org.apache.commons.lang3.tuple.Pair;
+import bwapi.Pair;
+import bwapi.Pair;
+import bwapi.Pair;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -34,7 +34,7 @@ public class ChokePointImpl implements ChokePoint {
     private final Index index;
     private final Pair<Area, Area> areas;
     private final WalkPosition[] nodes;
-    private final List<MutablePair<WalkPosition, WalkPosition>> nodesInArea;
+    private final List<Pair<WalkPosition, WalkPosition>> nodesInArea;
     private final List<WalkPosition> geometry;
     private boolean isBlocked;
     private Neutral blockingNeutral;
@@ -53,7 +53,7 @@ public ChokePointImpl(
 
         this.graph = graph;
         this.index = index;
-        this.areas = new ImmutablePair<>(area1, area2);
+        this.areas = new Pair<>(area1, area2);
         this.geometry = geometry;
 
         // Ensures that in the case where several neutrals are stacked, blockingNeutral points to the
@@ -72,7 +72,7 @@ public ChokePointImpl(
 
         this.nodesInArea = new ArrayList<>(Node.NODE_COUNT.ordinal());
         for (int i = 0; i < Node.NODE_COUNT.ordinal(); ++i) {
-            this.nodesInArea.add(new MutablePair<>(new WalkPosition(0, 0), new WalkPosition(0, 0)));
+            this.nodesInArea.add(new Pair<>(new WalkPosition(0, 0), new WalkPosition(0, 0)));
         }
 
         int i = geometry.size() / 2;
@@ -143,8 +143,8 @@ > getMap().getData().getMiniTile(geometry.get(i)).getAltitude().intValue())) {
                  */
                 final WalkPosition left = nodesInArea.get(n).getLeft();
                 final WalkPosition right = nodesInArea.get(n).getRight();
-                final MutablePair<WalkPosition, WalkPosition> replacementPair =
-                        new MutablePair<>(left, right);
+                final Pair<WalkPosition, WalkPosition> replacementPair =
+                        new Pair<>(left, right);
                 if (area.equals(this.areas.getLeft())) {
                     replacementPair.setLeft(nodeInArea);
                 } else {

src/main/java/bwem/Graph.java

@@ -34,10 +34,7 @@
 import bwem.unit.StaticBuilding;
 import bwem.util.BwemExt;
 import bwem.util.Utils;
-import org.apache.commons.lang3.mutable.MutableInt;
-import org.apache.commons.lang3.tuple.ImmutablePair;
-import org.apache.commons.lang3.tuple.MutablePair;
-import org.apache.commons.lang3.tuple.Pair;
+import bwapi.Pair;
 
 import java.util.*;
 
@@ -287,7 +284,7 @@ public List<Base> getBases() {
 
     // Creates a new Area for each pair (top, miniTiles) in areasList (See Area::top() and
     // Area::miniTiles())
-    public void createAreas(final List<MutablePair<WalkPosition, Integer>> areasList) {
+    public void createAreas(final List<Pair<WalkPosition, Integer>> areasList) {
         for (int id = 1; id <= areasList.size(); ++id) {
             final WalkPosition top = areasList.get(id - 1).getLeft();
             final int miniTileCount = areasList.get(id - 1).getRight();
@@ -322,13 +319,13 @@ private void initializeChokePointsMatrix(
     // ----------------------------------------------------------------------
     // 2) Dispatch the global raw frontier between all the relevant pairs of areas:
     // ----------------------------------------------------------------------
-    private java.util.Map<MutablePair<AreaId, AreaId>, List<WalkPosition>>
+    private java.util.Map<Pair<AreaId, AreaId>, List<WalkPosition>>
     createRawFrontierByAreaPairMap(
-            final List<MutablePair<MutablePair<AreaId, AreaId>, WalkPosition>> rawFrontier) {
-        final java.util.Map<MutablePair<AreaId, AreaId>, List<WalkPosition>> rawFrontierByAreaPair =
+            final List<Pair<Pair<AreaId, AreaId>, WalkPosition>> rawFrontier) {
+        final java.util.Map<Pair<AreaId, AreaId>, List<WalkPosition>> rawFrontierByAreaPair =
                 new HashMap<>();
 
-        for (final MutablePair<MutablePair<AreaId, AreaId>, WalkPosition> raw : rawFrontier) {
+        for (final Pair<Pair<AreaId, AreaId>, WalkPosition> raw : rawFrontier) {
             int a = raw.getLeft().getLeft().intValue();
             int b = raw.getLeft().getRight().intValue();
             if (a > b) {
@@ -345,7 +342,7 @@ private void initializeChokePointsMatrix(
                 throw new IllegalStateException();
             }
 
-            final MutablePair<AreaId, AreaId> key = new MutablePair<>(new AreaId(a), new AreaId(b));
+            final Pair<AreaId, AreaId> key = new Pair<>(new AreaId(a), new AreaId(b));
             rawFrontierByAreaPair.computeIfAbsent(key, mp -> new ArrayList<>()).add(raw.getRight());
         }
 
@@ -360,7 +357,7 @@ private void initializeChokePointsMatrix(
     public void createChokePoints(
             final List<StaticBuilding> staticBuildings,
             final List<Mineral> minerals,
-            final List<MutablePair<MutablePair<AreaId, AreaId>, WalkPosition>> rawFrontier) {
+            final List<Pair<Pair<AreaId, AreaId>, WalkPosition>> rawFrontier) {
         Index newIndex = new Index(0);
 
         final List<Neutral> blockingNeutrals = new ArrayList<>();
@@ -389,13 +386,13 @@ public void createChokePoints(
         initializeChokePointsMatrix(this.chokePointsMatrix, getAreaCount());
 
         // 2) Dispatch the global raw frontier between all the relevant pairs of areas:
-        final java.util.Map<MutablePair<AreaId, AreaId>, List<WalkPosition>> rawFrontierByAreaPair =
+        final java.util.Map<Pair<AreaId, AreaId>, List<WalkPosition>> rawFrontierByAreaPair =
                 createRawFrontierByAreaPairMap(rawFrontier);
 
         // 3) For each pair of areas (A, B):
-        for (final java.util.Map.Entry<MutablePair<AreaId, AreaId>, List<WalkPosition>> entry :
+        for (final java.util.Map.Entry<Pair<AreaId, AreaId>, List<WalkPosition>> entry :
                 rawFrontierByAreaPair.entrySet()) {
-            MutablePair<AreaId, AreaId> rawleft = entry.getKey();
+            Pair<AreaId, AreaId> rawleft = entry.getKey();
             final List<WalkPosition> rawFrontierAB = entry.getValue();
 
             // Because our dispatching preserved order,
@@ -709,7 +706,7 @@ private int[] computeDistances(final ChokePoint start, final List<ChokePoint> ta
 
         final Queue<Pair<Integer, ChokePoint>> toVisit =
                 new PriorityQueue<>(Comparator.comparingInt(a -> a.getLeft()));
-        toVisit.offer(new ImmutablePair<>(0, start));
+        toVisit.offer(new Pair<>(0, start));
 
         int remainingTargets = targets.size();
         while (!toVisit.isEmpty()) {
@@ -753,18 +750,18 @@ private int[] computeDistances(final ChokePoint start, final List<ChokePoint> ta
                                     // To update next's distance, we need to remove-insert it from toVisit:
                                     //                                    bwem_assert(iNext != range.second);
                                     final boolean removed =
-                                            toVisit.remove(new ImmutablePair<>(((TileImpl) nextTile).getInternalData(), next));
+                                            toVisit.remove(new Pair<>(((TileImpl) nextTile).getInternalData(), next));
                                     if (!removed) {
                                         throw new IllegalStateException();
                                     }
                                     ((TileImpl) nextTile).setInternalData(newNextDist);
                                     ((ChokePointImpl) next).setPathBackTrace(current);
-                                    toVisit.offer(new ImmutablePair<>(newNextDist, next));
+                                    toVisit.offer(new Pair<>(newNextDist, next));
                                 }
                             } else {
                                 ((TileImpl) nextTile).setInternalData(newNextDist);
                                 ((ChokePointImpl) next).setPathBackTrace(current);
-                                toVisit.offer(new ImmutablePair<>(newNextDist, next));
+                                toVisit.offer(new Pair<>(newNextDist, next));
                             }
                         }
                     }

src/main/java/bwem/MutableInt.java

@@ -0,0 +1,13 @@
+package bwem;
+
+public class MutableInt {
+    private int value;
+
+    public int intValue() {
+        return value;
+    }
+
+    public void setValue(final int value) {
+        this.value = value;
+    }
+}

src/main/java/bwem/area/AreaInitializerImpl.java

@@ -25,8 +25,8 @@
 import bwem.tile.TileImpl;
 import bwem.unit.*;
 import bwem.util.BwemExt;
-import org.apache.commons.lang3.tuple.ImmutablePair;
-import org.apache.commons.lang3.tuple.Pair;
+import bwapi.Pair;
+import bwapi.Pair;
 
 import java.util.*;
 
@@ -207,7 +207,7 @@ public int[] computeDistances(final TilePosition start, final List<TilePosition>
                         Comparator.comparingInt(
                                 Pair::getLeft)); // a priority queue holding the tiles to visit ordered by their
         // distance to start.
-        toVisit.offer(new ImmutablePair<>(0, start));
+        toVisit.offer(new Pair<>(0, start));
 
         int remainingTargets = targets.size();
         while (!toVisit.isEmpty()) {
@@ -260,17 +260,17 @@ public int[] computeDistances(final TilePosition start, final List<TilePosition>
                                 // To update next's distance, we need to remove-insert it from toVisit:
                                 //                                bwem_assert(iNext != range.second);
                                 final boolean removed =
-                                        toVisit.remove(new ImmutablePair<>(((TileImpl) nextTile).getInternalData(), next));
+                                        toVisit.remove(new Pair<>(((TileImpl) nextTile).getInternalData(), next));
                                 if (!removed) {
                                     throw new IllegalStateException();
                                 }
                                 ((TileImpl) nextTile).setInternalData(newNextDist);
-                                toVisit.offer(new ImmutablePair<>(newNextDist, next));
+                                toVisit.offer(new Pair<>(newNextDist, next));
                             }
                         } else if ((nextTile.getAreaId().equals(getId()))
                                 || (nextTile.getAreaId().equals(UNINITIALIZED))) {
                             ((TileImpl) nextTile).setInternalData(newNextDist);
-                            toVisit.offer(new ImmutablePair<>(newNextDist, next));
+                            toVisit.offer(new Pair<>(newNextDist, next));
                         }
                     }
                 }

src/main/java/bwem/map/Map.java

@@ -24,8 +24,7 @@
 import bwem.typedef.CPPath;
 import bwem.typedef.Pred;
 import bwem.unit.NeutralData;
-import org.apache.commons.lang3.mutable.MutableInt;
-import org.apache.commons.lang3.tuple.MutablePair;
+import bwapi.Pair;
 
 import java.util.List;
 
@@ -150,7 +149,7 @@ public interface Map {
     //       To avoid this and the potential performance penalty, just make sure getArea(a) != nullptr
     // and getArea(b) != nullptr.
     //       Then GetPath should perform very quick.
-    CPPath getPath(Position a, Position b, MutableInt pLength);
+    int getPathLength(Position a, Position b);
 
     CPPath getPath(Position a, Position b);
 
@@ -167,6 +166,6 @@ WalkPosition breadthFirstSearch(
     WalkPosition breadthFirstSearch(WalkPosition start, Pred findCond, Pred visitCond);
 
     // Returns the union of the geometry of all the ChokePoints. Cf. ChokePoint::Geometry()
-    List<MutablePair<MutablePair<AreaId, AreaId>, WalkPosition>> getRawFrontier();
+    List<Pair<Pair<AreaId, AreaId>, WalkPosition>> getRawFrontier();
 
 }