Merge pull request #17 from kinow/minor-improvements

kinow · web-flow · commit a94813fb0ce4 · 2019-02-17T21:05:51.000+13:00
Minor improvements
diff --git a/src/main/java/org/apache/commons/codec/Resources.java b/src/main/java/org/apache/commons/codec/Resources.java
@@ -21,14 +21,14 @@
 
 /**
  * Consider this class package private. Helps load resources.
- * 
+ *
  * @since 1.12
  */
 public class Resources {
 
     /**
      * Opens the given named resource from the given class.
-     * 
+     *
      * @param name The resource name.
      * @return An input stream.
      */
diff --git a/src/main/java/org/apache/commons/codec/digest/B64.java b/src/main/java/org/apache/commons/codec/digest/B64.java
@@ -16,7 +16,6 @@
  */
 package org.apache.commons.codec.digest;
 
-import java.security.NoSuchAlgorithmException;
 import java.security.SecureRandom;
 import java.util.Random;
 
diff --git a/src/main/java/org/apache/commons/codec/digest/Crypt.java b/src/main/java/org/apache/commons/codec/digest/Crypt.java
@@ -63,8 +63,9 @@ public static String crypt(final byte[] keyBytes) {
      * @param keyBytes
      *            plaintext password
      * @param salt
-     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated for
-     *            you using {@link ThreadLocalRandom}; for more secure salts consider using {@link SecureRandom} to
+     *            real salt value without prefix or "rounds=". The salt may be null,
+     *            in which case a salt is generated for you using {@link ThreadLocalRandom};
+     *            for more secure salts consider using {@link SecureRandom} to
      *            generate your own salts.
      * @return hash value
      * @throws IllegalArgumentException
@@ -155,9 +156,9 @@ public static String crypt(final String key) {
      * @param key
      *            plaintext password as entered by the used
      * @param salt
-     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated for
-     *            you using {@link ThreadLocalRandom}; for more secure salts consider using {@link SecureRandom} to
-     *            generate your own salts.
+     *            real salt value without prefix or "rounds=". The salt may be null, in which case a
+     *            salt is generated for you using {@link ThreadLocalRandom}; for more secure salts
+     *            consider using {@link SecureRandom} to generate your own salts.
      * @return hash value, i.e. encrypted password including the salt string
      * @throws IllegalArgumentException
      *             if the salt does not match the allowed pattern
diff --git a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
@@ -221,7 +221,8 @@ public static MessageDigest getSha256Digest() {
      *
      * @return An SHA3-224 digest instance.
      * @throws IllegalArgumentException
-     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on Oracle Java 9 and greater.
+     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on
+     *             Oracle Java 9 andgreater.
      * @see MessageDigestAlgorithms#SHA3_224
      * @since 1.12
      */
@@ -234,7 +235,8 @@ public static MessageDigest getSha3_224Digest() {
      *
      * @return An SHA3-256 digest instance.
      * @throws IllegalArgumentException
-     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on Oracle Java 9 and greater.
+     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on
+     *             Oracle Java 9 and greater.
      * @see MessageDigestAlgorithms#SHA3_256
      * @since 1.12
      */
@@ -247,7 +249,8 @@ public static MessageDigest getSha3_256Digest() {
      *
      * @return An SHA3-384 digest instance.
      * @throws IllegalArgumentException
-     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on Oracle Java 9 and greater.
+     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on
+     *             Oracle Java 9 and greater.
      * @see MessageDigestAlgorithms#SHA3_384
      * @since 1.12
      */
@@ -260,7 +263,8 @@ public static MessageDigest getSha3_384Digest() {
      *
      * @return An SHA3-512 digest instance.
      * @throws IllegalArgumentException
-     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen on Oracle Java 9 and greater.
+     *             when a {@link NoSuchAlgorithmException} is caught, which should not happen
+     *             on Oracle Java 9 and greater.
      * @see MessageDigestAlgorithms#SHA3_512
      * @since 1.12
      */
@@ -273,8 +277,8 @@ public static MessageDigest getSha3_512Digest() {
      *
      * @return An SHA-384 digest instance.
      * @throws IllegalArgumentException
-     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-384 is a
-     *             built-in algorithm
+     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen
+     *             because SHA-384 is a built-in algorithm
      * @see MessageDigestAlgorithms#SHA_384
      */
     public static MessageDigest getSha384Digest() {
@@ -286,8 +290,8 @@ public static MessageDigest getSha384Digest() {
      *
      * @return An SHA-512 digest instance.
      * @throws IllegalArgumentException
-     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen because SHA-512 is a
-     *             built-in algorithm
+     *             when a {@link NoSuchAlgorithmException} is caught, which should never happen
+     *             because SHA-512 is a built-in algorithm
      * @see MessageDigestAlgorithms#SHA_512
      */
     public static MessageDigest getSha512Digest() {
diff --git a/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java b/src/main/java/org/apache/commons/codec/digest/Md5Crypt.java
@@ -238,9 +238,9 @@ public static String md5Crypt(final byte[] keyBytes, final String salt) {
      * @param keyBytes
      *            plaintext string to hash.
      * @param salt
-     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated for
-     *            you using {@link ThreadLocalRandom}; for more secure salts consider using {@link SecureRandom} to
-     *            generate your own salts.
+     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
+     *            is generated for you using {@link ThreadLocalRandom}; for more secure salts consider
+     *            using {@link SecureRandom} to generate your own salts.
      * @param prefix
      *            salt prefix
      * @return the hash value
@@ -262,9 +262,9 @@ public static String md5Crypt(final byte[] keyBytes, final String salt, final St
      * @param keyBytes
      *            plaintext string to hash.
      * @param salt
-     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated for
-     *            you using {@link ThreadLocalRandom}; for more secure salts consider using {@link SecureRandom} to
-     *            generate your own salts.
+     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
+     *            is generated for you using {@link ThreadLocalRandom}; for more secure salts consider
+     *            using {@link SecureRandom} to generate your own salts.
      * @param prefix
      *            salt prefix
      * @param random
diff --git a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
@@ -99,9 +99,9 @@ public static String sha256Crypt(final byte[] keyBytes) {
      * @param keyBytes
      *            plaintext to hash
      * @param salt
-     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated for
-     *            you using {@link SecureRandom}. If one does not want to use {@link SecureRandom}, you can pass your
-     *            own {@link Random} in {@link #sha256Crypt(byte[], String, Random)}.
+     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
+     *            is generated for you using {@link SecureRandom}. If one does not want to use {@link SecureRandom},
+     *            you can pass your own {@link Random} in {@link #sha256Crypt(byte[], String, Random)}.
      * @return complete hash value including salt
      * @throws IllegalArgumentException
      *             if the salt does not match the allowed pattern
@@ -597,9 +597,9 @@ public static String sha512Crypt(final byte[] keyBytes, String salt) {
      * @param keyBytes
      *            plaintext to hash
      * @param salt
-     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt is generated for
-     *            you using {@link ThreadLocalRandom}; for more secure salts consider using {@link SecureRandom} to
-     *            generate your own salts.
+     *            real salt value without prefix or "rounds=". The salt may be null, in which case a salt
+     *            is generated for you using {@link ThreadLocalRandom}; for more secure salts consider using
+     *            {@link SecureRandom} to generate your own salts.
      * @param random
      *            the instance of {@link Random} to use for generating the salt. Consider using {@link SecureRandom}
      *            or {@link ThreadLocalRandom}.
diff --git a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
@@ -383,7 +383,8 @@ public String colognePhonetic(String text) {
                 code = chr; // should not happen?
             }
 
-            if (code != CHAR_IGNORE && (lastCode != code && (code != '0' || lastCode == CHAR_FIRST_POS) || code < '0' || code > '8')) {
+            if (code != CHAR_IGNORE &&
+                    (lastCode != code && (code != '0' || lastCode == CHAR_FIRST_POS) || code < '0' || code > '8')) {
                 output.addRight(code);
             }
 
diff --git a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
@@ -501,7 +501,7 @@ private String[] soundex(final String source, final boolean branching) {
             }
 
             // use an EMPTY_LIST to avoid false positive warnings wrt potential null pointer access
-            final List<Branch> nextBranches = branching ? new ArrayList<>() : Collections.EMPTY_LIST;
+            final List<Branch> nextBranches = branching ? new ArrayList<Branch>() : Collections.<Branch>emptyList();
 
             for (final Rule rule : rules) {
                 if (rule.matches(inputContext)) {
diff --git a/src/main/java/org/apache/commons/codec/net/PercentCodec.java b/src/main/java/org/apache/commons/codec/net/PercentCodec.java
@@ -42,7 +42,7 @@ public class PercentCodec implements BinaryEncoder, BinaryDecoder {
      * The escape character used by the Percent-Encoding in order to introduce an encoded character.
      */
 
-    private final byte ESCAPE_CHAR = '%';
+    private static final byte ESCAPE_CHAR = '%';
 
     /**
      * The bit set used to store the character that should be always encoded
diff --git a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
@@ -463,7 +463,8 @@ public String decode(final String sourceStr, final Charset sourceCharset) throws
      * @throws UnsupportedEncodingException
      *             Thrown if Charset is not supported
      */
-    public String decode(final String sourceStr, final String sourceCharset) throws DecoderException, UnsupportedEncodingException {
+    public String decode(final String sourceStr, final String sourceCharset)
+            throws DecoderException, UnsupportedEncodingException {
         if (sourceStr == null) {
             return null;
         }
diff --git a/src/test/java/org/apache/commons/codec/StringEncoderAbstractTest.java b/src/test/java/org/apache/commons/codec/StringEncoderAbstractTest.java
@@ -74,7 +74,7 @@ public void testEncodeWithInvalidObject() throws Exception {
         boolean exceptionThrown = false;
         try {
             final StringEncoder encoder = this.getStringEncoder();
-            encoder.encode(new Float(3.4));
+            encoder.encode(Float.valueOf(3.4f));
         } catch (final Exception e) {
             exceptionThrown = true;
         }
diff --git a/src/test/java/org/apache/commons/codec/StringEncoderComparatorTest.java b/src/test/java/org/apache/commons/codec/StringEncoderComparatorTest.java
@@ -69,7 +69,7 @@ public void testComparatorWithDoubleMetaphoneAndInvalidInput() throws Exception
         final StringEncoderComparator sCompare =
             new StringEncoderComparator( new DoubleMetaphone() );
 
-        final int compare = sCompare.compare(new Double(3.0), Long.valueOf(3));
+        final int compare = sCompare.compare(Double.valueOf(3.0d), Long.valueOf(3));
         assertEquals( "Trying to compare objects that make no sense to the underlying encoder should return a zero compare code",
                                 0, compare);
     }
diff --git a/src/test/java/org/apache/commons/codec/net/BCodecTest.java b/src/test/java/org/apache/commons/codec/net/BCodecTest.java
@@ -117,7 +117,7 @@ public void testEncodeObjects() throws Exception {
         assertEquals("Encoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             bcodec.encode(dObj);
             fail("Trying to url encode a Double object should cause an exception.");
         } catch (final EncoderException ee) {
@@ -141,7 +141,7 @@ public void testDecodeObjects() throws Exception {
         assertEquals("Decoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             bcodec.decode(dObj);
             fail("Trying to url encode a Double object should cause an exception.");
         } catch (final DecoderException ee) {
diff --git a/src/test/java/org/apache/commons/codec/net/QCodecTest.java b/src/test/java/org/apache/commons/codec/net/QCodecTest.java
@@ -143,7 +143,7 @@ public void testEncodeObjects() throws Exception {
         assertEquals( "Encoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             qcodec.encode( dObj );
             fail( "Trying to url encode a Double object should cause an exception.");
         } catch (final EncoderException ee) {
@@ -169,7 +169,7 @@ public void testDecodeObjects() throws Exception {
         assertEquals( "Decoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             qcodec.decode( dObj );
             fail( "Trying to url encode a Double object should cause an exception.");
         } catch (final DecoderException ee) {
diff --git a/src/test/java/org/apache/commons/codec/net/QuotedPrintableCodecTest.java b/src/test/java/org/apache/commons/codec/net/QuotedPrintableCodecTest.java
@@ -201,7 +201,7 @@ public void testEncodeObjects() throws Exception {
         assertEquals( "Encoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             qpcodec.encode( dObj );
             fail( "Trying to url encode a Double object should cause an exception.");
         } catch (final EncoderException ee) {
@@ -232,7 +232,7 @@ public void testDecodeObjects() throws Exception {
         assertEquals( "Decoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             qpcodec.decode( dObj );
             fail( "Trying to url encode a Double object should cause an exception.");
         } catch (final DecoderException ee) {
diff --git a/src/test/java/org/apache/commons/codec/net/URLCodecTest.java b/src/test/java/org/apache/commons/codec/net/URLCodecTest.java
@@ -237,7 +237,7 @@ public void testEncodeObjects() throws Exception {
         assertEquals( "Encoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             urlCodec.encode( dObj );
             fail( "Trying to url encode a Double object should cause an exception.");
         } catch (final EncoderException ee) {
@@ -283,7 +283,7 @@ public void testDecodeObjects() throws Exception {
         assertEquals( "Decoding a null Object should return null", null, result);
 
         try {
-            final Object dObj = new Double(3.0);
+            final Object dObj = Double.valueOf(3.0d);
             urlCodec.decode( dObj );
             fail( "Trying to url encode a Double object should cause an exception.");
         } catch (final DecoderException ee) {

Original file line number	Diff line number	Diff line change
`@@ -383,7 +383,8 @@ public String colognePhonetic(String text) {`
`383`	`383`	`code = chr; // should not happen?`
`384`	`384`	`}`
`385`	`385`
`386`		`- if (code != CHAR_IGNORE && (lastCode != code && (code != '0' \|\| lastCode == CHAR_FIRST_POS) \|\| code < '0' \|\| code > '8')) {`
	`386`	`+ if (code != CHAR_IGNORE &&`
	`387`	`+ (lastCode != code && (code != '0' \|\| lastCode == CHAR_FIRST_POS) \|\| code < '0' \|\| code > '8')) {`
`387`	`388`	`output.addRight(code);`
`388`	`389`	`}`
`389`	`390`
Original file line number	Diff line number	Diff line change
`@@ -501,7 +501,7 @@ private String[] soundex(final String source, final boolean branching) {`
`501`	`501`	`}`
`502`	`502`
`503`	`503`	`// use an EMPTY_LIST to avoid false positive warnings wrt potential null pointer access`
`504`		`- final List<Branch> nextBranches = branching ? new ArrayList<>() : Collections.EMPTY_LIST;`
	`504`	`+ final List<Branch> nextBranches = branching ? new ArrayList<Branch>() : Collections.<Branch>emptyList();`
`505`	`505`
`506`	`506`	`for (final Rule rule : rules) {`
`507`	`507`	`if (rule.matches(inputContext)) {`