Merge pull request #88 from CodesAway/dev-0.11.0

Dev 0.11.0

Author: CodesAway

BEXCodeCompare/pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>info.codesaway</groupId>
 	<artifactId>bex</artifactId>
-	<version>0.10.1</version>
+	<version>0.11.0</version>
 	<name>Be Enhanced Code Compare (BEϽC)</name>
 	<description>An enhanced code compare, utilities, and code matching</description>
 	<properties>

BEXCodeCompare/src/main/java/info/codesaway/bex/BEXListPair.java

@@ -1,6 +1,7 @@
 package info.codesaway.bex;
 
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Function;
 import java.util.function.Supplier;
 
@@ -152,4 +153,24 @@ public BEXPair<E> get(final IntPair index) {
 	public <R> BEXPair<R> map(final Function<List<E>, R> function) {
 		return new BEXPairValue<>(function.apply(this.getLeft()), function.apply(this.getRight()));
 	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(this.pair);
+	}
+
+	@Override
+	public boolean equals(final Object obj) {
+		if (this == obj) {
+			return true;
+		}
+		if (obj == null) {
+			return false;
+		}
+		if (this.getClass() != obj.getClass()) {
+			return false;
+		}
+		BEXListPair<?> other = (BEXListPair<?>) obj;
+		return Objects.equals(this.pair, other.pair);
+	}
 }

BEXCodeCompare/src/main/java/info/codesaway/bex/BEXMapPair.java

@@ -1,6 +1,7 @@
 package info.codesaway.bex;
 
 import java.util.Map;
+import java.util.Objects;
 import java.util.function.Supplier;
 
 /**
@@ -57,9 +58,10 @@ public Map<K, V> getRight() {
 	}
 
 	/**
-	 * Gets the map on the specified side
+	 * Gets the map on the specified side.
+	 *
 	 * @param side the side
-	 * @return
+	 * @return the map on the specified side
 	 */
 	@Override
 	public Map<K, V> get(final BEXSide side) {
@@ -76,4 +78,24 @@ public BEXPair<V> get(final K leftKey, final K rightKey) {
 
 		return new BEXPairValue<>(left, right);
 	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(this.pair);
+	}
+
+	@Override
+	public boolean equals(final Object obj) {
+		if (this == obj) {
+			return true;
+		}
+		if (obj == null) {
+			return false;
+		}
+		if (this.getClass() != obj.getClass()) {
+			return false;
+		}
+		BEXMapPair<?, ?> other = (BEXMapPair<?, ?>) obj;
+		return Objects.equals(this.pair, other.pair);
+	}
 }

BEXCodeCompare/src/main/java/info/codesaway/bex/BEXPair.java

