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 2022/08/31 14:33:53 UTC
[commons-codec] 02/02: Fix PMD issues and Javadoc
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-codec.git
commit 4fd068a2250664d02eac1e49355d5f7a365136e4
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Wed Aug 31 10:33:45 2022 -0400
Fix PMD issues and Javadoc
- Avoid unnecessary constructors - the compiler will generate these for
you
- Use conventional internal names
- No final in abstract method
- Use underscores for some literal numbers
- Avoid short names, "in" -> "inputStream"
---
pom.xml | 2 +-
.../commons/codec/binary/Base16InputStream.java | 24 ++++++-------
.../commons/codec/binary/Base16OutputStream.java | 26 +++++++-------
.../org/apache/commons/codec/binary/Base32.java | 2 +-
.../commons/codec/binary/Base32InputStream.java | 27 +++++++--------
.../commons/codec/binary/Base32OutputStream.java | 27 +++++++--------
.../org/apache/commons/codec/binary/Base64.java | 8 ++---
.../commons/codec/binary/Base64InputStream.java | 27 +++++++--------
.../commons/codec/binary/Base64OutputStream.java | 27 +++++++--------
.../apache/commons/codec/binary/BaseNCodec.java | 3 --
.../codec/binary/BaseNCodecInputStream.java | 6 ++--
.../codec/binary/BaseNCodecOutputStream.java | 6 ++--
.../apache/commons/codec/binary/BinaryCodec.java | 16 ++++-----
.../apache/commons/codec/digest/PureJavaCrc32.java | 6 ++--
.../commons/codec/digest/PureJavaCrc32C.java | 40 +++++++++++-----------
.../org/apache/commons/codec/digest/Sha2Crypt.java | 2 +-
.../commons/codec/language/AbstractCaverphone.java | 6 ----
.../apache/commons/codec/language/Caverphone.java | 6 ----
.../commons/codec/language/ColognePhonetic.java | 2 +-
.../commons/codec/language/DoubleMetaphone.java | 6 ----
.../codec/language/MatchRatingApproachEncoder.java | 2 +-
.../apache/commons/codec/language/Metaphone.java | 6 ----
.../org/apache/commons/codec/language/bm/Lang.java | 6 ++--
23 files changed, 125 insertions(+), 158 deletions(-)
diff --git a/pom.xml b/pom.xml
index 175651c6..aabd6082 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,7 +24,7 @@ limitations under the License.
<parent>
<groupId>org.apache.commons</groupId>
<artifactId>commons-parent</artifactId>
- <version>54-SNAPSHOT</version>
+ <version>53</version>
</parent>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java b/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
index 9bd5066c..bfa0c0a2 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
@@ -35,47 +35,47 @@ public class Base16InputStream extends BaseNCodecInputStream {
/**
* Creates a Base16InputStream such that all data read is Base16-decoded from the original provided InputStream.
*
- * @param in InputStream to wrap.
+ * @param inputStream InputStream to wrap.
*/
- public Base16InputStream(final InputStream in) {
- this(in, false);
+ public Base16InputStream(final InputStream inputStream) {
+ this(inputStream, false);
}
/**
* Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
* provided InputStream.
*
- * @param in InputStream to wrap.
+ * @param inputStream InputStream to wrap.
* @param doEncode true if we should encode all data read from us, false if we should decode.
*/
- public Base16InputStream(final InputStream in, final boolean doEncode) {
- this(in, doEncode, false);
+ public Base16InputStream(final InputStream inputStream, final boolean doEncode) {
+ this(inputStream, doEncode, false);
}
/**
* Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
* provided InputStream.
*
- * @param in InputStream to wrap.
+ * @param inputStream InputStream to wrap.
* @param doEncode true if we should encode all data read from us, false if we should decode.
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
*/
- public Base16InputStream(final InputStream in, final boolean doEncode,
+ public Base16InputStream(final InputStream inputStream, final boolean doEncode,
final boolean lowerCase) {
- this(in, doEncode, lowerCase, CodecPolicy.LENIENT);
+ this(inputStream, doEncode, lowerCase, CodecPolicy.LENIENT);
}
/**
* Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
* provided InputStream.
*
- * @param in InputStream to wrap.
+ * @param inputStream InputStream to wrap.
* @param doEncode true if we should encode all data read from us, false if we should decode.
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
* @param decodingPolicy Decoding policy.
*/
- public Base16InputStream(final InputStream in, final boolean doEncode,
+ public Base16InputStream(final InputStream inputStream, final boolean doEncode,
final boolean lowerCase, final CodecPolicy decodingPolicy) {
- super(in, new Base16(lowerCase, decodingPolicy), doEncode);
+ super(inputStream, new Base16(lowerCase, decodingPolicy), doEncode);
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
index 9a52ab81..06133dc9 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
@@ -35,47 +35,45 @@ public class Base16OutputStream extends BaseNCodecOutputStream {
/**
* Creates a Base16OutputStream such that all data written is Hex-encoded to the original provided OutputStream.
*
- * @param out OutputStream to wrap.
+ * @param outputStream OutputStream to wrap.
*/
- public Base16OutputStream(final OutputStream out) {
- this(out, true);
+ public Base16OutputStream(final OutputStream outputStream) {
+ this(outputStream, true);
}
/**
* Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
* original provided OutputStream.
*
- * @param out OutputStream to wrap.
+ * @param outputStream OutputStream to wrap.
* @param doEncode true if we should encode all data written to us, false if we should decode.
*/
- public Base16OutputStream(final OutputStream out, final boolean doEncode) {
- this(out, doEncode, false);
+ public Base16OutputStream(final OutputStream outputStream, final boolean doEncode) {
+ this(outputStream, doEncode, false);
}
/**
* Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
* original provided OutputStream.
*
- * @param out OutputStream to wrap.
+ * @param outputStream OutputStream to wrap.
* @param doEncode true if we should encode all data written to us, false if we should decode.
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
*/
- public Base16OutputStream(final OutputStream out, final boolean doEncode,
- final boolean lowerCase) {
- this(out, doEncode, lowerCase, CodecPolicy.LENIENT);
+ public Base16OutputStream(final OutputStream outputStream, final boolean doEncode, final boolean lowerCase) {
+ this(outputStream, doEncode, lowerCase, CodecPolicy.LENIENT);
}
/**
* Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
* original provided OutputStream.
*
- * @param out OutputStream to wrap.
+ * @param outputStream OutputStream to wrap.
* @param doEncode true if we should encode all data written to us, false if we should decode.
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
* @param decodingPolicy Decoding policy.
*/
- public Base16OutputStream(final OutputStream out, final boolean doEncode,
- final boolean lowerCase, final CodecPolicy decodingPolicy) {
- super(out, new Base16(lowerCase, decodingPolicy), doEncode);
+ public Base16OutputStream(final OutputStream outputStream, final boolean doEncode, final boolean lowerCase, final CodecPolicy decodingPolicy) {
+ super(outputStream, new Base16(lowerCase, decodingPolicy), doEncode);
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32.java b/src/main/java/org/apache/commons/codec/binary/Base32.java
index 79c8b190..8079951e 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -356,7 +356,7 @@ public class Base32 extends BaseNCodec {
* octets, using {@link org.apache.commons.codec.binary.BaseNCodec.Context#pos Context#pos} as the buffer position
* </p>
*
- * @param input byte[] array of ascii data to Base32 decode.
+ * @param input byte[] array of ASCII data to Base32 decode.
* @param inPos Position to start reading data from.
* @param inAvail Amount of bytes available from input for decoding.
* @param context the context to be used
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
index 7da12907..82091760 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
@@ -57,31 +57,31 @@ public class Base32InputStream extends BaseNCodecInputStream {
/**
* Creates a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
*
- * @param in
+ * @param inputStream
* InputStream to wrap.
*/
- public Base32InputStream(final InputStream in) {
- this(in, false);
+ public Base32InputStream(final InputStream inputStream) {
+ this(inputStream, false);
}
/**
* Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
* provided InputStream.
*
- * @param in
+ * @param inputStream
* InputStream to wrap.
* @param doEncode
* true if we should encode all data read from us, false if we should decode.
*/
- public Base32InputStream(final InputStream in, final boolean doEncode) {
- super(in, new Base32(false), doEncode);
+ public Base32InputStream(final InputStream inputStream, final boolean doEncode) {
+ super(inputStream, new Base32(false), doEncode);
}
/**
* Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
* provided InputStream.
*
- * @param input
+ * @param inputStream
* InputStream to wrap.
* @param doEncode
* true if we should encode all data read from us, false if we should decode.
@@ -93,16 +93,15 @@ public class Base32InputStream extends BaseNCodecInputStream {
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
*/
- public Base32InputStream(final InputStream input, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator) {
- super(input, new Base32(lineLength, lineSeparator), doEncode);
+ public Base32InputStream(final InputStream inputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator) {
+ super(inputStream, new Base32(lineLength, lineSeparator), doEncode);
}
/**
* Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
* provided InputStream.
*
- * @param input
+ * @param inputStream
* InputStream to wrap.
* @param doEncode
* true if we should encode all data read from us, false if we should decode.
@@ -117,9 +116,9 @@ public class Base32InputStream extends BaseNCodecInputStream {
* The decoding policy.
* @since 1.15
*/
- public Base32InputStream(final InputStream input, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator, final CodecPolicy decodingPolicy) {
- super(input, new Base32(lineLength, lineSeparator, false, BaseNCodec.PAD_DEFAULT, decodingPolicy), doEncode);
+ public Base32InputStream(final InputStream inputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator,
+ final CodecPolicy decodingPolicy) {
+ super(inputStream, new Base32(lineLength, lineSeparator, false, BaseNCodec.PAD_DEFAULT, decodingPolicy), doEncode);
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
index 596a910e..c0bc740c 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
@@ -61,31 +61,31 @@ public class Base32OutputStream extends BaseNCodecOutputStream {
/**
* Creates a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream.
*
- * @param out
+ * @param outputStream
* OutputStream to wrap.
*/
- public Base32OutputStream(final OutputStream out) {
- this(out, true);
+ public Base32OutputStream(final OutputStream outputStream) {
+ this(outputStream, true);
}
/**
* Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
* original provided OutputStream.
*
- * @param out
+ * @param outputStream
* OutputStream to wrap.
* @param doEncode
* true if we should encode all data written to us, false if we should decode.
*/
- public Base32OutputStream(final OutputStream out, final boolean doEncode) {
- super(out, new Base32(false), doEncode);
+ public Base32OutputStream(final OutputStream outputStream, final boolean doEncode) {
+ super(outputStream, new Base32(false), doEncode);
}
/**
* Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
* original provided OutputStream.
*
- * @param output
+ * @param outputStream
* OutputStream to wrap.
* @param doEncode
* true if we should encode all data written to us, false if we should decode.
@@ -97,16 +97,15 @@ public class Base32OutputStream extends BaseNCodecOutputStream {
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
*/
- public Base32OutputStream(final OutputStream output, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator) {
- super(output, new Base32(lineLength, lineSeparator), doEncode);
+ public Base32OutputStream(final OutputStream outputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator) {
+ super(outputStream, new Base32(lineLength, lineSeparator), doEncode);
}
/**
* Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
* original provided OutputStream.
*
- * @param output
+ * @param outputStream
* OutputStream to wrap.
* @param doEncode
* true if we should encode all data written to us, false if we should decode.
@@ -120,9 +119,9 @@ public class Base32OutputStream extends BaseNCodecOutputStream {
* @param decodingPolicy The decoding policy.
* @since 1.15
*/
- public Base32OutputStream(final OutputStream output, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator, final CodecPolicy decodingPolicy) {
- super(output, new Base32(lineLength, lineSeparator, false, BaseNCodec.PAD_DEFAULT, decodingPolicy), doEncode);
+ public Base32OutputStream(final OutputStream outputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator,
+ final CodecPolicy decodingPolicy) {
+ super(outputStream, new Base32(lineLength, lineSeparator, false, BaseNCodec.PAD_DEFAULT, decodingPolicy), doEncode);
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64.java b/src/main/java/org/apache/commons/codec/binary/Base64.java
index 11e0dd78..7e37c6ae 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -627,8 +627,8 @@ public class Base64 extends BaseNCodec {
* http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/
* </p>
*
- * @param in
- * byte[] array of ascii data to base64 decode.
+ * @param input
+ * byte[] array of ASCII data to base64 decode.
* @param inPos
* Position to start reading data from.
* @param inAvail
@@ -637,7 +637,7 @@ public class Base64 extends BaseNCodec {
* the context to be used
*/
@Override
- void decode(final byte[] in, int inPos, final int inAvail, final Context context) {
+ void decode(final byte[] input, int inPos, final int inAvail, final Context context) {
if (context.eof) {
return;
}
@@ -646,7 +646,7 @@ public class Base64 extends BaseNCodec {
}
for (int i = 0; i < inAvail; i++) {
final byte[] buffer = ensureBufferSize(decodeSize, context);
- final byte b = in[inPos++];
+ final byte b = input[inPos++];
if (b == pad) {
// We're done.
context.eof = true;
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
index 5ae10238..6a96217b 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
@@ -61,31 +61,31 @@ public class Base64InputStream extends BaseNCodecInputStream {
/**
* Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
*
- * @param in
+ * @param inputStream
* InputStream to wrap.
*/
- public Base64InputStream(final InputStream in) {
- this(in, false);
+ public Base64InputStream(final InputStream inputStream) {
+ this(inputStream, false);
}
/**
* Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
* provided InputStream.
*
- * @param in
+ * @param inputStream
* InputStream to wrap.
* @param doEncode
* true if we should encode all data read from us, false if we should decode.
*/
- public Base64InputStream(final InputStream in, final boolean doEncode) {
- super(in, new Base64(false), doEncode);
+ public Base64InputStream(final InputStream inputStream, final boolean doEncode) {
+ super(inputStream, new Base64(false), doEncode);
}
/**
* Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
* provided InputStream.
*
- * @param in
+ * @param inputStream
* InputStream to wrap.
* @param doEncode
* true if we should encode all data read from us, false if we should decode.
@@ -97,16 +97,15 @@ public class Base64InputStream extends BaseNCodecInputStream {
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
*/
- public Base64InputStream(final InputStream in, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator) {
- super(in, new Base64(lineLength, lineSeparator), doEncode);
+ public Base64InputStream(final InputStream inputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator) {
+ super(inputStream, new Base64(lineLength, lineSeparator), doEncode);
}
/**
* Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
* provided InputStream.
*
- * @param in
+ * @param inputStream
* InputStream to wrap.
* @param doEncode
* true if we should encode all data read from us, false if we should decode.
@@ -120,8 +119,8 @@ public class Base64InputStream extends BaseNCodecInputStream {
* @param decodingPolicy The decoding policy.
* @since 1.15
*/
- public Base64InputStream(final InputStream in, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator, final CodecPolicy decodingPolicy) {
- super(in, new Base64(lineLength, lineSeparator, false, decodingPolicy), doEncode);
+ public Base64InputStream(final InputStream inputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator,
+ final CodecPolicy decodingPolicy) {
+ super(inputStream, new Base64(lineLength, lineSeparator, false, decodingPolicy), doEncode);
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
index 93d71b2c..c28e5900 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
@@ -65,31 +65,31 @@ public class Base64OutputStream extends BaseNCodecOutputStream {
/**
* Creates a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream.
*
- * @param out
+ * @param outputStream
* OutputStream to wrap.
*/
- public Base64OutputStream(final OutputStream out) {
- this(out, true);
+ public Base64OutputStream(final OutputStream outputStream) {
+ this(outputStream, true);
}
/**
* Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
* original provided OutputStream.
*
- * @param out
+ * @param outputStream
* OutputStream to wrap.
* @param doEncode
* true if we should encode all data written to us, false if we should decode.
*/
- public Base64OutputStream(final OutputStream out, final boolean doEncode) {
- super(out,new Base64(false), doEncode);
+ public Base64OutputStream(final OutputStream outputStream, final boolean doEncode) {
+ super(outputStream,new Base64(false), doEncode);
}
/**
* Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
* original provided OutputStream.
*
- * @param out
+ * @param outputStream
* OutputStream to wrap.
* @param doEncode
* true if we should encode all data written to us, false if we should decode.
@@ -101,16 +101,15 @@ public class Base64OutputStream extends BaseNCodecOutputStream {
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
* If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
*/
- public Base64OutputStream(final OutputStream out, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator) {
- super(out, new Base64(lineLength, lineSeparator), doEncode);
+ public Base64OutputStream(final OutputStream outputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator) {
+ super(outputStream, new Base64(lineLength, lineSeparator), doEncode);
}
/**
* Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
* original provided OutputStream.
*
- * @param out
+ * @param outputStream
* OutputStream to wrap.
* @param doEncode
* true if we should encode all data written to us, false if we should decode.
@@ -124,8 +123,8 @@ public class Base64OutputStream extends BaseNCodecOutputStream {
* @param decodingPolicy The decoding policy.
* @since 1.15
*/
- public Base64OutputStream(final OutputStream out, final boolean doEncode,
- final int lineLength, final byte[] lineSeparator, final CodecPolicy decodingPolicy) {
- super(out, new Base64(lineLength, lineSeparator, false, decodingPolicy), doEncode);
+ public Base64OutputStream(final OutputStream outputStream, final boolean doEncode, final int lineLength, final byte[] lineSeparator,
+ final CodecPolicy decodingPolicy) {
+ super(outputStream, new Base64(lineLength, lineSeparator, false, decodingPolicy), doEncode);
}
}
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
index af79b4fc..1e895951 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -104,9 +104,6 @@ public abstract class BaseNCodec implements BinaryEncoder, BinaryDecoder {
*/
int modulus;
- Context() {
- }
-
/**
* Returns a String useful for debugging (especially within a debugger.)
*
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
index 703278bd..f860b4e8 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -46,12 +46,12 @@ public class BaseNCodecInputStream extends FilterInputStream {
/**
* Create an instance.
*
- * @param input the input stream
+ * @param inputStream the input stream
* @param baseNCodec the codec
* @param doEncode set to true to perform encoding, else decoding
*/
- protected BaseNCodecInputStream(final InputStream input, final BaseNCodec baseNCodec, final boolean doEncode) {
- super(input);
+ protected BaseNCodecInputStream(final InputStream inputStream, final BaseNCodec baseNCodec, final boolean doEncode) {
+ super(inputStream);
this.doEncode = doEncode;
this.baseNCodec = baseNCodec;
this.buf = new byte[doEncode ? 4096 : 8192];
diff --git a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
index 543138e1..d904c243 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
@@ -50,12 +50,12 @@ public class BaseNCodecOutputStream extends FilterOutputStream {
/**
* TODO should this be protected?
*
- * @param output the underlying output or null.
+ * @param outputStream the underlying output or null.
* @param basedCodec a BaseNCodec.
* @param doEncode true to encode, false to decode, TODO should be an enum?
*/
- public BaseNCodecOutputStream(final OutputStream output, final BaseNCodec basedCodec, final boolean doEncode) {
- super(output);
+ public BaseNCodecOutputStream(final OutputStream outputStream, final BaseNCodec basedCodec, final boolean doEncode) {
+ super(outputStream);
this.baseNCodec = basedCodec;
this.doEncode = doEncode;
}
diff --git a/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java b/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
index 0c78e6d2..e2ca00b8 100644
--- a/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
@@ -82,19 +82,19 @@ public class BinaryCodec implements BinaryDecoder, BinaryEncoder {
}
final int asciiLength = ascii.length;
// get length/8 times bytes with 3 bit shifts to the right of the length
- final byte[] l_raw = new byte[asciiLength >> 3];
+ final byte[] raw = new byte[asciiLength >> 3];
/*
* We decr index jj by 8 as we go along to not recompute indices using multiplication every time inside the
* loop.
*/
- for (int ii = 0, jj = asciiLength - 1; ii < l_raw.length; ii++, jj -= 8) {
+ for (int ii = 0, jj = asciiLength - 1; ii < raw.length; ii++, jj -= 8) {
for (int bits = 0; bits < BITS.length; ++bits) {
if (ascii[jj - bits] == '1') {
- l_raw[ii] |= BITS[bits];
+ raw[ii] |= BITS[bits];
}
}
}
- return l_raw;
+ return raw;
}
// ------------------------------------------------------------------------
@@ -115,19 +115,19 @@ public class BinaryCodec implements BinaryDecoder, BinaryEncoder {
}
final int asciiLength = ascii.length;
// get length/8 times bytes with 3 bit shifts to the right of the length
- final byte[] l_raw = new byte[asciiLength >> 3];
+ final byte[] raw = new byte[asciiLength >> 3];
/*
* We decr index jj by 8 as we go along to not recompute indices using multiplication every time inside the
* loop.
*/
- for (int ii = 0, jj = asciiLength - 1; ii < l_raw.length; ii++, jj -= 8) {
+ for (int ii = 0, jj = asciiLength - 1; ii < raw.length; ii++, jj -= 8) {
for (int bits = 0; bits < BITS.length; ++bits) {
if (ascii[jj - bits] == '1') {
- l_raw[ii] |= BITS[bits];
+ raw[ii] |= BITS[bits];
}
}
}
- return l_raw;
+ return raw;
}
/**
diff --git a/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java b/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java
index c90e0b4d..da051fca 100644
--- a/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java
+++ b/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32.java
@@ -46,7 +46,7 @@ public class PureJavaCrc32 implements Checksum {
/** Create a new PureJavaCrc32 object. */
public PureJavaCrc32() {
- _reset();
+ resetCrc();
}
@Override
@@ -56,11 +56,11 @@ public class PureJavaCrc32 implements Checksum {
@Override
public void reset() {
- _reset();
+ resetCrc();
}
// called by ctor, so must not be overrideable
- private void _reset() {
+ private void resetCrc() {
crc = 0xffffffff;
}
diff --git a/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32C.java b/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32C.java
index 8cc36614..50cf6794 100644
--- a/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32C.java
+++ b/src/main/java/org/apache/commons/codec/digest/PureJavaCrc32C.java
@@ -65,16 +65,16 @@ public class PureJavaCrc32C implements Checksum {
final int c1 =(b[off+1] ^ (localCrc >>>= 8)) & 0xff;
final int c2 =(b[off+2] ^ (localCrc >>>= 8)) & 0xff;
final int c3 =(b[off+3] ^ (localCrc >>>= 8)) & 0xff;
- localCrc = (T[T8_7_start + c0] ^ T[T8_6_start + c1]) ^
- (T[T8_5_start + c2] ^ T[T8_4_start + c3]);
+ localCrc = (T[T8_7_START + c0] ^ T[T8_6_START + c1]) ^
+ (T[T8_5_START + c2] ^ T[T8_4_START + c3]);
final int c4 = b[off+4] & 0xff;
final int c5 = b[off+5] & 0xff;
final int c6 = b[off+6] & 0xff;
final int c7 = b[off+7] & 0xff;
- localCrc ^= (T[T8_3_start + c4] ^ T[T8_2_start + c5]) ^
- (T[T8_1_start + c6] ^ T[T8_0_start + c7]);
+ localCrc ^= (T[T8_3_START + c4] ^ T[T8_2_START + c5]) ^
+ (T[T8_1_START + c6] ^ T[T8_0_START + c7]);
off += 8;
len -= 8;
@@ -82,13 +82,13 @@ public class PureJavaCrc32C implements Checksum {
/* loop unroll - duff's device style */
switch(len) {
- case 7: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
- case 6: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
- case 5: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
- case 4: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
- case 3: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
- case 2: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
- case 1: localCrc = (localCrc >>> 8) ^ T[T8_0_start + ((localCrc ^ b[off++]) & 0xff)];
+ case 7: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
+ case 6: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
+ case 5: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
+ case 4: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
+ case 3: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
+ case 2: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
+ case 1: localCrc = (localCrc >>> 8) ^ T[T8_0_START + ((localCrc ^ b[off++]) & 0xff)];
default:
break; // satisfy Findbugs
}
@@ -99,21 +99,21 @@ public class PureJavaCrc32C implements Checksum {
@Override
final public void update(final int b) {
- crc = (crc >>> 8) ^ T[T8_0_start + ((crc ^ b) & 0xff)];
+ crc = (crc >>> 8) ^ T[T8_0_START + ((crc ^ b) & 0xff)];
}
// CRC polynomial tables generated by:
// java -cp build/test/classes/:build/classes/ \
// org.apache.hadoop.util.TestPureJavaCrc32\$Table 82F63B78
- private static final int T8_0_start = 0*256;
- private static final int T8_1_start = 1*256;
- private static final int T8_2_start = 2*256;
- private static final int T8_3_start = 3*256;
- private static final int T8_4_start = 4*256;
- private static final int T8_5_start = 5*256;
- private static final int T8_6_start = 6*256;
- private static final int T8_7_start = 7*256;
+ private static final int T8_0_START = 0 * 256;
+ private static final int T8_1_START = 1 * 256;
+ private static final int T8_2_START = 2 * 256;
+ private static final int T8_3_START = 3 * 256;
+ private static final int T8_4_START = 4 * 256;
+ private static final int T8_5_START = 5 * 256;
+ private static final int T8_6_START = 6 * 256;
+ private static final int T8_7_START = 7 * 256;
private static final int[] T = {
/* T8_0 */
diff --git a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
index d61be3ac..a0e33698 100644
--- a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
@@ -45,7 +45,7 @@ public class Sha2Crypt {
private static final int ROUNDS_DEFAULT = 5000;
/** Maximum number of rounds. */
- private static final int ROUNDS_MAX = 999999999;
+ private static final int ROUNDS_MAX = 999_999_999;
/** Minimum number of rounds. */
private static final int ROUNDS_MIN = 1000;
diff --git a/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java b/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
index f334e19e..91742242 100644
--- a/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
+++ b/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
@@ -33,12 +33,6 @@ import org.apache.commons.codec.StringEncoder;
*/
public abstract class AbstractCaverphone implements StringEncoder {
- /**
- * Creates an instance of the Caverphone encoder
- */
- public AbstractCaverphone() {
- }
-
/**
* Encodes an Object using the caverphone algorithm. This method is provided in order to satisfy the requirements of
* the Encoder interface, and will throw an EncoderException if the supplied object is not of type java.lang.String.
diff --git a/src/main/java/org/apache/commons/codec/language/Caverphone.java b/src/main/java/org/apache/commons/codec/language/Caverphone.java
index 70ff9580..3f67c478 100644
--- a/src/main/java/org/apache/commons/codec/language/Caverphone.java
+++ b/src/main/java/org/apache/commons/codec/language/Caverphone.java
@@ -39,12 +39,6 @@ public class Caverphone implements StringEncoder {
*/
final private Caverphone2 encoder = new Caverphone2();
- /**
- * Creates an instance of the Caverphone encoder
- */
- public Caverphone() {
- }
-
/**
* Encodes the given String into a Caverphone value.
*
diff --git a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
index 48cc5ec4..fcbd7e4b 100644
--- a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
+++ b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
@@ -215,7 +215,7 @@ public class ColognePhonetic implements StringEncoder {
this.length = 0;
}
- protected abstract char[] copyData(int start, final int length);
+ protected abstract char[] copyData(int start, int length);
public int length() {
return length;
diff --git a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index 53ff2400..1510876a 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -58,12 +58,6 @@ public class DoubleMetaphone implements StringEncoder {
*/
private int maxCodeLen = 4;
- /**
- * Creates an instance of this DoubleMetaphone encoder
- */
- public DoubleMetaphone() {
- }
-
/**
* Encode a value with Double Metaphone.
*
diff --git a/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java b/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
index ee247dc8..4b637efe 100644
--- a/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
+++ b/src/main/java/org/apache/commons/codec/language/MatchRatingApproachEncoder.java
@@ -335,7 +335,7 @@ public class MatchRatingApproachEncoder implements StringEncoder {
}
/**
- * Removes accented letters and replaces with non-accented ascii equivalent Case is preserved.
+ * Removes accented letters and replaces with non-accented ASCII equivalent Case is preserved.
* http://www.codecodex.com/wiki/Remove_accent_from_letters_%28ex_.%C3%A9_to_e%29
*
* @param accentedWord
diff --git a/src/main/java/org/apache/commons/codec/language/Metaphone.java b/src/main/java/org/apache/commons/codec/language/Metaphone.java
index 8aac0222..0a106946 100644
--- a/src/main/java/org/apache/commons/codec/language/Metaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/Metaphone.java
@@ -71,12 +71,6 @@ public class Metaphone implements StringEncoder {
*/
private int maxCodeLen = 4;
- /**
- * Creates an instance of the Metaphone encoder
- */
- public Metaphone() {
- }
-
/**
* Find the metaphone value of a String. This is similar to the
* soundex algorithm, but better at finding similar sounding words.
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Lang.java b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
index ae63f1cd..b6657b24 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/Lang.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
@@ -93,13 +93,13 @@ public class Lang {
}
}
- private static final Map<NameType, Lang> Langs = new EnumMap<>(NameType.class);
+ private static final Map<NameType, Lang> LANGS = new EnumMap<>(NameType.class);
private static final String LANGUAGE_RULES_RN = "org/apache/commons/codec/language/bm/%s_lang.txt";
static {
for (final NameType s : NameType.values()) {
- Langs.put(s, loadFromResource(String.format(LANGUAGE_RULES_RN, s.getName()), Languages.getInstance(s)));
+ LANGS.put(s, loadFromResource(String.format(LANGUAGE_RULES_RN, s.getName()), Languages.getInstance(s)));
}
}
@@ -111,7 +111,7 @@ public class Lang {
* @return a Lang encapsulating the language guessing rules for that name type
*/
public static Lang instance(final NameType nameType) {
- return Langs.get(nameType);
+ return LANGS.get(nameType);
}
/**