You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/05/24 12:54:59 UTC

[commons-text] branch master updated: - Remove trailing white spaces on all lines. - Use final. - Document empty blocks.

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git


The following commit(s) were added to refs/heads/master by this push:
     new d12e445  - Remove trailing white spaces on all lines. - Use final. - Document empty blocks.
d12e445 is described below

commit d12e445e21314a73ae7409b09d6414edb8d24b5a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri May 24 08:54:56 2019 -0400

    - Remove trailing white spaces on all lines.
    - Use final.
    - Document empty blocks.
---
 src/main/java/org/apache/commons/text/WordUtils.java   |  3 +--
 .../commons/text/lookup/StringLookupFactory.java       |  2 +-
 .../text/similarity/IntersectionSimilarity.java        | 18 +++++++++---------
 .../commons/text/similarity/JaroWinklerDistance.java   |  2 +-
 .../org/apache/commons/text/StrSubstitutorTest.java    |  2 +-
 .../commons/text/diff/StringsComparatorTest.java       |  7 +++++++
 .../commons/text/lookup/DefaultStringLookupTest.java   |  2 +-
 .../text/similarity/IntersectionSimilarityTest.java    | 16 ++++++++--------
 .../text/similarity/JaroWinklerSimilarityTest.java     |  6 +++---
 .../text/translate/CodePointTranslatorTest.java        | 17 +++++++++--------
 .../commons/text/translate/JavaUnicodeEscaperTest.java |  8 +++-----
 .../text/translate/SinglePassTranslatorTest.java       |  4 +++-
 12 files changed, 47 insertions(+), 40 deletions(-)

diff --git a/src/main/java/org/apache/commons/text/WordUtils.java b/src/main/java/org/apache/commons/text/WordUtils.java
index a9567a3..32f95c2 100644
--- a/src/main/java/org/apache/commons/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/text/WordUtils.java
@@ -313,9 +313,8 @@ public class WordUtils {
                     if (matcherSize != 0) {
                         offset += matcher.end();
                         continue;
-                    } else {
-                        offset += 1;
                     }
+                    offset += 1;
                 }
                 spaceToWrapAt = matcher.start() + offset;
             }
