Merge pull request #85 from CodesAway/dev-0.10

Lots of changes for 0.10 release

Author: CodesAway

BEXCodeCompare/pom.xml

@@ -4,9 +4,9 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>info.codesaway</groupId>
 	<artifactId>bex</artifactId>
-	<version>0.9.1</version>
-	<name>BEX Code Compare</name>
-	<description>Be Enhanced Code Compare</description>
+	<version>0.10.0</version>
+	<name>Be Enhanced Code Compare (BEϽC)</name>
+	<description>An enhanced code compare, utilities, and code matching</description>
 	<properties>
 		<maven.compiler.source>1.8</maven.compiler.source>
 		<maven.compiler.target>1.8</maven.compiler.target>
@@ -49,7 +49,6 @@
 			<scope>test</scope>
 		</dependency>
 	</dependencies>
-
 	<build>
 		<plugins>
 			<plugin>
@@ -170,4 +169,4 @@
 			<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
 		</repository>
 	</distributionManagement>
-</project>
+</project>

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

@@ -18,10 +18,12 @@
  * Pair of left and right values, which are of the same type
  *
  * <p>Instances of this class are immutable if generic class type is also immutable</p>
+ *
+ * <p>Instances of this class are Comparable if generic class type is also Comparable</p>
  * @param <T> the type of pair
  * @since 0.3
  */
-public interface BEXPair<T> {
+public interface BEXPair<T> extends Comparable<BEXPair<T>> {
 	/**
 	 * Gets the left value in the pair
 	 * @return the left value
@@ -97,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
 	 */
@@ -107,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
 	 */
@@ -117,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>
 	 */
@@ -256,4 +258,25 @@ public default void acceptWithSide(final BiConsumer<T, BEXSide> consumer) {
 	public default String toString(final String format) {
 		return String.format(format, this.getLeft(), this.getRight());
 	}
+
+	/**
+	 * Compares the BEXPair first by the left element then the right element
+	 * @throws ClassCastException if the entries do not implement Comparable or are not mutually Comparable
+	 * @since 0.10
+	 */
+	@Override
+	public default int compareTo(final BEXPair<T> o) {
+		@SuppressWarnings("unchecked")
+		Comparable<? super T> left1 = (Comparable<? super T>) this.getLeft();
+
+		@SuppressWarnings("unchecked")
+		Comparable<? super T> right1 = (Comparable<? super T>) this.getRight();
+
+		int compare = left1.compareTo(o.getLeft());
+		if (compare != 0) {
+			return compare;
+		}
+
+		return right1.compareTo(o.getRight());
+	}
 }

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

@@ -9,6 +9,18 @@ private BEXPairs() {
 		throw new UnsupportedOperationException();
 	}
 
+	/**
+	 *
+	 * @param <T> the type
+	 * @param left the left value
+	 * @param right the right value
+	 * @return a BEXPair with the specified left / right values
+	 * @since 0.10
+	 */
+	public static <T> BEXPair<T> bexPair(final T left, final T right) {
+		return new BEXPairValue<>(left, right);
+	}
+
 	public static <K, V> BEXPair<V> mapGet(final BEXPair<? extends Map<K, V>> mapPair,
 			final BEXPair<K> keyPair) {
 		return mapPair.mapWithSide((m, side) -> m.get(keyPair.get(side)));

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

@@ -29,6 +29,11 @@ private IntBEXRange(final int start, final int end, final boolean hasInclusiveEn
 		if (end < start) {
 			throw new IllegalArgumentException(String.format("Invalid range start = %d, end = %d", start, end));
 		}
+
+		if (end == start && !hasInclusiveStart && !hasInclusiveEnd) {
+			// Mimics Guava's Range class and throws exception
+			throw new IllegalArgumentException(String.format("Invalid range (%d, %d)", start, end));
+		}
 	}
 
 	/**

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

@@ -38,6 +38,19 @@ public default boolean isEmpty() {
 				&& !(this.hasInclusiveStart() && this.hasInclusiveEnd());
 	}
 
+	/**
+	 *
+	 * @return the length of the range
+	 * @since 0.10
+	 */
+	public default int length() {
+		// Logic from canonical
+		int start = this.hasInclusiveStart() ? this.getStart() : this.getStart() + 1;
+		int end = this.hasInclusiveEnd() ? this.getEnd() + 1 : this.getEnd();
+
+		return end - start;
+	}
+
 	public default IntRange canonical() {
 		if (this.hasInclusiveStart() && !this.hasInclusiveEnd()) {
 			return this;

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

@@ -5,48 +5,107 @@
 import java.util.Map.Entry;
 import java.util.Set;
 
-import info.codesaway.bex.IntPair;
+import info.codesaway.bex.IntBEXRange;
 
 public interface BEXMatchResult {
 	public BEXPattern pattern();
 
 	public String text();
 
-	public IntPair startEndPair();
+	/**
+	 *
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
+	public IntBEXRange range();
 
+	/**
+	 *
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public default int start() {
-		return this.startEndPair().getLeft();
+		return this.range().getStart();
 	}
 
+	/**
+	 *
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public default int end() {
-		return this.startEndPair().getRight();
+		return this.range().getEnd();
 	}
 
+	/**
+	 *
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public default String group() {
-		return getSubstring(this.text(), this.startEndPair());
+		return getSubstring(this.text(), this.range());
 	}
 
-	public IntPair startEndPair(String group);
+	/**
+	 *
+	 * @param group
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
+	public IntBEXRange range(String group);
 
+	/**
+	 *
+	 * @param group
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public default int start(final String group) {
-		return this.startEndPair(group).getLeft();
+		return this.range(group).getStart();
 	}
 
+	/**
+	 *
+	 * @param group
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public default int end(final String group) {
-		return this.startEndPair(group).getRight();
+		return this.range(group).getEnd();
 	}
 
+	/**
+	 *
+	 * @param group
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public default String group(final String group) {
 		if (group.equals("*")) {
 			return this.group();
 		}
 
-		IntPair startEndPair = this.startEndPair(group);
-		if (startEndPair.getLeft() == -1 || startEndPair.getRight() == -1) {
+		IntBEXRange range = this.range(group);
+		if (range.getStart() == -1 || range.getEnd() == -1) {
 			return null;
 		}
 
-		return getSubstring(this.text(), startEndPair);
+		return getSubstring(this.text(), range);
 	}
 
 	/**
@@ -61,10 +120,20 @@ public default String group(final String group) {
 	 *
 	 * @throws IllegalArgumentException
 	 *             If the group is not specified in the pattern
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
 	 */
 	public default String get(final String group) {
 		return this.group(group);
 	}
 
+	/**
+	 *
+	 * @return
+	 * @throws  IllegalStateException
+	 *          If no match has yet been attempted,
+	 *          or if the previous match operation failed
+	 */
 	public Set<Entry<String, String>> entrySet();
 }