@@ -99,7 +99,7 @@ public default IntBEXPair mapToInt(final ToIntFunction<T> function) {
 
 	/**
 	 * Applies the specified BiFunction, passing {@link #getLeft()} and {@link #getRight()} as arguments
-
+	
 	 * @param function the BiFunction to apply
 	 * @return the result of applying the BiFunction
 	 */
@@ -109,7 +109,7 @@ public default <R> R apply(final BiFunction<T, T, R> function) {
 
 	/**
 	 * Applies the specified ToIntBiFunction, passing {@link #getLeft()} and {@link #getRight()} as arguments
-
+	
 	 * @param function the ToIntBiFunction to apply
 	 * @return the result of applying the ToIntBiFunction
 	 */
@@ -119,7 +119,7 @@ public default int applyAsInt(final ToIntBiFunction<T, T> function) {
 
 	/**
 	 * Evaluates the specified BiPredicate, passing {@link #getLeft()} and {@link #getRight()} as arguments
-
+	
 	 * @param predicate the BiPredicate to apply
 	 * @return <code>true</code> if the predicate matches when applying the arugments; otherwise, <code>false</code>
 	 */

BEXCodeCompare/src/main/java/info/codesaway/bex/BEXPairValue.java

@@ -35,10 +35,11 @@ public BEXPairValue(final Supplier<T> supplier) {
 	}
 
 	/**
-	 * Creates a new BEXPair using the results of applying the specified function for both {@link BEXSide#LEFT} and {@link BEXSide#RIGHT}
-	 * @param <T>
+	 * Creates a new BEXPair using the results of applying the specified function for both {@link BEXSide#LEFT} and {@link BEXSide#RIGHT}.
+	 *
+	 * @param <T> the generic type
 	 * @param function the function to apply
-	 * @return
+	 * @return the BEXPairValue
 	 * @since 0.4
 	 */
 	// Changed from constructor to static method due to ambiguity between this and constructor accepting a Supplier

BEXCodeCompare/src/main/java/info/codesaway/bex/ImmutableIntRangeMap.java

@@ -3,6 +3,7 @@
 import static info.codesaway.bex.util.BEXUtilities.checkArgument;
 import static info.codesaway.bex.util.BEXUtilities.entry;
 
+import java.util.AbstractMap;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -31,7 +32,9 @@ public final class ImmutableIntRangeMap<V> {
 
 	private static final Comparator<IntRange> KEY_COMPARATOR = Comparator.comparingInt(IntRange::getStart);
 
-	/** Returns an empty immutable range map. */
+	/**
+	 * Returns an empty immutable range map.
+	 */
 	@SuppressWarnings("unchecked")
 	public static <V> ImmutableIntRangeMap<V> of() {
 		return (ImmutableIntRangeMap<V>) EMPTY;
@@ -42,7 +45,9 @@ private ImmutableIntRangeMap(final List<IntRange> ranges, final List<V> values)
 		this.values = values;
 	}
 
-	/** Returns a new builder for an immutable range map. */
+	/**
+	 * Returns a new builder for an immutable range map.
+	 */
 	public static <V> Builder<V> builder() {
 		return new Builder<>();
 	}
@@ -276,17 +281,12 @@ public Entry<IntRange, V> next() {
 		}
 	}
 
-	private final class MapOfRanges implements Map<IntRange, V> {
+	private final class MapOfRanges extends AbstractMap<IntRange, V> {
 		@Override
 		public int size() {
 			return ImmutableIntRangeMap.this.ranges.size();
 		}
 
-		@Override
-		public boolean isEmpty() {
-			return this.size() == 0;
-		}
-
 		@Override
 		public boolean containsKey(final Object key) {
 			return key instanceof IntRange && ImmutableIntRangeMap.this.getIndexForRange((IntRange) key) >= 0;

BEXCodeCompare/src/main/java/info/codesaway/bex/diff/AbstractDiffAlgorithm.java

@@ -10,6 +10,9 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
+/**
+ *
+ */
 public abstract class AbstractDiffAlgorithm implements DiffAlgorithm {
 	private final List<DiffLine> leftLines;
 	private final List<DiffLine> rightLines;
@@ -34,10 +37,19 @@ protected AbstractDiffAlgorithm(final List<DiffLine> leftLines, final List<DiffL
 		this.normalizationFunction = firstNonNull(normalizationFunction, DiffHelper.NO_NORMALIZATION_FUNCTION);
 	}
 
+	/**
+	 * Gets the left lines
+	 * @return the left lines
+	 */
 	public List<DiffLine> getLeftLines() {
 		return this.leftLines;
 	}
 
+	/**
+	 * Gets the right lines.
+	 *
+	 * @return the right lines
+	 */
 	public List<DiffLine> getRightLines() {
 		return this.rightLines;
 	}
@@ -52,8 +64,8 @@ public BiFunction<String, String, DiffNormalizedText> getNormalizationFunction()
 	/**
 	 * Gets the text from the specified line in {@link #getLeftLines()}
 	 *
-	 * @param index
-	 * @return
+	 * @param index the line number
+	 * @return the left text on the specified line number
 	 */
 	public String getLeftText(final int index) {
 		return this.getLeftLines().get(index).getText();
@@ -62,8 +74,8 @@ public String getLeftText(final int index) {
 	/**
 	 * Gets the text from the specified line in {@link #getRightLines()}
 	 *
-	 * @param index
-	 * @return
+	 * @param index the line number
+	 * @return the right text on the specified line
 	 */
 	public String getRightText(final int index) {
 		return this.getRightLines().get(index).getText();

BEXCodeCompare/src/main/java/info/codesaway/bex/diff/DiffEdit.java

@@ -80,20 +80,38 @@ public Stream<DiffEdit> stream() {
 	}
 
 	/**
-	 * Gets the first side which has data (left or right)
+	 * Gets the first side which has data (left or right).
+	 *
+	 * @return the first side
 	 */
 	public BEXSide getFirstSide() {
 		return this.hasLeftLine() ? LEFT : RIGHT;
 	}
 
+	/**
+	 * Gets the line.
+	 *
+	 * @param side the side
+	 * @return the optional line
+	 */
 	public Optional<DiffLine> getLine(final BEXSide side) {
 		return side == LEFT ? this.getLeftLine() : this.getRightLine();
 	}
 
+	/**
+	 * Gets the left line.
+	 *
+	 * @return the left line
+	 */
 	public Optional<DiffLine> getLeftLine() {
 		return this.leftLine;
 	}
 
+	/**
+	 * Gets the right line.
+	 *
+	 * @return the right line
+	 */
 	public Optional<DiffLine> getRightLine() {
 		return this.rightLine;
 	}
@@ -110,35 +128,54 @@ public boolean hasLine(final BEXSide side) {
 
 	/**
 	 * Indicates if has left line
+	 *
+	 * @return <code>true</code> if has left line
 	 */
 	public boolean hasLeftLine() {
 		return this.getLeftLine().isPresent();
 	}
 
 	/**
 	 * Indicates if has right line
+	 *
+	 * @return <code>true</code> if has right line
 	 */
 	public boolean hasRightLine() {
 		return this.getRightLine().isPresent();
 	}
 
+	/**
+	 * Gets the text.
+	 *
+	 * @return the text
+	 */
 	public String getText() {
 		return this.getText(this.getFirstSide());
 	}
 
+	/**
+	 * Gets the text.
+	 *
+	 * @param side the side
+	 * @return the text
+	 */
 	public String getText(final BEXSide side) {
 		return this.getLine(side).orElse(ABSENT_LINE).getText();
 	}
 
 	/**
-	 * Gets the text for the left line
+	 * Gets the text for the left line.
+	 *
+	 * @return the left text
 	 */
 	public String getLeftText() {
 		return this.getText(LEFT);
 	}
 
 	/**
-	 * Gets the text for the right line
+	 * Gets the text for the right line.
+	 *
+	 * @return the right text
 	 */
 	public String getRightText() {
 		return this.getText(RIGHT);
@@ -183,8 +220,9 @@ public int getRightLineNumber() {
 	}
 
 	/**
-	 * Gets the line number (as a String) for the specified side
+	 * Gets the line number (as a String) for the specified side.
 	 *
+	 * @param side the side
 	 * @return the line number (or the empty string if there is no line for the specified side)
 	 */
 	public String getLineNumberString(final BEXSide side) {

BEXCodeCompare/src/main/java/info/codesaway/bex/matching/BEXGroupMatchSetting.java

@@ -1,7 +1,6 @@
 package info.codesaway.bex.matching;
 
-import java.util.HashMap;
-import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 
 /**
  * BEX group match settings
@@ -10,7 +9,7 @@
  * Methods which turn on or off flags return a different settings object (from cache when possible) with the specified settings changed</p>
  */
 final class BEXGroupMatchSetting {
-	private static final Map<Integer, BEXGroupMatchSetting> CACHE = new HashMap<>();
+	private static final ConcurrentHashMap<Integer, BEXGroupMatchSetting> CACHE = new ConcurrentHashMap<>();
 
 	private final int flags;
 

BEXCodeCompare/src/main/java/info/codesaway/bex/matching/BEXMatchResult.java

@@ -89,7 +89,7 @@ public default int end(final String group) {
 
 	/**
 	 *
-	 * @param group
+	 * @param group the group
 	 * @return
 	 * @throws  IllegalStateException
 	 *          If no match has yet been attempted,