Merge pull request #102 from dcolazin/apache-commons-dep

use apache commons stringutils

pom.xml

@@ -14,6 +14,11 @@
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.12.0</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

src/main/java/com/github/bhlangonijr/chesslib/Board.java

@@ -34,6 +34,7 @@
 import com.github.bhlangonijr.chesslib.move.MoveGenerator;
 import com.github.bhlangonijr.chesslib.move.MoveList;
 import com.github.bhlangonijr.chesslib.util.XorShiftRandom;
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * The definition of a chessboard position and its status. It exposes methods to manipulate the board, evolve the
@@ -777,7 +778,7 @@ public void loadFromFen(String fen) {
             for (int i = 0; i < r.length(); i++) {
                 char c = r.charAt(i);
                 if (Character.isDigit(c)) {
-                    file += Integer.parseInt(c + "");
+                    file += Character.digit(c, 10);
                 } else {
                     Square sq = Square.encode(Rank.allRanks[rank], File.allFiles[file]);
                     setPiece(Piece.fromFenSymbol(String.valueOf(c)), sq);
@@ -809,7 +810,7 @@ public void loadFromFen(String fen) {
             castleRight.put(Side.BLACK, CastleRight.NONE);
         }
 
-        String[] flags = state.split(" ");
+        String[] flags = state.split(StringUtils.SPACE);
 
         if (flags.length >= 3) {
             String s = flags[2].toUpperCase().trim();
@@ -929,7 +930,7 @@ public String getFen(boolean includeCounters, boolean onlyOutputEnPassantIfCaptu
             fen.append(" b");
         }
 
-        String rights = "";
+        String rights = StringUtils.EMPTY;
         if (CastleRight.KING_AND_QUEEN_SIDE.
                 equals(castleRight.get(Side.WHITE))) {
             rights += "KQ";
@@ -952,26 +953,25 @@ public String getFen(boolean includeCounters, boolean onlyOutputEnPassantIfCaptu
             rights += "q";
         }
 
-        if (rights.equals("")) {
+        if (StringUtils.isEmpty(rights)) {
             fen.append(" -");
         } else {
-            fen.append(" " + rights);
+            fen.append(StringUtils.SPACE + rights);
         }
 
         if (Square.NONE.equals(getEnPassant())
                 || (onlyOutputEnPassantIfCapturable
                 && !pawnCanBeCapturedEnPassant())) {
             fen.append(" -");
         } else {
-            fen.append(" ");
+            fen.append(StringUtils.SPACE);
             fen.append(getEnPassant().toString().toLowerCase());
         }
 
         if (includeCounters) {
-            fen.append(" ");
+            fen.append(StringUtils.SPACE);
             fen.append(getHalfMoveCounter());
-
-            fen.append(" ");
+            fen.append(StringUtils.SPACE);
             fen.append(getMoveCounter());
         }
 
@@ -1525,8 +1525,8 @@ public void setEnableEvents(boolean enableEvents) {
      * @see Board#getZobristKey()
      */
     public String getPositionId() {
-        String[] parts = this.getFen(false).split(" ");
-        return parts[0] + " " + parts[1] + " " + parts[2] +
+        String[] parts = this.getFen(false).split(StringUtils.SPACE);
+        return parts[0] + StringUtils.SPACE + parts[1] + StringUtils.SPACE + parts[2] +
                 (this.getEnPassantTarget() != Square.NONE ? parts[3] : "-");
     }
 

src/main/java/com/github/bhlangonijr/chesslib/File.java

@@ -16,6 +16,8 @@
 
 package com.github.bhlangonijr.chesslib;
 
+import org.apache.commons.lang3.StringUtils;
+
 /**
  * The files in a board. A <i>file</i> is a column in the chessboard, and it is identified as a letter from {@code A} to
  * {@code H}.
@@ -59,7 +61,7 @@ public enum File {
     /**
      * Special value that represents no file in particular.
      */
-    NONE("");
+    NONE(StringUtils.EMPTY);
 
     public static final File[] allFiles = values();
 

src/main/java/com/github/bhlangonijr/chesslib/PieceType.java

@@ -16,6 +16,8 @@
 
 package com.github.bhlangonijr.chesslib;
 
+import org.apache.commons.lang3.StringUtils;
+
 import java.util.HashMap;
 import java.util.Map;
 
@@ -30,7 +32,7 @@ public enum PieceType {
     /**
      * The pawn piece type.
      */
-    PAWN(""),
+    PAWN(StringUtils.EMPTY),
     /**
      * The knight piece type.
      */

src/main/java/com/github/bhlangonijr/chesslib/Rank.java

@@ -16,6 +16,8 @@
 
 package com.github.bhlangonijr.chesslib;
 
+import org.apache.commons.lang3.StringUtils;
+
 /**
  * The ranks in a board. A <i>rank</i> is a raw in the chessboard, and it is identified as a number from 1 to 8.
  * <p>
@@ -58,7 +60,7 @@ public enum Rank {
     /**
      * Special value that represents no rank in particular.
      */
-    NONE("");
+    NONE(StringUtils.EMPTY);
 
     public static final Rank[] allRanks = values();
 

src/main/java/com/github/bhlangonijr/chesslib/game/Game.java

@@ -28,6 +28,7 @@
 import com.github.bhlangonijr.chesslib.move.MoveList;
 import com.github.bhlangonijr.chesslib.pgn.PgnException;
 import com.github.bhlangonijr.chesslib.util.StringUtil;
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * A chess game, as defined by the specifications of the Portable Game Notation (PGN) format.
@@ -81,7 +82,7 @@ private static String makeProp(String name, String value) {
     private static String getMovesAt(String moves, int index) {
         StringBuilder b = new StringBuilder();
         int count = 0;
-        for (String m : moves.split(" ")) {
+        for (String m : moves.split(StringUtils.SPACE)) {
             count++;
             if (count >= index) {
                 break;
@@ -305,7 +306,7 @@ public void setNag(Map<Integer, String> nag) {
      */
     public MoveList getHalfMoves() {
         if (halfMoves == null) {
-            if (getFen() != null && !getFen().trim().equals("")) {
+            if (StringUtils.isNotBlank(getFen())) {
                 halfMoves = new MoveList(getFen());
             } else {
                 halfMoves = new MoveList();
@@ -384,7 +385,7 @@ public String toPgn(boolean includeVariations, boolean includeComments) throws M
         sb.append(makeProp("Event", getRound().getEvent().getName()));
         sb.append(makeProp("Site", getRound().getEvent().getSite()));
         sb.append(makeProp("Date", getRound().getEvent().getStartDate()));
-        sb.append(makeProp("Round", getRound().getNumber() + ""));
+        sb.append(makeProp("Round", String.valueOf(getRound().getNumber())));
         sb.append(makeProp("White", getWhitePlayer().getName()));
         sb.append(makeProp("Black", getBlackPlayer().getName()));
         sb.append(makeProp("Result", getResult().getDescription()));
@@ -397,23 +398,23 @@ public String toPgn(boolean includeVariations, boolean includeComments) throws M
         } else {
             sb.append(makeProp("TimeControl", "-"));
         }
-        if (getAnnotator() != null && !getAnnotator().equals("")) {
+        if (StringUtils.isNotEmpty(getAnnotator())) {
             sb.append(makeProp("Annotator", getAnnotator()));
         }
-        if (getFen() != null && !getFen().equals("")) {
+        if (StringUtils.isNotEmpty(getFen())) {
             sb.append(makeProp("FEN", getFen()));
         }
-        if (getEco() != null && !getEco().equals("")) {
+        if (StringUtils.isNotEmpty(getEco())) {
             sb.append(makeProp("ECO", getEco()));
         }
-        if (getOpening() != null && !getOpening().equals("")) {
+        if (StringUtils.isNotEmpty(getOpening())) {
             sb.append(makeProp("Opening", getOpening()));
         }
         if (getWhitePlayer().getElo() > 0) {
-            sb.append(makeProp("WhiteElo", getWhitePlayer().getElo() + ""));
+            sb.append(makeProp("WhiteElo", String.valueOf(getWhitePlayer().getElo())));
         }
         if (getBlackPlayer().getElo() > 0) {
-            sb.append(makeProp("BlackElo", getBlackPlayer().getElo() + ""));
+            sb.append(makeProp("BlackElo", String.valueOf(getBlackPlayer().getElo())));
         }
         if (getProperty() != null) {
             for (Entry<String, String> entry : getProperty().entrySet()) {
@@ -749,7 +750,7 @@ public void loadMoveText(StringBuilder moveText) throws Exception {
 
         String text = moveText.toString();
 
-        if (getFen() != null && !getFen().trim().equals("")) {
+        if (StringUtils.isNotBlank(getFen())) {
             setHalfMoves(new MoveList(getFen()));
         } else {
             setHalfMoves(new MoveList());
@@ -766,8 +767,8 @@ public void loadMoveText(StringBuilder moveText) throws Exception {
         boolean onCommentBlock = false;
         boolean onVariationBlock = false;
         boolean onLineCommentBlock = false;
-        for (String token : text.split(" ")) {
-            if (token == null || token.trim().equals("")) {
+        for (String token : text.split(StringUtils.SPACE)) {
+            if (StringUtils.isBlank(token)) {
                 continue;
             }
             if (!(onLineCommentBlock || onCommentBlock) &&
@@ -868,15 +869,15 @@ public void loadMoveText(StringBuilder moveText) throws Exception {
             if (onCommentBlock || onLineCommentBlock) {
                 if (comment != null) {
                     comment.append(token);
-                    comment.append(" ");
+                    comment.append(StringUtils.SPACE);
                 }
                 continue;
             }
 
             if (onVariationBlock) {
                 if (variation != null) {
                     variation.getLast().text.append(token);
-                    variation.getLast().text.append(" ");
+                    variation.getLast().text.append(StringUtils.SPACE);
                     variation.getLast().size++;
                     variantIndex++;
                 }
@@ -885,7 +886,7 @@ public void loadMoveText(StringBuilder moveText) throws Exception {
             variantIndex++;
             halfMove++;
             moves.append(token);
-            moves.append(" ");
+            moves.append(StringUtils.SPACE);
         }
 
         StringUtil.replaceAll(moves, "\n", " ");

src/main/java/com/github/bhlangonijr/chesslib/move/Move.java

@@ -21,6 +21,7 @@
 import com.github.bhlangonijr.chesslib.Piece;
 import com.github.bhlangonijr.chesslib.Side;
 import com.github.bhlangonijr.chesslib.Square;
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * The definition of a chess move, that is, a piece movement from its starting square (the origin square) to a
@@ -143,7 +144,7 @@ public int hashCode() {
      */
     @Override
     public String toString() {
-        String promo = "";
+        String promo = StringUtils.EMPTY;
         if (!Piece.NONE.equals(promotion)) {
             promo = promotion.getFenSymbol();
         }

src/main/java/com/github/bhlangonijr/chesslib/move/MoveList.java

@@ -31,6 +31,7 @@
 import com.github.bhlangonijr.chesslib.Side;
 import com.github.bhlangonijr.chesslib.Square;
 import com.github.bhlangonijr.chesslib.util.StringUtil;
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * A convenient data structure to store an ordered sequence of moves and access to their human-readable representation
@@ -389,7 +390,7 @@ private String toStringWithoutMoveNumbers(String[] moveArray) throws MoveConvers
         StringBuilder sb = new StringBuilder();
         for (String move : moveArray) {
             sb.append(move);
-            sb.append(" ");
+            sb.append(StringUtils.SPACE);
         }
         return sb.toString();
     }
@@ -400,7 +401,7 @@ private String toStringWithMoveNumbers(String[] moveArray) throws MoveConversion
             if (halfMove % 2 == 0) {
                 sb.append((halfMove / 2) + 1).append(". ");
             }
-            sb.append(moveArray[halfMove]).append(" ");
+            sb.append(moveArray[halfMove]).append(StringUtils.SPACE);
         }
         return sb.toString();
     }
@@ -485,7 +486,7 @@ public synchronized void loadFromText(String text) throws MoveConversionExceptio
         try {
             Side side = b.getSideToMove();
             text = StringUtil.normalize(text);
-            String[] m = text.split(" ");
+            String[] m = text.split(StringUtils.SPACE);
             int i = 0;
             for (String strMove : m) {
                 Move move = new Move(strMove, side);
@@ -561,7 +562,7 @@ public void loadFromSan(String text) throws MoveConversionException {
         }
         try {
             text = StringUtil.normalize(text);
-            String[] m = text.split(" ");
+            String[] m = text.split(StringUtils.SPACE);
             for (String strMove : m) {
                 if (strMove.startsWith("$")) {
                     continue;
@@ -572,7 +573,7 @@ public void loadFromSan(String text) throws MoveConversionException {
                 if (strMove.contains(".")) {
                     strMove = StringUtil.afterSequence(strMove, ".");
                 }
-                if (strMove.trim().equals("")) {
+                if (StringUtils.isBlank(strMove)) {
                     continue;
                 }
                 addSanMove(strMove);
@@ -609,7 +610,7 @@ protected Move decodeSan(Board board, String san, Side side) throws MoveConversi
         //FIX missing equal sign for pawn promotions
         if (Character.isLetter(lastChar) && Character.toUpperCase(lastChar) != 'O') {
             san = san.substring(0, san.length() - 1);
-            strPromotion = lastChar + "";
+            strPromotion = String.valueOf(lastChar);
         }
 
         if (san.equals("O-O") || san.equals("O-O-O")) { // is castle
@@ -634,9 +635,8 @@ protected Move decodeSan(Board board, String san, Side side) throws MoveConversi
             throw new MoveConversionException("Couldn't parse destination square[" + san + "]: " +
                     san.toUpperCase());
         }
-        Piece promotion = strPromotion.equals("") ? Piece.NONE :
-                Piece.fromFenSymbol(side.equals(Side.WHITE) ?
-                        strPromotion.toUpperCase() : strPromotion.toLowerCase());
+        Piece promotion = StringUtils.isEmpty(strPromotion) ? Piece.NONE :
+                Piece.fromFenSymbol(side.equals(Side.WHITE) ? strPromotion.toUpperCase() : strPromotion.toLowerCase());
 
         if (san.length() == 2) { //is pawn move
             long mask = Bitboard.getBbtable(to) - 1L;
@@ -661,13 +661,13 @@ protected Move decodeSan(Board board, String san, Side side) throws MoveConversi
             PieceType fromPiece = PieceType.PAWN;
 
             if (Character.isUpperCase(strFrom.charAt(0))) {
-                fromPiece = PieceType.fromSanSymbol(strFrom.charAt(0) + "");
+                fromPiece = PieceType.fromSanSymbol(String.valueOf(strFrom.charAt(0)));
             }
 
             if (strFrom.length() == 3) {
                 from = Square.valueOf(strFrom.substring(1, 3).toUpperCase());
             } else {
-                String location = "";
+                String location = StringUtils.EMPTY;
                 if (strFrom.length() == 2) {
                     if (Character.isUpperCase(strFrom.charAt(0))) {
                         location = strFrom.substring(1, 2);
@@ -805,7 +805,7 @@ public String toString() {
         StringBuilder b = new StringBuilder();
         for (Move move : this) {
             b.append(move.toString());
-            b.append(" ");
+            b.append(StringUtils.SPACE);
         }
         return b.toString().trim();
     }
@@ -846,12 +846,12 @@ public boolean equals(Object obj) {
         return false;
     }
 
-    private String normalizeSan(String san) {
-        return san.replace("+", "")
-                .replace("#", "")
-                .replace("!", "")
-                .replace("?", "")
-                .replace("ep", "")
-                .replace("\n", " ");
+    private String normalizeSan(String san) { //TODO regex?
+        return san.replace("+", StringUtils.EMPTY)
+                .replace("#", StringUtils.EMPTY)
+                .replace("!", StringUtils.EMPTY)
+                .replace("?", StringUtils.EMPTY)
+                .replace("ep", StringUtils.EMPTY)
+                .replace("\n", StringUtils.SPACE);
     }
 }