diff --git a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
index 256044c..a1c80c6 100644
--- a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
+++ b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
@@ -278,7 +278,7 @@ public final class StringLookupFactory {
         if (stringLookupMap != null) {
             // "base64" is deprecated in favor of KEY_BASE64_DECODER.
             stringLookupMap.put("base64", Base64DecoderStringLookup.INSTANCE);
-            for (DefaultStringLookup stringLookup : DefaultStringLookup.values()) {
+            for (final DefaultStringLookup stringLookup : DefaultStringLookup.values()) {
                 stringLookupMap.put(stringLookup.getKey(), stringLookup.getStringLookup());
             }
         }
diff --git a/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java b/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
index bbdd7b8..cd76065 100644
--- a/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
+++ b/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
@@ -66,7 +66,7 @@ public class IntersectionSimilarity<T> implements SimilarityScore<IntersectionRe
          *
          * @param initialCapacity the initial capacity
          */
-        TinyBag(int initialCapacity) {
+        TinyBag(final int initialCapacity) {
             map = new HashMap<>(initialCapacity);
         }
 
@@ -75,7 +75,7 @@ public class IntersectionSimilarity<T> implements SimilarityScore<IntersectionRe
          *
          * @param object the object to add
          */
-        void add(T object) {
+        void add(final T object) {
             final BagCount mut = map.get(object);
             if (mut == null) {
                 map.put(object, new BagCount());
@@ -128,7 +128,7 @@ public class IntersectionSimilarity<T> implements SimilarityScore<IntersectionRe
      * @param converter the converter used to create the elements from the characters
      * @throws IllegalArgumentException if the converter is null
      */
-    public IntersectionSimilarity(Function<CharSequence, Collection<T>> converter) {
+    public IntersectionSimilarity(final Function<CharSequence, Collection<T>> converter) {
         if (converter == null) {
             throw new IllegalArgumentException("Converter must not be null");
         }
@@ -189,9 +189,9 @@ public class IntersectionSimilarity<T> implements SimilarityScore<IntersectionRe
      * @param objects the objects
      * @return the bag
      */
-    private TinyBag toBag(Collection<T> objects) {
+    private TinyBag toBag(final Collection<T> objects) {
         final TinyBag bag = new TinyBag(objects.size());
-        for (T t : objects) {
+        for (final T t : objects) {
             bag.add(t);
         }
         return bag;
@@ -206,9 +206,9 @@ public class IntersectionSimilarity<T> implements SimilarityScore<IntersectionRe
      * @param setB the set B
      * @return the intersection
      */
-    private static <T> int getIntersection(Set<T> setA, Set<T> setB) {
+    private static <T> int getIntersection(final Set<T> setA, final Set<T> setB) {
         int intersection = 0;
-        for (T element : setA) {
+        for (final T element : setA) {
             if (setB.contains(element)) {
                 intersection++;
             }
@@ -224,9 +224,9 @@ public class IntersectionSimilarity<T> implements SimilarityScore<IntersectionRe
      * @param bagB the bag B
      * @return the intersection
      */
-    private int getIntersection(TinyBag bagA, TinyBag bagB) {
+    private int getIntersection(final TinyBag bagA, final TinyBag bagB) {
         int intersection = 0;
-        for (Entry<T, BagCount> entry : bagA.entrySet()) {
+        for (final Entry<T, BagCount> entry : bagA.entrySet()) {
             final T element = entry.getKey();
             final int count = entry.getValue().count;
             // The intersection of this entry in both bags is the minimum count
diff --git a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
index 388d0c7..a033f88 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
@@ -65,7 +65,7 @@ public class JaroWinklerDistance implements EditDistance<Double> {
      * @throws IllegalArgumentException if either CharSequence input is {@code null}
      */
     @Override
-    public Double apply(CharSequence left, CharSequence right) {
+    public Double apply(final CharSequence left, final CharSequence right) {
 
         if (left == null || right == null) {
             throw new IllegalArgumentException("CharSequences must not be null");
diff --git a/src/test/java/org/apache/commons/text/StrSubstitutorTest.java b/src/test/java/org/apache/commons/text/StrSubstitutorTest.java
index 760e6fc..cde37d0 100644
--- a/src/test/java/org/apache/commons/text/StrSubstitutorTest.java
+++ b/src/test/java/org/apache/commons/text/StrSubstitutorTest.java
@@ -268,7 +268,7 @@ public class StrSubstitutorTest {
         map.put("critterSpeed", "quick");
         map.put("critterColor", "brown");
         map.put("critterType", "${animal}");
-        StrSubstitutor sub = new StrSubstitutor(map);
+        final StrSubstitutor sub = new StrSubstitutor(map);
         assertThrows(IllegalStateException.class, () -> sub.replace("The ${animal} jumps over the ${target}."));
 
         // also check even when default value is set.
diff --git a/src/test/java/org/apache/commons/text/diff/StringsComparatorTest.java b/src/test/java/org/apache/commons/text/diff/StringsComparatorTest.java
index 9e9d266..50916d7 100644
--- a/src/test/java/org/apache/commons/text/diff/StringsComparatorTest.java
+++ b/src/test/java/org/apache/commons/text/diff/StringsComparatorTest.java
@@ -59,25 +59,32 @@ public class StringsComparatorTest {
     }
 
     private class ExecutionVisitor<T> implements CommandVisitor<T> {
+
         private final StringBuilder v;
+
         ExecutionVisitor() {
             v = new StringBuilder();
         }
+
         @Override
         public void visitInsertCommand(final T object) {
             v.append(object);
         }
+
         @Override
         public void visitKeepCommand(final T object) {
             v.append(object);
         }
+
         @Override
         public void visitDeleteCommand(final T object) {
+            // noop
         }
         public String getString() {
             return v.toString();
         }
     }
+
     @BeforeEach
     public void setUp() {
         before = Arrays.asList(
diff --git a/src/test/java/org/apache/commons/text/lookup/DefaultStringLookupTest.java b/src/test/java/org/apache/commons/text/lookup/DefaultStringLookupTest.java
index 3cc9711..2302dd3 100644
--- a/src/test/java/org/apache/commons/text/lookup/DefaultStringLookupTest.java
+++ b/src/test/java/org/apache/commons/text/lookup/DefaultStringLookupTest.java
@@ -33,7 +33,7 @@ public class DefaultStringLookupTest {
         final Map<String, StringLookup> stringLookupMap = new HashMap<>();
         StringLookupFactory.INSTANCE.addDefaultStringLookups(stringLookupMap);
         // Loop through all enums
-        for (DefaultStringLookup stringLookup : DefaultStringLookup.values()) {
+        for (final DefaultStringLookup stringLookup : DefaultStringLookup.values()) {
             assertSame(stringLookupMap.get(stringLookup.getKey()), stringLookupMap.get(stringLookup.getKey()));
         }
     }
diff --git a/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java b/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
index 2af8c8e..0f891db 100644
--- a/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
+++ b/src/test/java/org/apache/commons/text/similarity/IntersectionSimilarityTest.java
@@ -163,7 +163,7 @@ public class IntersectionSimilarityTest {
      * @param sequence the sequence
      * @return the set
      */
-    private static Set<Character> toCharacterSet(CharSequence sequence) {
+    private static Set<Character> toCharacterSet(final CharSequence sequence) {
         final int length = sequence.length();
         final Set<Character> set = new HashSet<>(length);
         for (int i = 0; i < length; i++) {
@@ -178,7 +178,7 @@ public class IntersectionSimilarityTest {
      * @param sequence the sequence
      * @return the list
      */
-    private static List<Character> toCharacterList(CharSequence sequence) {
+    private static List<Character> toCharacterList(final CharSequence sequence) {
         final int length = sequence.length();
         final List<Character> list = new ArrayList<>(length);
         for (int i = 0; i < length; i++) {
@@ -194,7 +194,7 @@ public class IntersectionSimilarityTest {
      * @param sequence the sequence
      * @return the set
      */
-    private static Set<Integer> toBigramSet(CharSequence sequence) {
+    private static Set<Integer> toBigramSet(final CharSequence sequence) {
         final int length = sequence.length();
         final Set<Integer> set = new HashSet<>(length);
         if (length > 1) {
@@ -215,7 +215,7 @@ public class IntersectionSimilarityTest {
      * @param sequence the sequence
      * @return the list
      */
-    private static List<Integer> toBigramList(CharSequence sequence) {
+    private static List<Integer> toBigramList(final CharSequence sequence) {
         final int length = sequence.length();
         final List<Integer> list = new ArrayList<>(length);
         if (length > 1) {
@@ -229,8 +229,8 @@ public class IntersectionSimilarityTest {
         return list;
     }
 
-    private static <T> void assertIntersection(IntersectionSimilarity<T> similarity, CharSequence cs1, CharSequence cs2,
-            int sizeA, int sizeB, int intersection) {
+    private static <T> void assertIntersection(final IntersectionSimilarity<T> similarity, final CharSequence cs1, final CharSequence cs2,
+            final int sizeA, final int sizeB, final int intersection) {
         final IntersectionResult result = similarity.apply(cs1, cs2);
         assertEquals(sizeA, result.getSizeA(), "Size A error");
         assertEquals(sizeB, result.getSizeB(), "Size B error");
@@ -251,7 +251,7 @@ public class IntersectionSimilarityTest {
         // This can be done using a 32-bit int to store two 16-bit characters
         final Function<CharSequence, Collection<Integer>> converter = cs -> {
             final List<Integer> set = new ArrayList<>();
-            for (String word : pattern.split(cs)) {
+            for (final String word : pattern.split(cs)) {
                 if (word.length() > 1) {
                     // The strings are converted to upper case
                     char ch2 = Character.toUpperCase(word.charAt(0));
@@ -304,7 +304,7 @@ public class IntersectionSimilarityTest {
         assertEquals(12, toF1ScorePercent(similarity.apply(bookTitle, search3)));
     }
 
-    private static int toF1ScorePercent(IntersectionResult result) {
+    private static int toF1ScorePercent(final IntersectionResult result) {
         final double value = 2.0 * result.getIntersection() / (result.getSizeA() + result.getSizeB());
         // Convert to percentage
         return (int) Math.round(value * 100);
diff --git a/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java b/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
index 842f632..e2c77d4 100644
--- a/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
+++ b/src/test/java/org/apache/commons/text/similarity/JaroWinklerSimilarityTest.java
@@ -63,18 +63,18 @@ public class JaroWinklerSimilarityTest {
      * @param string the string
      * @return the char sequence
      */
-    private static CharSequence wrap(String string) {
+    private static CharSequence wrap(final String string) {
         return new CharSequence() {
             @Override
             public int length() {
                 return string.length();
             }
             @Override
-            public char charAt(int index) {
+            public char charAt(final int index) {
                 return string.charAt(index);
             }
             @Override
-            public CharSequence subSequence(int start, int end) {
+            public CharSequence subSequence(final int start, final int end) {
                 return string.subSequence(start, end);
             }
         };
diff --git a/src/test/java/org/apache/commons/text/translate/CodePointTranslatorTest.java b/src/test/java/org/apache/commons/text/translate/CodePointTranslatorTest.java
index 3adbc8e..8b6966a 100644
--- a/src/test/java/org/apache/commons/text/translate/CodePointTranslatorTest.java
+++ b/src/test/java/org/apache/commons/text/translate/CodePointTranslatorTest.java
@@ -27,14 +27,15 @@ import static org.assertj.core.api.Assertions.assertThat;
 public class CodePointTranslatorTest {
 
   @Test
-  public void testAboveReturningNonNull() throws IOException {
-    final NumericEntityEscaper numericEntityEscaper = NumericEntityEscaper.above(0);
-    final UnicodeEscaper unicodeEscaper = new UnicodeEscaper();
-    final String string = unicodeEscaper.toUtf16Escape(0);
-    final PipedReader pipedReader = new PipedReader();
-    final PipedWriter pipedWriter = new PipedWriter(pipedReader);
+    public void testAboveReturningNonNull() throws IOException {
+        final NumericEntityEscaper numericEntityEscaper = NumericEntityEscaper.above(0);
+        final UnicodeEscaper unicodeEscaper = new UnicodeEscaper();
+        final String string = unicodeEscaper.toUtf16Escape(0);
+        try (final PipedReader pipedReader = new PipedReader();
+            final PipedWriter pipedWriter = new PipedWriter(pipedReader)) {
 
-    assertThat(numericEntityEscaper.translate(string, 0, pipedWriter)).isEqualTo(1);
-  }
+            assertThat(numericEntityEscaper.translate(string, 0, pipedWriter)).isEqualTo(1);
+        }
+    }
 
 }
diff --git a/src/test/java/org/apache/commons/text/translate/JavaUnicodeEscaperTest.java b/src/test/java/org/apache/commons/text/translate/JavaUnicodeEscaperTest.java
index 6f547a3..dfa28a4 100644
--- a/src/test/java/org/apache/commons/text/translate/JavaUnicodeEscaperTest.java
+++ b/src/test/java/org/apache/commons/text/translate/JavaUnicodeEscaperTest.java
@@ -16,12 +16,10 @@
  */
 package org.apache.commons.text.translate;
 
-import org.junit.jupiter.api.Test;
-
-import java.io.UnsupportedEncodingException;
-
 import static org.assertj.core.api.Assertions.assertThat;
 
+import org.junit.jupiter.api.Test;
+
 /**
  * Unit tests for {@link JavaUnicodeEscaper}.
  */
@@ -58,7 +56,7 @@ public class JavaUnicodeEscaperTest {
     }
 
     @Test
-    public void testToUtf16Escape() throws UnsupportedEncodingException {
+    public void testToUtf16Escape() {
         final JavaUnicodeEscaper jue = JavaUnicodeEscaper.below('F');
         // According to https://en.wikipedia.org/wiki/UTF-16#Code_points_U.2B10000..U.2B10FFFF,
         // Character ?, U+24B62, Binary Code Point 0010 0100 1011 0110 0010,
diff --git a/src/test/java/org/apache/commons/text/translate/SinglePassTranslatorTest.java b/src/test/java/org/apache/commons/text/translate/SinglePassTranslatorTest.java
index 82b0ce2..2f700c4 100644
--- a/src/test/java/org/apache/commons/text/translate/SinglePassTranslatorTest.java
+++ b/src/test/java/org/apache/commons/text/translate/SinglePassTranslatorTest.java
@@ -32,8 +32,10 @@ import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException
 public class SinglePassTranslatorTest {
 
     private final SinglePassTranslator dummyTranslator = new SinglePassTranslator() {
+
         @Override
         void translateWhole(final CharSequence input, final Writer out) throws IOException {
+            // noop
         }
     };
 
@@ -57,7 +59,7 @@ public class SinglePassTranslatorTest {
     }
 
     @Test
-    public void testTranslateThrowsIllegalArgumentException() throws IOException {
+    public void testTranslateThrowsIllegalArgumentException() {
         assertThatIllegalArgumentException().isThrownBy(() -> dummyTranslator.translate("(,Fk", 647, null));
     }