This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
The following commit(s) were added to refs/heads/master by this push:
new 8869f4ff Javadoc
8869f4ff is described below
commit 8869f4ff6ad16d4bf665dfa292fa9b4531836cb2
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:21:46 2026 -0400
Javadoc
---
.../org/apache/commons/codec/DecoderException.java | 2 +-
.../org/apache/commons/codec/StringDecoder.java | 2 +-
.../org/apache/commons/codec/StringEncoder.java | 2 +-
.../binary/AbstractBaseNCodecStreamBuilder.java | 2 +-
.../org/apache/commons/codec/binary/Base32.java | 8 +--
.../org/apache/commons/codec/binary/Base58.java | 30 +++++-----
.../org/apache/commons/codec/binary/Base64.java | 12 ++--
.../apache/commons/codec/binary/BaseNCodec.java | 64 +++++++++++-----------
.../codec/binary/BaseNCodecInputStream.java | 10 ++--
.../codec/binary/BaseNCodecOutputStream.java | 6 +-
.../apache/commons/codec/binary/BinaryCodec.java | 12 ++--
.../commons/codec/binary/CharSequenceUtils.java | 8 +--
.../java/org/apache/commons/codec/binary/Hex.java | 64 +++++++++++-----------
.../java/org/apache/commons/codec/digest/B64.java | 2 +-
.../org/apache/commons/codec/digest/Blake3.java | 2 +-
.../org/apache/commons/codec/digest/Crc16.java | 8 +--
.../apache/commons/codec/digest/DigestUtils.java | 24 ++++----
.../org/apache/commons/codec/digest/HmacUtils.java | 52 +++++++++---------
.../org/apache/commons/codec/digest/Sha2Crypt.java | 4 +-
.../org/apache/commons/codec/digest/UnixCrypt.java | 2 +-
.../org/apache/commons/codec/digest/XXHash32.java | 2 +-
.../commons/codec/language/ColognePhonetic.java | 2 +-
.../commons/codec/language/SoundexUtils.java | 2 +-
.../commons/codec/language/bm/Languages.java | 6 +-
.../commons/codec/language/bm/PhoneticEngine.java | 12 ++--
.../org/apache/commons/codec/language/bm/Rule.java | 46 ++++++++--------
.../org/apache/commons/codec/net/PercentCodec.java | 12 ++--
.../commons/codec/net/QuotedPrintableCodec.java | 20 +++----
.../org/apache/commons/codec/net/RFC1522Codec.java | 10 ++--
.../org/apache/commons/codec/net/URLCodec.java | 2 +-
.../java/org/apache/commons/codec/net/Utils.java | 2 +-
.../codec/binary/Base16InputStreamTest.java | 8 +--
.../codec/binary/Base16OutputStreamTest.java | 8 +--
.../apache/commons/codec/binary/Base32Test.java | 2 +-
.../codec/binary/Base58InputStreamTest.java | 4 +-
.../apache/commons/codec/binary/Base64Test.java | 2 +-
.../apache/commons/codec/binary/BaseNTestData.java | 2 +-
.../org/apache/commons/codec/binary/HexTest.java | 4 +-
.../org/apache/commons/codec/digest/Binary.java | 2 +-
.../commons/codec/digest/MurmurHash3Test.java | 20 +++----
40 files changed, 242 insertions(+), 242 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/DecoderException.java
b/src/main/java/org/apache/commons/codec/DecoderException.java
index fea2e82b..ae9b123a 100644
--- a/src/main/java/org/apache/commons/codec/DecoderException.java
+++ b/src/main/java/org/apache/commons/codec/DecoderException.java
@@ -55,7 +55,7 @@ public class DecoderException extends Exception {
* {@link #initCause}.
*
* @param message The format message which is saved for later retrieval by
the {@link #getMessage()} method.
- * @param args the format arguments to use.
+ * @param args The format arguments to use.
*
* @see String#format(String, Object...)
* @since 1.20.0
diff --git a/src/main/java/org/apache/commons/codec/StringDecoder.java
b/src/main/java/org/apache/commons/codec/StringDecoder.java
index 48d730c3..dd6153cf 100644
--- a/src/main/java/org/apache/commons/codec/StringDecoder.java
+++ b/src/main/java/org/apache/commons/codec/StringDecoder.java
@@ -25,7 +25,7 @@ public interface StringDecoder extends Decoder {
/**
* Decodes a String and returns a String.
*
- * @param source the String to decode.
+ * @param source The String to decode.
* @return The encoded String.
* @throws DecoderException thrown if there is an error condition during
the Encoding process.
*/
diff --git a/src/main/java/org/apache/commons/codec/StringEncoder.java
b/src/main/java/org/apache/commons/codec/StringEncoder.java
index 712e1544..492ca427 100644
--- a/src/main/java/org/apache/commons/codec/StringEncoder.java
+++ b/src/main/java/org/apache/commons/codec/StringEncoder.java
@@ -25,7 +25,7 @@ public interface StringEncoder extends Encoder {
/**
* Encodes a String and returns a String.
*
- * @param source the String to encode.
+ * @param source The String to encode.
* @return The encoded String.
* @throws EncoderException thrown if there is an error condition during
the encoding process.
*/
diff --git
a/src/main/java/org/apache/commons/codec/binary/AbstractBaseNCodecStreamBuilder.java
b/src/main/java/org/apache/commons/codec/binary/AbstractBaseNCodecStreamBuilder.java
index f885db49..975ed452 100644
---
a/src/main/java/org/apache/commons/codec/binary/AbstractBaseNCodecStreamBuilder.java
+++
b/src/main/java/org/apache/commons/codec/binary/AbstractBaseNCodecStreamBuilder.java
@@ -72,7 +72,7 @@ public abstract class AbstractBaseNCodecStreamBuilder<T, C
extends BaseNCodec, B
/**
* Sets a BaseNCodec subclass of type C.
*
- * @param baseNCodec a BaseNCodec subclass of type C.
+ * @param baseNCodec A BaseNCodec subclass of type C.
* @return {@code this} instance.
*/
public B setBaseNCodec(final C baseNCodec) {
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 f5f7a29f..4c883f9f 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -102,7 +102,7 @@ public class Base32 extends BaseNCodec {
* The RFC 4648 Base32 and Base32 Hex tables keep their
case-insensitive decoders.
* </p>
*
- * @param encodeTable the encode table with exactly 32 unique entries,
null resets to the default.
+ * @param encodeTable The encode table with exactly 32 unique entries,
null resets to the default.
* @return {@code this} instance.
* @throws IllegalArgumentException if the encode table does not
contain exactly 32 unique entries.
*/
@@ -569,7 +569,7 @@ public class Base32 extends BaseNCodec {
* @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.
+ * @param context The context to be used.
*/
@Override
void decode(final byte[] input, int inPos, final int inAvail, final
Context context) {
@@ -675,7 +675,7 @@ public class Base32 extends BaseNCodec {
* @param input byte[] array of binary data to Base32 encode.
* @param inPos Position to start reading data from.
* @param inAvail Amount of bytes available from input for encoding.
- * @param context the context to be used.
+ * @param context The context to be used.
*/
@Override
void encode(final byte[] input, int inPos, final int inAvail, final
Context context) {
@@ -802,7 +802,7 @@ public class Base32 extends BaseNCodec {
* </p>
*
* @param emptyBitsMask The mask of the lower bits that should be empty.
- * @param context the context to be used.
+ * @param context The context to be used.
* @throws IllegalArgumentException if the bits being checked contain any
non-zero value.
*/
private void validateCharacter(final long emptyBitsMask, final Context
context) {
diff --git a/src/main/java/org/apache/commons/codec/binary/Base58.java
b/src/main/java/org/apache/commons/codec/binary/Base58.java
index 73d6cbd2..00e6c147 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base58.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base58.java
@@ -78,7 +78,7 @@ public class Base58 extends BaseNCodec {
/**
* Sets the encode table and derives the matching decode table.
*
- * @param encodeTable the encode table with exactly 58 unique entries,
null resets to the default.
+ * @param encodeTable The encode table with exactly 58 unique entries,
null resets to the default.
* @return {@code this} instance.
* @throws IllegalArgumentException if the encode table does not
contain exactly 58 unique entries.
*/
@@ -189,7 +189,7 @@ public class Base58 extends BaseNCodec {
/**
* Constructs a Base58 codec used for encoding and decoding with custom
configuration.
*
- * @param builder the builder with custom configuration.
+ * @param builder The builder with custom configuration.
*/
public Base58(final Builder builder) {
super(builder);
@@ -223,8 +223,8 @@ public class Base58 extends BaseNCodec {
* zero bytes in the binary data.
* </p>
*
- * @param base58 the Base58 encoded data.
- * @param context the context for this decoding operation.
+ * @param base58 The Base58 encoded data.
+ * @param context The context for this decoding operation.
* @throws IllegalArgumentException if the Base58 data contains invalid
characters.
*/
private void convertFromBase58(final byte[] base58, final Context context)
{
@@ -262,8 +262,8 @@ public class Base58 extends BaseNCodec {
* alphabet.
* </p>
*
- * @param accumulate the binary data to encode.
- * @param context the context for this encoding operation.
+ * @param accumulate The binary data to encode.
+ * @param context The context for this encoding operation.
* @return The buffer containing the encoded data.
*/
private byte[] convertToBase58(final byte[] accumulate, final Context
context) {
@@ -284,10 +284,10 @@ public class Base58 extends BaseNCodec {
* This implementation accumulates data internally. When length is less
than 0 (EOF), the accumulated data is converted from Base58 to binary.
* </p>
*
- * @param array the byte array containing Base58 encoded data.
- * @param offset the offset in the array to start from.
- * @param length the number of bytes to decode, or negative to signal EOF.
- * @param context the context for this decoding operation.
+ * @param array The byte array containing Base58 encoded data.
+ * @param offset The offset in the array to start from.
+ * @param length The number of bytes to decode, or negative to signal EOF.
+ * @param context The context for this decoding operation.
*/
@Override
void decode(final byte[] array, final int offset, final int length, final
Context context) {
@@ -300,10 +300,10 @@ public class Base58 extends BaseNCodec {
* This implementation accumulates data internally. When length is less
than 0 (EOF), the accumulated data is converted to Base58.
* </p>
*
- * @param array the byte array containing binary data to encode.
- * @param offset the offset in the array to start from.
- * @param length the number of bytes to encode, or negative to signal EOF.
- * @param context the context for this encoding operation.
+ * @param array The byte array containing binary data to encode.
+ * @param offset The offset in the array to start from.
+ * @param length The number of bytes to encode, or negative to signal EOF.
+ * @param context The context for this encoding operation.
*/
@Override
void encode(final byte[] array, final int offset, final int length, final
Context context) {
@@ -317,7 +317,7 @@ public class Base58 extends BaseNCodec {
* character in the Base58 alphabet for each leading zero byte.
* </p>
*
- * @param accumulate the binary data to convert.
+ * @param accumulate The binary data to convert.
* @return A StringBuilder with the Base58 representation (not yet
reversed).
*/
private StringBuilder getStringBuilder(final byte[] accumulate) {
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 3afee334..b6c254df 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -145,7 +145,7 @@ public class Base64 extends BaseNCodec {
/**
* Sets the encode table.
*
- * @param encodeTable the encode table with exactly 64 unique entries,
null resets to the default.
+ * @param encodeTable The encode table with exactly 64 unique entries,
null resets to the default.
* @return {@code this} instance.
* @throws IllegalArgumentException if {@code encodeTable} does not
contain exactly 64 unique entries.
*/
@@ -484,7 +484,7 @@ public class Base64 extends BaseNCodec {
/**
* Decodes a byte64-encoded integer according to crypto standards such as
W3C's XML-Signature.
*
- * @param array a byte array containing base64 character data.
+ * @param array A byte array containing base64 character data.
* @return A BigInteger.
* @since 1.4
*/
@@ -607,7 +607,7 @@ public class Base64 extends BaseNCodec {
/**
* Encodes to a byte64-encoded integer according to crypto standards such
as W3C's XML-Signature.
*
- * @param bigInteger a BigInteger.
+ * @param bigInteger A BigInteger.
* @return A byte array containing base64 character data.
* @throws NullPointerException if null is passed in.
* @since 1.4
@@ -984,7 +984,7 @@ public class Base64 extends BaseNCodec {
* @param input byte[] array of ASCII data to base64 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.
+ * @param context The context to be used.
*/
@Override
void decode(final byte[] input, int inPos, final int inAvail, final
Context context) {
@@ -1063,7 +1063,7 @@ public class Base64 extends BaseNCodec {
* @param in byte[] array of binary data to base64 encode.
* @param inPos Position to start reading data from.
* @param inAvail Amount of bytes available from input for encoding.
- * @param context the context to be used.
+ * @param context The context to be used.
*/
@Override
void encode(final byte[] in, int inPos, final int inAvail, final Context
context) {
@@ -1176,7 +1176,7 @@ public class Base64 extends BaseNCodec {
* </p>
*
* @param emptyBitsMask The mask of the lower bits that should be empty.
- * @param context the context to be used.
+ * @param context The context to be used.
* @throws IllegalArgumentException if the bits being checked contain any
non-zero value.
*/
private void validateCharacter(final int emptyBitsMask, final Context
context) {
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 3979ba87..a90143ff 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -140,7 +140,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the decode table.
*
- * @param decodeTable the decode table.
+ * @param decodeTable The decode table.
* @return {@code this} instance.
* @since 1.20.0
*/
@@ -152,7 +152,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the decode table.
*
- * @param decodeTable the decode table, null resets to the default.
+ * @param decodeTable The decode table, null resets to the default.
* @return {@code this} instance.
*/
B setDecodeTableRaw(final byte[] decodeTable) {
@@ -163,7 +163,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the decoding policy.
*
- * @param decodingPolicy the decoding policy, null resets to the
default.
+ * @param decodingPolicy The decoding policy, null resets to the
default.
* @return {@code this} instance.
*/
public B setDecodingPolicy(final CodecPolicy decodingPolicy) {
@@ -174,7 +174,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the encoded block size, subclasses normally set this on
construction.
*
- * @param encodedBlockSize the encoded block size, subclasses normally
set this on construction.
+ * @param encodedBlockSize The encoded block size, subclasses normally
set this on construction.
* @return {@code this} instance.
*/
B setEncodedBlockSize(final int encodedBlockSize) {
@@ -185,7 +185,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the encode table.
*
- * @param encodeTable the encode table, null resets to the default.
+ * @param encodeTable The encode table, null resets to the default.
* @return {@code this} instance.
*/
public B setEncodeTable(final byte... encodeTable) {
@@ -196,7 +196,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the encode table.
*
- * @param encodeTable the encode table, null resets to the default.
+ * @param encodeTable The encode table, null resets to the default.
* @return {@code this} instance.
*/
B setEncodeTableRaw(final byte... encodeTable) {
@@ -207,7 +207,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the line length.
*
- * @param lineLength the line length, less than 0 resets to the
default.
+ * @param lineLength The line length, less than 0 resets to the
default.
* @return {@code this} instance.
*/
public B setLineLength(final int lineLength) {
@@ -218,7 +218,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the line separator.
*
- * @param lineSeparator the line separator, null resets to the default.
+ * @param lineSeparator The line separator, null resets to the default.
* @return {@code this} instance.
*/
public B setLineSeparator(final byte... lineSeparator) {
@@ -229,7 +229,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the padding byte.
*
- * @param padding the padding byte.
+ * @param padding The padding byte.
* @return {@code this} instance.
*/
public B setPadding(final byte padding) {
@@ -240,7 +240,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Sets the unencoded block size, subclasses normally set this on
construction.
*
- * @param unencodedBlockSize the unencoded block size, subclasses
normally set this on construction.
+ * @param unencodedBlockSize The unencoded block size, subclasses
normally set this on construction.
* @return {@code this} instance.
*/
B setUnencodedBlockSize(final int unencodedBlockSize) {
@@ -386,7 +386,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* Create a positive capacity at least as large the minimum required
capacity. If the minimum capacity is negative then this throws an
OutOfMemoryError as
* no array can be allocated.
*
- * @param minCapacity the minimum capacity.
+ * @param minCapacity The minimum capacity.
* @return The capacity.
* @throws OutOfMemoryError if the {@code minCapacity} is negative.
*/
@@ -420,7 +420,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Gets the array length or 0 if null.
*
- * @param array the array or null.
+ * @param array The array or null.
* @return The array length or 0 if null.
*/
static int getLength(final byte[] array) {
@@ -448,7 +448,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Checks if a byte value is whitespace or not.
*
- * @param byteToCheck the byte to check.
+ * @param byteToCheck The byte to check.
* @return true if byte is whitespace, false otherwise.
* @see Character#isWhitespace(int)
* @deprecated Use {@link Character#isWhitespace(int)}.
@@ -461,8 +461,8 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Increases our buffer by the {@link #DEFAULT_BUFFER_RESIZE_FACTOR}.
*
- * @param context the context to be used.
- * @param minCapacity the minimum required capacity.
+ * @param context The context to be used.
+ * @param minCapacity The minimum required capacity.
* @return The resized byte[] buffer.
* @throws OutOfMemoryError if the {@code minCapacity} is negative.
*/
@@ -581,10 +581,10 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* disabled.
* </p>
*
- * @param unencodedBlockSize the size of an unencoded block (for example
Base64 = 3).
- * @param encodedBlockSize the size of an encoded block (for example
Base64 = 4).
+ * @param unencodedBlockSize The size of an unencoded block (for example
Base64 = 3).
+ * @param encodedBlockSize The size of an encoded block (for example
Base64 = 4).
* @param lineLength if > 0, use chunking with a length
{@code lineLength}.
- * @param chunkSeparatorLength the chunk separator length, if relevant.
+ * @param chunkSeparatorLength The chunk separator length, if relevant.
* @deprecated Use {@link BaseNCodec#BaseNCodec(AbstractBuilder)}.
*/
@Deprecated
@@ -599,10 +599,10 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* disabled.
* </p>
*
- * @param unencodedBlockSize the size of an unencoded block (for example
Base64 = 3).
- * @param encodedBlockSize the size of an encoded block (for example
Base64 = 4).
+ * @param unencodedBlockSize The size of an unencoded block (for example
Base64 = 3).
+ * @param encodedBlockSize The size of an encoded block (for example
Base64 = 4).
* @param lineLength if > 0, use chunking with a length
{@code lineLength}.
- * @param chunkSeparatorLength the chunk separator length, if relevant.
+ * @param chunkSeparatorLength The chunk separator length, if relevant.
* @param pad byte used as padding byte.
* @deprecated Use {@link BaseNCodec#BaseNCodec(AbstractBuilder)}.
*/
@@ -618,10 +618,10 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* disabled.
* </p>
*
- * @param unencodedBlockSize the size of an unencoded block (for example
Base64 = 3).
- * @param encodedBlockSize the size of an encoded block (for example
Base64 = 4).
+ * @param unencodedBlockSize The size of an unencoded block (for example
Base64 = 3).
+ * @param encodedBlockSize The size of an encoded block (for example
Base64 = 4).
* @param lineLength if > 0, use chunking with a length
{@code lineLength}.
- * @param chunkSeparatorLength the chunk separator length, if relevant.
+ * @param chunkSeparatorLength The chunk separator length, if relevant.
* @param pad byte used as padding byte.
* @param decodingPolicy Decoding policy.
* @since 1.15
@@ -644,7 +644,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Returns the amount of buffered data available for reading.
*
- * @param context the context to be used.
+ * @param context The context to be used.
* @return The amount of buffered data available for reading.
*/
int available(final Context context) { // package protected for access
from I/O streams
@@ -724,7 +724,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Encodes a byte[] containing binary data, into a byte[] containing
characters in the alphabet.
*
- * @param array a byte array containing binary data.
+ * @param array A byte array containing binary data.
* @return A byte array containing only the base N alphabetic character
data.
*/
@Override
@@ -738,7 +738,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Encodes a byte[] containing binary data, into a byte[] containing
characters in the alphabet.
*
- * @param array a byte array containing binary data.
+ * @param array A byte array containing binary data.
* @param offset initial offset of the subarray.
* @param length length of the subarray.
* @return A byte array containing only the base N alphabetic character
data.
@@ -781,7 +781,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* This is a duplicate of {@link #encodeToString(byte[])}; it was merged
during refactoring.
* </p>
*
- * @param array a byte array containing binary data.
+ * @param array A byte array containing binary data.
* @return String containing only character data in the appropriate
alphabet.
* @since 1.5
*/
@@ -792,7 +792,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Encodes a byte[] containing binary data, into a String containing
characters in the Base-N alphabet. Uses UTF8 encoding.
*
- * @param array a byte array containing binary data.
+ * @param array A byte array containing binary data.
* @return A String containing only Base-N character data.
*/
public String encodeToString(final byte[] array) {
@@ -803,7 +803,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* Ensures that the buffer has room for {@code size} bytes
*
* @param size minimum spare space required.
- * @param context the context to be used.
+ * @param context The context to be used.
* @return The buffer.
*/
protected byte[] ensureBufferSize(final int size, final Context context) {
@@ -863,7 +863,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Tests whether this object has buffered data for reading.
*
- * @param context the context to be used.
+ * @param context The context to be used.
* @return true if there is data still available for reading.
*/
boolean hasData(final Context context) { // package protected for access
from I/O streams
@@ -929,7 +929,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* @param b byte[] array to extract the buffered data into.
* @param position position in byte[] array to start extraction at.
* @param available amount of bytes we're allowed to extract. We may
extract fewer (if fewer are available).
- * @param context the context to be used.
+ * @param context The context to be used.
* @return The number of bytes successfully extracted into the provided
byte[] array.
*/
int readResults(final byte[] b, final int position, final int available,
final Context context) {
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 80a7c77d..ccf4d5c8 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -73,7 +73,7 @@ public class BaseNCodecInputStream<C extends BaseNCodec, T
extends BaseNCodecInp
/**
* Sets the input bytes.
*
- * @param inputBytes the input bytes.
+ * @param inputBytes The input bytes.
* @return {@code this} instance.
* @since 1.22.0
*/
@@ -84,7 +84,7 @@ public class BaseNCodecInputStream<C extends BaseNCodec, T
extends BaseNCodecInp
/**
* Sets the input stream.
*
- * @param inputStream the input stream.
+ * @param inputStream The input stream.
* @return {@code this} instance.
*/
public B setInputStream(final InputStream inputStream) {
@@ -116,8 +116,8 @@ public class BaseNCodecInputStream<C extends BaseNCodec, T
extends BaseNCodecInp
/**
* Constructs a new instance.
*
- * @param inputStream the input stream.
- * @param baseNCodec the codec.
+ * @param inputStream The input stream.
+ * @param baseNCodec The codec.
* @param doEncode set to true to perform encoding, else decoding.
*/
protected BaseNCodecInputStream(final InputStream inputStream, final C
baseNCodec, final boolean doEncode) {
@@ -162,7 +162,7 @@ public class BaseNCodecInputStream<C extends BaseNCodec, T
extends BaseNCodecInp
* The {@link #mark} method of {@link BaseNCodecInputStream} does nothing.
* </p>
*
- * @param readLimit the maximum limit of bytes that can be read before the
mark position becomes invalid.
+ * @param readLimit The maximum limit of bytes that can be read before the
mark position becomes invalid.
* @see #markSupported()
* @since 1.7
*/
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 4cc1309c..ae5bcdf7 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
@@ -78,7 +78,7 @@ public class BaseNCodecOutputStream<C extends BaseNCodec, T
extends BaseNCodecOu
/**
* Sets the input stream.
*
- * @param outputStream the input stream.
+ * @param outputStream The input stream.
* @return {@code this} instance.
*/
public B setOutputStream(final OutputStream outputStream) {
@@ -110,8 +110,8 @@ public class BaseNCodecOutputStream<C extends BaseNCodec, T
extends BaseNCodecOu
*
* TODO should this be protected?
*
- * @param outputStream the underlying output or null.
- * @param basedCodec a BaseNCodec.
+ * @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 outputStream, final C
basedCodec, final boolean 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 666286bb..f81d4d8c 100644
--- a/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
@@ -126,7 +126,7 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
/**
* Returns {@code true} if the given array is {@code null} or empty (size
0.)
*
- * @param array the source array.
+ * @param array The source array.
* @return {@code true} if the given array is {@code null} or empty (size
0.)
*/
static boolean isEmpty(final byte[] array) {
@@ -136,7 +136,7 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
/**
* Converts an array of raw binary data into an array of ASCII 0 and 1
character bytes - each byte is a truncated char.
*
- * @param raw the raw binary data to convert.
+ * @param raw The raw binary data to convert.
* @return An array of 0 and 1 character bytes for each bit of the
argument.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
@@ -165,7 +165,7 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
/**
* Converts an array of raw binary data into an array of ASCII 0 and 1
characters.
*
- * @param raw the raw binary data to convert.
+ * @param raw The raw binary data to convert.
* @return An array of 0 and 1 characters for each bit of the argument.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
@@ -194,7 +194,7 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
/**
* Converts an array of raw binary data into a String of ASCII 0 and 1
characters.
*
- * @param raw the raw binary data to convert.
+ * @param raw The raw binary data to convert.
* @return A String of 0 and 1 characters representing the binary data.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
@@ -249,7 +249,7 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
/**
* Converts an array of raw binary data into an array of ASCII 0 and 1
characters.
*
- * @param raw the raw binary data to convert.
+ * @param raw The raw binary data to convert.
* @return 0 and 1 ASCII character bytes one for each bit of the argument.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
@@ -261,7 +261,7 @@ public class BinaryCodec implements BinaryDecoder,
BinaryEncoder {
/**
* Converts an array of raw binary data into an array of ASCII 0 and 1
chars.
*
- * @param raw the raw binary data to convert.
+ * @param raw The raw binary data to convert.
* @return 0 and 1 ASCII character chars one for each bit of the argument.
* @throws EncoderException if the argument is not a byte[].
* @see org.apache.commons.codec.Encoder#encode(Object)
diff --git
a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
index fb5ee8b3..6e044868 100644
--- a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
@@ -37,11 +37,11 @@ public class CharSequenceUtils {
* package.
* </p>
*
- * @param cs the {@code CharSequence} to be processed.
+ * @param cs The {@code CharSequence} to be processed.
* @param ignoreCase whether or not to be case-insensitive.
- * @param thisStart the index to start on the {@code cs} CharSequence.
- * @param substring the {@code CharSequence} to be looked for.
- * @param start the index to start on the {@code substring}
CharSequence.
+ * @param thisStart The index to start on the {@code cs} CharSequence.
+ * @param substring The {@code CharSequence} to be looked for.
+ * @param start The index to start on the {@code substring}
CharSequence.
* @param length character length of the region.
* @return whether the region matched.
*/
diff --git a/src/main/java/org/apache/commons/codec/binary/Hex.java
b/src/main/java/org/apache/commons/codec/binary/Hex.java
index 242108f6..4ce48516 100644
--- a/src/main/java/org/apache/commons/codec/binary/Hex.java
+++ b/src/main/java/org/apache/commons/codec/binary/Hex.java
@@ -127,7 +127,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* The returned array will be double the length of the passed array, as it
takes two characters to represent any
* given byte.
*
- * @param data a byte[] to convert to hexadecimal characters.
+ * @param data A byte[] to convert to hexadecimal characters.
* @return A char[] containing lower-case hexadecimal characters.
*/
public static char[] encodeHex(final byte[] data) {
@@ -139,7 +139,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* The returned array will be double the length of the passed array, as it
takes two characters to represent any
* given byte.
*
- * @param data a byte[] to convert to Hex characters.
+ * @param data A byte[] to convert to Hex characters.
* @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase.
* @return A char[] containing hexadecimal characters in the selected case.
* @since 1.4
@@ -153,8 +153,8 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* The returned array will be double the length of the passed array, as it
takes two characters to represent any
* given byte.
*
- * @param data a byte[] to convert to hexadecimal characters.
- * @param toDigits the output alphabet (must contain at least 16 chars).
+ * @param data A byte[] to convert to hexadecimal characters.
+ * @param toDigits The output alphabet (must contain at least 16 chars).
* @return A char[] containing the appropriate characters from the
alphabet For best results, this should be either
* upper- or lower-case hex.
* @since 1.4
@@ -167,9 +167,9 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Converts an array of bytes into an array of characters representing the
hexadecimal values of each byte in order.
*
- * @param data a byte[] to convert to hexadecimal characters.
- * @param dataOffset the position in {@code data} to start encoding from.
- * @param dataLen the number of bytes from {@code dataOffset} to encode.
+ * @param data A byte[] to convert to hexadecimal characters.
+ * @param dataOffset The position in {@code data} to start encoding from.
+ * @param dataLen The number of bytes from {@code dataOffset} to encode.
* @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase.
* @return A char[] containing the appropriate characters from the
alphabet For best results, this should be either
* upper- or lower-case hex.
@@ -182,12 +182,12 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Converts an array of bytes into an array of characters representing the
hexadecimal values of each byte in order.
*
- * @param data a byte[] to convert to hexadecimal characters.
- * @param dataOffset the position in {@code data} to start encoding from.
- * @param dataLen the number of bytes from {@code dataOffset} to encode.
+ * @param data A byte[] to convert to hexadecimal characters.
+ * @param dataOffset The position in {@code data} to start encoding from.
+ * @param dataLen The number of bytes from {@code dataOffset} to encode.
* @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase.
- * @param out a char[] which will hold the resultant appropriate
characters from the alphabet.
- * @param outOffset the position within {@code out} at which to start
writing the encoded characters.
+ * @param out A char[] which will hold the resultant appropriate
characters from the alphabet.
+ * @param outOffset The position within {@code out} at which to start
writing the encoded characters.
* @since 1.15
*/
public static void encodeHex(final byte[] data, final int dataOffset,
final int dataLen, final boolean toLowerCase, final char[] out, final int
outOffset) {
@@ -197,12 +197,12 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Converts an array of bytes into an array of characters representing the
hexadecimal values of each byte in order.
*
- * @param data a byte[] to convert to hexadecimal characters.
- * @param dataOffset the position in {@code data} to start encoding from.
- * @param dataLen the number of bytes from {@code dataOffset} to encode.
- * @param toDigits the output alphabet (must contain at least 16 chars).
- * @param out a char[] which will hold the resultant appropriate
characters from the alphabet.
- * @param outOffset the position within {@code out} at which to start
writing the encoded characters.
+ * @param data A byte[] to convert to hexadecimal characters.
+ * @param dataOffset The position in {@code data} to start encoding from.
+ * @param dataLen The number of bytes from {@code dataOffset} to encode.
+ * @param toDigits The output alphabet (must contain at least 16 chars).
+ * @param out A char[] which will hold the resultant appropriate
characters from the alphabet.
+ * @param outOffset The position within {@code out} at which to start
writing the encoded characters.
* @return The given {@code out}.
*/
private static char[] encodeHex(final byte[] data, final int dataOffset,
final int dataLen, final char[] toDigits, final char[] out, final int
outOffset) {
@@ -222,7 +222,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* <p>All bytes identified by {@link ByteBuffer#remaining()} will be used;
after this method
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
- * @param data a byte buffer to convert to hexadecimal characters.
+ * @param data A byte buffer to convert to hexadecimal characters.
* @return A char[] containing lower-case hexadecimal characters.
* @since 1.11
*/
@@ -238,7 +238,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* <p>All bytes identified by {@link ByteBuffer#remaining()} will be used;
after this method
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
- * @param data a byte buffer to convert to hexadecimal characters.
+ * @param data A byte buffer to convert to hexadecimal characters.
* @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase.
* @return A char[] containing hexadecimal characters in the selected case.
* @since 1.11
@@ -255,8 +255,8 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* <p>All bytes identified by {@link ByteBuffer#remaining()} will be used;
after this method
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
- * @param byteBuffer a byte buffer to convert to hexadecimal characters.
- * @param toDigits the output alphabet (must be at least 16 characters).
+ * @param byteBuffer A byte buffer to convert to hexadecimal characters.
+ * @param toDigits The output alphabet (must be at least 16 characters).
* @return A char[] containing the appropriate characters from the
alphabet For best results, this should be either
* upper- or lower-case hex.
* @since 1.11
@@ -269,7 +269,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* Converts an array of bytes into a String representing the hexadecimal
values of each byte in order. The returned
* String will be double the length of the passed array, as it takes two
characters to represent any given byte.
*
- * @param data a byte[] to convert to hexadecimal characters.
+ * @param data A byte[] to convert to hexadecimal characters.
* @return A String containing lower-case hexadecimal characters.
* @since 1.4
*/
@@ -281,7 +281,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* Converts an array of bytes into a String representing the hexadecimal
values of each byte in order. The returned
* String will be double the length of the passed array, as it takes two
characters to represent any given byte.
*
- * @param data a byte[] to convert to hexadecimal characters.
+ * @param data A byte[] to convert to hexadecimal characters.
* @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase.
* @return A String containing lower-case hexadecimal characters.
* @since 1.11
@@ -297,7 +297,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* <p>All bytes identified by {@link ByteBuffer#remaining()} will be used;
after this method
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
- * @param data a byte buffer to convert to hexadecimal characters.
+ * @param data A byte buffer to convert to hexadecimal characters.
* @return A String containing lower-case hexadecimal characters.
* @since 1.11
*/
@@ -312,7 +312,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* <p>All bytes identified by {@link ByteBuffer#remaining()} will be used;
after this method
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
- * @param data a byte buffer to convert to hexadecimal characters.
+ * @param data A byte buffer to convert to hexadecimal characters.
* @param toLowerCase {@code true} converts to lowercase, {@code false} to
uppercase.
* @return A String containing lower-case hexadecimal characters.
* @since 1.11
@@ -335,7 +335,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* Convert the byte buffer to a byte array. All bytes identified by
* {@link ByteBuffer#remaining()} will be used.
*
- * @param byteBuffer the byte buffer.
+ * @param byteBuffer The byte buffer.
* @return The byte[].
*/
private static byte[] toByteArray(final ByteBuffer byteBuffer) {
@@ -383,7 +383,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Creates a new codec with the given Charset.
*
- * @param charset the charset.
+ * @param charset The charset.
* @since 1.7
*/
public Hex(final Charset charset) {
@@ -393,7 +393,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Creates a new codec with the given charset name.
*
- * @param charsetName the charset name.
+ * @param charsetName The charset name.
* @throws java.nio.charset.UnsupportedCharsetException If the named
charset is unavailable.
* @since 1.4
* @since 1.7 throws UnsupportedCharsetException if the named charset is
unavailable
@@ -473,7 +473,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* {@link #getCharset()}.
* </p>
*
- * @param array a byte[] to convert to hexadecimal characters.
+ * @param array A byte[] to convert to hexadecimal characters.
* @return A byte[] containing the bytes of the lower-case hexadecimal
characters.
* @since 1.7 No longer throws IllegalStateException if the charsetName is
invalid.
* @see #encodeHex(byte[])
@@ -494,7 +494,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* <p>All bytes identified by {@link ByteBuffer#remaining()} will be used;
after this method
* the value {@link ByteBuffer#remaining() remaining()} will be zero.</p>
*
- * @param array a byte buffer to convert to hexadecimal characters.
+ * @param array A byte buffer to convert to hexadecimal characters.
* @return A byte[] containing the bytes of the lower-case hexadecimal
characters.
* @see #encodeHex(byte[])
* @since 1.11
@@ -512,7 +512,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* {@link #getCharset()}.
* </p>
*
- * @param object a String, ByteBuffer, or byte[] to convert to hexadecimal
characters.
+ * @param object A String, ByteBuffer, or byte[] to convert to hexadecimal
characters.
* @return A char[] containing lower-case hexadecimal characters.
* @throws EncoderException Thrown if the given object is not a String or
byte[].
* @see #encodeHex(byte[])
diff --git a/src/main/java/org/apache/commons/codec/digest/B64.java
b/src/main/java/org/apache/commons/codec/digest/B64.java
index 5d6bc6ff..b2870bdc 100644
--- a/src/main/java/org/apache/commons/codec/digest/B64.java
+++ b/src/main/java/org/apache/commons/codec/digest/B64.java
@@ -89,7 +89,7 @@ final class B64 {
* </p>
*
* @param num Number of chars to generate.
- * @param random an instance of {@link Random}.
+ * @param random An instance of {@link Random}.
* @return A random salt {@link String}.
*/
static String getRandomSalt(final int num, final Random random) {
diff --git a/src/main/java/org/apache/commons/codec/digest/Blake3.java
b/src/main/java/org/apache/commons/codec/digest/Blake3.java
index 5f20a183..a2af6222 100644
--- a/src/main/java/org/apache/commons/codec/digest/Blake3.java
+++ b/src/main/java/org/apache/commons/codec/digest/Blake3.java
@@ -360,7 +360,7 @@ public final class Blake3 {
* The instance returned functions as a key-derivation function which can
further absorb additional context data
* before squeezing derived key data.
*
- * @param kdfContext a globally unique key-derivation context byte string
to separate key derivation contexts from each other.
+ * @param kdfContext A globally unique key-derivation context byte string
to separate key derivation contexts from each other.
* @return fresh Blake3 instance in key derivation mode.
* @throws NullPointerException if kdfContext is null.
*/
diff --git a/src/main/java/org/apache/commons/codec/digest/Crc16.java
b/src/main/java/org/apache/commons/codec/digest/Crc16.java
index 1e218785..b350534e 100644
--- a/src/main/java/org/apache/commons/codec/digest/Crc16.java
+++ b/src/main/java/org/apache/commons/codec/digest/Crc16.java
@@ -69,7 +69,7 @@ public final class Crc16 implements Checksum {
/**
* Sets the initial value.
*
- * @param init the initial value.
+ * @param init The initial value.
* @return {@code this} instance.
*/
public Builder setInit(final int init) {
@@ -80,7 +80,7 @@ public final class Crc16 implements Checksum {
/**
* Sets the lookup table.
*
- * @param table the lookup table, making a clone of the input array,
must not be null.
+ * @param table The lookup table, making a clone of the input array,
must not be null.
* @return {@code this} instance.
*/
public Builder setTable(final int[] table) {
@@ -90,7 +90,7 @@ public final class Crc16 implements Checksum {
/**
* Sets the XorOut value to XOR to the current checksum returned by
{@link Crc16#getValue()}.
*
- * @param xorOut the XorOut value.
+ * @param xorOut The XorOut value.
* @return {@code this} instance.
*/
public Builder setXorOut(final int xorOut) {
@@ -101,7 +101,7 @@ public final class Crc16 implements Checksum {
/**
* Sets the lookup table without making a clone.
*
- * @param table the lookup table, must not be null.
+ * @param table The lookup table, must not be null.
* @return {@code this} instance.
*/
private Builder table(final int[] table) {
diff --git a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
index b1561348..0f6443c5 100644
--- a/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/DigestUtils.java
@@ -149,7 +149,7 @@ public class DigestUtils {
/**
* Gets a {@code MessageDigest} for the given {@code algorithm}.
*
- * @param algorithm the name of the algorithm requested. See
+ * @param algorithm The name of the algorithm requested. See
* <a
href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA";>Appendix
A in the Java
* Cryptography Architecture Reference Guide</a> for
information about standard algorithm names.
* @return A digest instance.
@@ -167,7 +167,7 @@ public class DigestUtils {
/**
* Gets a {@code MessageDigest} for the given {@code algorithm} or a
default if there is a problem getting the algorithm.
*
- * @param algorithm the name of the algorithm requested. See
+ * @param algorithm The name of the algorithm requested. See
* <a
href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA";>
Appendix A in the Java
* Cryptography Architecture Reference
Guide</a> for information about standard algorithm names.
* @param defaultMessageDigest The default MessageDigest.
@@ -210,7 +210,7 @@ public class DigestUtils {
/**
* Gets a {@code MessageDigest} for the given {@code algorithm}.
*
- * @param algorithm the name of the algorithm requested. See
+ * @param algorithm The name of the algorithm requested. See
* <a
href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA";>
Appendix A in the Java
* Cryptography Architecture Reference Guide</a> for
information about standard algorithm names.
* @return A digest instance.
@@ -383,7 +383,7 @@ public class DigestUtils {
/**
* Test whether the algorithm is supported.
*
- * @param messageDigestAlgorithm the algorithm name.
+ * @param messageDigestAlgorithm The algorithm name.
* @return {@code true} if the algorithm can be found.
* @since 1.11
*/
@@ -1420,8 +1420,8 @@ public class DigestUtils {
/**
* Updates the given {@link MessageDigest}.
*
- * @param messageDigest the {@link MessageDigest} to update.
- * @param valueToDigest the value to update the {@link MessageDigest} with.
+ * @param messageDigest The {@link MessageDigest} to update.
+ * @param valueToDigest The value to update the {@link MessageDigest} with.
* @return The updated {@link MessageDigest}.
* @since 1.7
*/
@@ -1433,8 +1433,8 @@ public class DigestUtils {
/**
* Updates the given {@link MessageDigest}.
*
- * @param messageDigest the {@link MessageDigest} to update.
- * @param valueToDigest the value to update the {@link MessageDigest} with.
+ * @param messageDigest The {@link MessageDigest} to update.
+ * @param valueToDigest The value to update the {@link MessageDigest} with.
* @return The updated {@link MessageDigest}.
* @since 1.11
*/
@@ -1532,8 +1532,8 @@ public class DigestUtils {
* To update the digest using a different charset for the conversion,
convert the String to a byte array using
* {@link String#getBytes(java.nio.charset.Charset)} and pass that to the
{@link DigestUtils#updateDigest(MessageDigest, byte[])} method
*
- * @param messageDigest the {@link MessageDigest} to update.
- * @param valueToDigest the value to update the {@link MessageDigest}
with; converted to bytes using {@link StringUtils#getBytesUtf8(String)}.
+ * @param messageDigest The {@link MessageDigest} to update.
+ * @param valueToDigest The value to update the {@link MessageDigest}
with; converted to bytes using {@link StringUtils#getBytesUtf8(String)}.
* @return The updated {@link MessageDigest}.
* @since 1.7
*/
@@ -1559,7 +1559,7 @@ public class DigestUtils {
*
* This can then be used to create digests using methods such as {@link
#digest(byte[])} and {@link #digestAsHex(File)}.
*
- * @param digest the {@link MessageDigest} to use.
+ * @param digest The {@link MessageDigest} to use.
* @since 1.11
*/
public DigestUtils(final MessageDigest digest) {
@@ -1571,7 +1571,7 @@ public class DigestUtils {
*
* This can then be used to create digests using methods such as {@link
#digest(byte[])} and {@link #digestAsHex(File)}.
*
- * @param name the name of the {@link MessageDigest} to use.
+ * @param name The name of the {@link MessageDigest} to use.
* @see #getDigest(String)
* @throws IllegalArgumentException Thrown if a {@link
NoSuchAlgorithmException} is caught.
* @since 1.11
diff --git a/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
b/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
index f245fe88..7ae27b9a 100644
--- a/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
+++ b/src/main/java/org/apache/commons/codec/digest/HmacUtils.java
@@ -153,7 +153,7 @@ public final class HmacUtils {
/**
* Returns an initialized {@link Mac} for the given {@code algorithm}.
*
- * @param algorithm the name of the algorithm requested. See
+ * @param algorithm The name of the algorithm requested. See
* <a href=
"https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA";
>Appendix A in the Java
* Cryptography Architecture Reference Guide</a> for
information about standard algorithm names.
* @param key The key for the keyed digest (must not be null).
@@ -169,7 +169,7 @@ public final class HmacUtils {
/**
* Returns an initialized {@link Mac} for the given {@code algorithm}.
*
- * @param algorithm the name of the algorithm requested. See
+ * @param algorithm The name of the algorithm requested. See
* <a href=
"https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html#AppA";
>Appendix A in the Java
* Cryptography Architecture Reference Guide</a> for
information about standard algorithm names.
* @param key The key for the keyed digest (must not be null).
@@ -646,7 +646,7 @@ public final class HmacUtils {
/**
* Tests whether this algorithm is available
*
- * @param hmacAlgorithms the HmacAlgorithms to check.
+ * @param hmacAlgorithms The HmacAlgorithms to check.
* @return whether this algorithm is available.
* @since 1.11
*/
@@ -657,7 +657,7 @@ public final class HmacUtils {
/**
* Tests whether this algorithm is available
*
- * @param name the name to check.
+ * @param name The name to check.
* @return whether this algorithm is available.
* @since 1.11
*/
@@ -673,8 +673,8 @@ public final class HmacUtils {
/**
* Resets and then updates the given {@link Mac} with the value.
*
- * @param mac the initialized {@link Mac} to update.
- * @param valueToDigest the value to update the {@link Mac} with (maybe
null or empty).
+ * @param mac The initialized {@link Mac} to update.
+ * @param valueToDigest The value to update the {@link Mac} with (maybe
null or empty).
* @return The updated {@link Mac}.
* @throws IllegalStateException if the Mac was not initialized.
*/
@@ -687,8 +687,8 @@ public final class HmacUtils {
/**
* Resets and then updates the given {@link Mac} with the value.
*
- * @param mac the initialized {@link Mac} to update.
- * @param valueToDigest the value to update the {@link Mac} with.
+ * @param mac The initialized {@link Mac} to update.
+ * @param valueToDigest The value to update the {@link Mac} with.
* <p>
* The InputStream must not be null and will not be
closed.
* </p>
@@ -710,8 +710,8 @@ public final class HmacUtils {
/**
* Resets and then updates the given {@link Mac} with the value.
*
- * @param mac the initialized {@link Mac} to update.
- * @param valueToDigest the value to update the {@link Mac} with (maybe
null or empty).
+ * @param mac The initialized {@link Mac} to update.
+ * @param valueToDigest The value to update the {@link Mac} with (maybe
null or empty).
* @return The updated {@link Mac}.
* @throws IllegalStateException if the Mac was not initialized.
*/
@@ -737,7 +737,7 @@ public final class HmacUtils {
* Creates an instance using the provided algorithm type.
*
* @param algorithm to use.
- * @param key the key to use.
+ * @param key The key to use.
* @throws IllegalArgumentException Thrown if a {@link
NoSuchAlgorithmException} is caught or key is null or key is invalid.
* @since 1.11
*/
@@ -749,7 +749,7 @@ public final class HmacUtils {
* Creates an instance using the provided algorithm type.
*
* @param algorithm to use.
- * @param key the key to use.
+ * @param key The key to use.
* @throws IllegalArgumentException Thrown if a {@link
NoSuchAlgorithmException} is caught or key is null or key is invalid.
* @since 1.11
*/
@@ -765,7 +765,7 @@ public final class HmacUtils {
* Creates an instance using the provided algorithm type.
*
* @param algorithm to use.
- * @param key the key to use.
+ * @param key The key to use.
* @throws IllegalArgumentException Thrown if a {@link
NoSuchAlgorithmException} is caught or key is null or key is invalid.
* @since 1.11
*/
@@ -777,7 +777,7 @@ public final class HmacUtils {
* Creates an instance using the provided algorithm type.
*
* @param algorithm to use.
- * @param key the key to use.
+ * @param key The key to use.
* @throws IllegalArgumentException Thrown if a {@link
NoSuchAlgorithmException} is caught or key is null or key is invalid.
* @since 1.11
*/
@@ -788,7 +788,7 @@ public final class HmacUtils {
/**
* Returns the digest for the input data.
*
- * @param valueToDigest the input to use.
+ * @param valueToDigest The input to use.
* @return The digest as a byte[].
* @since 1.11
*/
@@ -799,7 +799,7 @@ public final class HmacUtils {
/**
* Returns the digest for the input data.
*
- * @param valueToDigest the input to use.
+ * @param valueToDigest The input to use.
* @return The digest as a byte[].
* @since 1.11
*/
@@ -811,7 +811,7 @@ public final class HmacUtils {
/**
* Returns the digest for the file.
*
- * @param valueToDigest the file to use.
+ * @param valueToDigest The file to use.
* @return The digest.
* @throws IOException If an I/O error occurs.
* @since 1.11
@@ -823,7 +823,7 @@ public final class HmacUtils {
/**
* Returns the digest for the stream.
*
- * @param valueToDigest the data to use.
+ * @param valueToDigest The data to use.
* <p>
* The InputStream must not be null and will not be
closed.
* </p>
@@ -843,7 +843,7 @@ public final class HmacUtils {
/**
* Returns the digest for the file.
*
- * @param valueToDigest the path to use.
+ * @param valueToDigest The path to use.
* @return The digest.
* @throws IOException If an I/O error occurs.
* @since 1.19.0
@@ -857,7 +857,7 @@ public final class HmacUtils {
/**
* Returns the digest for the input data.
*
- * @param valueToDigest the input to use, treated as UTF-8.
+ * @param valueToDigest The input to use, treated as UTF-8.
* @return The digest as a byte[].
* @since 1.11
*/
@@ -868,7 +868,7 @@ public final class HmacUtils {
/**
* Returns the digest for the input data.
*
- * @param valueToDigest the input to use.
+ * @param valueToDigest The input to use.
* @return The digest as a hexadecimal String.
* @since 1.11
*/
@@ -879,7 +879,7 @@ public final class HmacUtils {
/**
* Returns the digest for the input data.
*
- * @param valueToDigest the input to use.
+ * @param valueToDigest The input to use.
* @return The digest as a hexadecimal String.
* @since 1.11
*/
@@ -890,7 +890,7 @@ public final class HmacUtils {
/**
* Returns the digest for the file.
*
- * @param valueToDigest the file to use.
+ * @param valueToDigest The file to use.
* @return The digest as a hexadecimal String.
* @throws IOException If an I/O error occurs.
* @since 1.11
@@ -902,7 +902,7 @@ public final class HmacUtils {
/**
* Returns the digest for the stream.
*
- * @param valueToDigest the data to use.
+ * @param valueToDigest The data to use.
* <p>
* The InputStream must not be null and will not be
closed.
* </p>
@@ -917,7 +917,7 @@ public final class HmacUtils {
/**
* Returns the digest for the path.
*
- * @param valueToDigest the path to use.
+ * @param valueToDigest The path to use.
* @return The digest as a hexadecimal String.
* @throws IOException If an I/O error occurs.
* @since 1.19.0
@@ -929,7 +929,7 @@ public final class HmacUtils {
/**
* Returns the digest for the input data.
*
- * @param valueToDigest the input to use, treated as UTF-8.
+ * @param valueToDigest The input to use, treated as UTF-8.
* @return The digest as a hexadecimal String.
* @since 1.11
*/
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 7c758de2..101d8ae2 100644
--- a/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
@@ -117,7 +117,7 @@ public class Sha2Crypt {
*
* @param keyBytes plaintext to hash. Each array element is set to {@code
0} before returning.
* @param salt real salt value without prefix or "rounds=".
- * @param random the instance of {@link Random} to use for generating
the salt. Consider using {@link SecureRandom} for more secure salts.
+ * @param random The instance of {@link Random} to use for generating
the salt. Consider using {@link SecureRandom} for more secure salts.
* @return The Complete hash value including salt.
* @throws IllegalArgumentException Thrown if the salt does not match the
allowed pattern.
* @throws IllegalArgumentException Thrown if a {@link
NoSuchAlgorithmException} is caught.
@@ -143,7 +143,7 @@ public class Sha2Crypt {
* @param keyBytes plaintext to hash. Each array element is set to
{@code 0} before returning.
* @param salt real salt value without prefix or {@code "rounds="};
may not be null.
* @param saltPrefix either {@code $5$} or {@code $6$}.
- * @param blocksize a value that differs between {@code $5$} and {@code
$6$}.
+ * @param blocksize A value that differs between {@code $5$} and {@code
$6$}.
* @param algorithm {@link MessageDigest} algorithm identifier string.
* @return The Complete hash value including prefix and salt.
* @throws IllegalArgumentException Thrown if the given salt is {@code
null} or does not match the allowed pattern.
diff --git a/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java
b/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java
index 4bcc0366..c74ede03 100644
--- a/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java
+++ b/src/main/java/org/apache/commons/codec/digest/UnixCrypt.java
@@ -238,7 +238,7 @@ public class UnixCrypt {
* </p>
*
* @param original Plaintext password.
- * @param salt a two character string drawn from [a-zA-Z0-9./]. The
salt may be null, in which case a salt is generated for you using
+ * @param salt A two character string drawn from [a-zA-Z0-9./]. The
salt may be null, in which case a salt is generated for you using
* {@link B64#getRandomSalt(int)}. Only the first two
characters are used, others are ignored.
* @return A 13 character string starting with the salt string.
* @throws IllegalArgumentException Thrown if the salt does not match the
allowed pattern.
diff --git a/src/main/java/org/apache/commons/codec/digest/XXHash32.java
b/src/main/java/org/apache/commons/codec/digest/XXHash32.java
index 4d3c9460..f02c0de0 100644
--- a/src/main/java/org/apache/commons/codec/digest/XXHash32.java
+++ b/src/main/java/org/apache/commons/codec/digest/XXHash32.java
@@ -83,7 +83,7 @@ public class XXHash32 implements Checksum {
/**
* Creates an XXHash32 instance.
*
- * @param seed the seed to use.
+ * @param seed The seed to use.
*/
public XXHash32(final int seed) {
this.seed = seed;
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 93c6c65e..eddda45d 100644
--- a/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
+++ b/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
@@ -264,7 +264,7 @@ public class ColognePhonetic implements StringEncoder {
* Stores the next code in the output buffer, keeping track of the
previous code. '0' is only stored if it is the first entry. Ignored chars are
never
* stored. If the code is the same as the last code (whether stored or
not) it is not stored.
*
- * @param code the code to store.
+ * @param code The code to store.
*/
void put(final char code) {
final boolean accept = code != CHAR_IGNORE;
diff --git a/src/main/java/org/apache/commons/codec/language/SoundexUtils.java
b/src/main/java/org/apache/commons/codec/language/SoundexUtils.java
index 377f869d..530a90d2 100644
--- a/src/main/java/org/apache/commons/codec/language/SoundexUtils.java
+++ b/src/main/java/org/apache/commons/codec/language/SoundexUtils.java
@@ -133,7 +133,7 @@ final class SoundexUtils {
* StringUtils.isEmpty(" bob ") = false
* </pre>
*
- * @param cs the CharSequence to check, may be null.
+ * @param cs The CharSequence to check, may be null.
* @return {@code true} if the CharSequence is empty or null.
*/
static boolean isEmpty(final CharSequence cs) {
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Languages.java
b/src/main/java/org/apache/commons/codec/language/bm/Languages.java
index 0ec3b237..ad4aadcf 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/Languages.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/Languages.java
@@ -73,7 +73,7 @@ public class Languages {
/**
* Gets a language set for the given languages.
*
- * @param languages a language set.
+ * @param languages A language set.
* @return A LanguageSet.
*/
public static LanguageSet from(final Set<String> languages) {
@@ -90,7 +90,7 @@ public class Languages {
/**
* Tests whether this instance contains the given value.
*
- * @param language the value to test.
+ * @param language The value to test.
* @return whether this instance contains the given value.
*/
public abstract boolean contains(String language);
@@ -307,7 +307,7 @@ public class Languages {
/**
* Gets a new instance for the given resource name.
*
- * @param languagesResourceName the resource name to lookup.
+ * @param languagesResourceName The resource name to lookup.
* @return A new instance.
*/
public static Languages getInstance(final String languagesResourceName) {
diff --git
a/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
b/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
index 1bd12118..d2ca5832 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/PhoneticEngine.java
@@ -69,7 +69,7 @@ public class PhoneticEngine {
* phoneme of zero characters. This can then be appended to. This
should be the only way to create a new
* phoneme from scratch.
*
- * @param languages the set of languages.
+ * @param languages The set of languages.
* @return a new, empty phoneme builder.
*/
public static PhonemeBuilder empty(final Languages.LanguageSet
languages) {
@@ -90,7 +90,7 @@ public class PhoneticEngine {
/**
* Creates a new phoneme builder containing all phonemes in this one
extended by {@code str}.
*
- * @param str the characters to append to the phonemes.
+ * @param str The characters to append to the phonemes.
*/
public void append(final CharSequence str) {
phonemes.forEach(ph -> ph.append(str));
@@ -103,8 +103,8 @@ public class PhoneticEngine {
* incompatible.
* </p>
*
- * @param phonemeExpr the expression to apply.
- * @param maxPhonemes the maximum number of phonemes to build up.
+ * @param phonemeExpr The expression to apply.
+ * @param maxPhonemes The maximum number of phonemes to build up.
*/
public void apply(final Rule.PhonemeExpr phonemeExpr, final int
maxPhonemes) {
final Set<Rule.Phoneme> newPhonemes = new
LinkedHashSet<>(Math.min(phonemes.size() * phonemeExpr.size(), maxPhonemes));
@@ -307,8 +307,8 @@ public class PhoneticEngine {
* Applies the final rules to convert from a language-specific phonetic
representation to a
* language-independent representation.
*
- * @param phonemeBuilder the current phonemes.
- * @param finalRules the final rules to apply.
+ * @param phonemeBuilder The current phonemes.
+ * @param finalRules The final rules to apply.
* @return The resulting phonemes.
*/
private PhonemeBuilder applyFinalRules(final PhonemeBuilder phonemeBuilder,
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Rule.java
b/src/main/java/org/apache/commons/codec/language/bm/Rule.java
index d0e71382..a260d10f 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/Rule.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/Rule.java
@@ -179,7 +179,7 @@ public class Rule {
/**
* Deprecated since 1.9.
*
- * @param right the Phoneme to join.
+ * @param right The Phoneme to join.
* @return A new Phoneme.
* @deprecated Since 1.9
*/
@@ -191,7 +191,7 @@ public class Rule {
/**
* Returns a new Phoneme with the same text but a union of its current
language set and the given one.
*
- * @param lang the language set to merge.
+ * @param lang The language set to merge.
* @return A new Phoneme.
*/
public Phoneme mergeWithLanguage(final LanguageSet lang) {
@@ -243,7 +243,7 @@ public class Rule {
/**
* Constructs a new instance.
*
- * @param phonemes the phoneme list.
+ * @param phonemes The phoneme list.
*/
public PhonemeList(final List<Phoneme> phonemes) {
this.phonemeList = phonemes;
@@ -268,7 +268,7 @@ public class Rule {
/**
* Tests whether the given input matches this instance.
*
- * @param input the input to test.
+ * @param input The input to test.
* @return whether the given input matches this instance.
*/
boolean isMatch(CharSequence input);
@@ -360,9 +360,9 @@ public class Rule {
/**
* Gets rules for a combination of name type, rule type and languages.
*
- * @param nameType the NameType to consider.
- * @param rt the RuleType to consider.
- * @param langs the set of languages to consider.
+ * @param nameType The NameType to consider.
+ * @param rt The RuleType to consider.
+ * @param langs The set of languages to consider.
* @return A list of Rules that apply.
*/
public static List<Rule> getInstance(final NameType nameType, final
RuleType rt, final Languages.LanguageSet langs) {
@@ -375,9 +375,9 @@ public class Rule {
/**
* Gets rules for a combination of name type, rule type and a single
language.
*
- * @param nameType the NameType to consider.
- * @param rt the RuleType to consider.
- * @param lang the language to consider.
+ * @param nameType The NameType to consider.
+ * @param rt The RuleType to consider.
+ * @param lang The language to consider.
* @return A list of Rules that apply.
*/
public static List<Rule> getInstance(final NameType nameType, final
RuleType rt, final String lang) {
@@ -387,9 +387,9 @@ public class Rule {
/**
* Gets rules for a combination of name type, rule type and languages.
*
- * @param nameType the NameType to consider.
- * @param rt the RuleType to consider.
- * @param langs the set of languages to consider.
+ * @param nameType The NameType to consider.
+ * @param rt The RuleType to consider.
+ * @param langs The set of languages to consider.
* @return A map containing all Rules that apply, grouped by the first
character of the rule pattern.
* @since 1.9
*/
@@ -400,9 +400,9 @@ public class Rule {
/**
* Gets rules for a combination of name type, rule type and a single
language.
*
- * @param nameType the NameType to consider.
- * @param rt the RuleType to consider.
- * @param lang the language to consider.
+ * @param nameType The NameType to consider.
+ * @param rt The RuleType to consider.
+ * @param lang The language to consider.
* @return A map containing all Rules that apply, grouped by the first
character of the rule pattern.
* @since 1.9
*/
@@ -530,7 +530,7 @@ public class Rule {
/**
* Attempts to compile the regex into direct string ops, falling back to
Pattern and Matcher in the worst case.
*
- * @param regex the regular expression to compile.
+ * @param regex The regular expression to compile.
* @return An RPattern that will match this regex.
*/
private static RPattern pattern(final String regex) {
@@ -629,10 +629,10 @@ public class Rule {
/**
* Creates a new rule.
*
- * @param pattern the pattern.
- * @param lContext the left context.
- * @param rContext the right context.
- * @param phoneme the resulting phoneme.
+ * @param pattern The pattern.
+ * @param lContext The left context.
+ * @param rContext The right context.
+ * @param phoneme The resulting phoneme.
*/
public Rule(final String pattern, final String lContext, final String
rContext, final PhonemeExpr phoneme) {
this.pattern = pattern;
@@ -681,8 +681,8 @@ public class Rule {
* Decides if the pattern and context match the input starting at a
position. It is a match if the {@code lContext} matches {@code input} up to
{@code i},
* {@code pattern} matches at i and {@code rContext} matches from the end
of the match of {@code pattern} to the end of {@code input}.
*
- * @param input the input String.
- * @param i the int position within the input.
+ * @param input The input String.
+ * @param i The int position within the input.
* @return true if the pattern and left/right context match, false
otherwise.
*/
public boolean patternAndContextMatches(final CharSequence input, final
int i) {
diff --git a/src/main/java/org/apache/commons/codec/net/PercentCodec.java
b/src/main/java/org/apache/commons/codec/net/PercentCodec.java
index 5853a661..a14bd8eb 100644
--- a/src/main/java/org/apache/commons/codec/net/PercentCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/PercentCodec.java
@@ -79,8 +79,8 @@ public class PercentCodec implements BinaryEncoder,
BinaryDecoder {
* always be encoded. The rest US-ASCII characters will not be encoded,
except for character '%' that
* is used as escape character for Percent-Encoding.
*
- * @param alwaysEncodeChars the unsafe characters that should always be
encoded.
- * @param plusForSpace the flag defining if the space character
should be encoded as '+'.
+ * @param alwaysEncodeChars The unsafe characters that should always be
encoded.
+ * @param plusForSpace The flag defining if the space character
should be encoded as '+'.
*/
public PercentCodec(final byte[] alwaysEncodeChars, final boolean
plusForSpace) {
this.plusForSpace = plusForSpace;
@@ -135,7 +135,7 @@ public class PercentCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Decodes a byte[] Object, whose bytes are encoded with Percent-Encoding.
*
- * @param obj the object to decode.
+ * @param obj The object to decode.
* @return The decoding result byte[] as Object.
* @throws DecoderException Thrown if the object is not a byte array.
*/
@@ -192,7 +192,7 @@ public class PercentCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Encodes an object into using the Percent-Encoding. Only byte[] objects
are accepted.
*
- * @param obj the object to encode.
+ * @param obj The object to encode.
* @return The encoding result byte[] as Object.
* @throws EncoderException Thrown if the object is not a byte array.
*/
@@ -233,7 +233,7 @@ public class PercentCodec implements BinaryEncoder,
BinaryDecoder {
* Inserts a single character into a BitSet and maintains the min and max
of the characters of the
* {@code BitSet alwaysEncodeChars} in order to avoid look-ups when a byte
is out of this range.
*
- * @param b the byte that is candidate for min and max limit.
+ * @param b The byte that is candidate for min and max limit.
*/
private void insertAlwaysEncodeChar(final byte b) {
if (b < 0) {
@@ -251,7 +251,7 @@ public class PercentCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Inserts the byte array into a BitSet for faster lookup.
*
- * @param alwaysEncodeCharsArray the byte array into a BitSet for faster
lookup.
+ * @param alwaysEncodeCharsArray The byte array into a BitSet for faster
lookup.
*/
private void insertAlwaysEncodeChars(final byte[] alwaysEncodeCharsArray) {
if (alwaysEncodeCharsArray != null) {
diff --git
a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
index 7f8e4705..52561e1a 100644
--- a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
@@ -140,7 +140,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
*
* @param b byte to write.
* @param encode indicates whether the octet shall be encoded.
- * @param buffer the buffer to write to.
+ * @param buffer The buffer to write to.
* @return The number of bytes that have been written to the buffer.
*/
private static int encodeByte(final int b, final boolean encode, final
ByteArrayOutputStream buffer) {
@@ -249,7 +249,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* Encodes byte into its quoted-printable representation.
*
* @param b byte to encode.
- * @param buffer the buffer to write to.
+ * @param buffer The buffer to write to.
* @return The number of bytes written to the {@code buffer}.
*/
private static int encodeQuotedPrintable(final int b, final
ByteArrayOutputStream buffer) {
@@ -265,7 +265,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* Gets the byte at position {@code index} of the byte array and make sure
it is unsigned.
*
* @param index position in the array.
- * @param bytes the byte array.
+ * @param bytes The byte array.
* @return The unsigned octet at position {@code index} from the array.
*/
private static int getUnsignedOctet(final int index, final byte[] bytes) {
@@ -316,7 +316,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
/**
* Constructs a new instance for the selection of a default Charset.
*
- * @param charset the default string Charset to use.
+ * @param charset The default string Charset to use.
* @since 1.7
*/
public QuotedPrintableCodec(final Charset charset) {
@@ -326,7 +326,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
/**
* Constructs a new instance for the selection of a default Charset and
strict mode.
*
- * @param charset the default string Charset to use.
+ * @param charset The default string Charset to use.
* @param strict if {@code true}, soft line breaks will be used.
* @since 1.10
*/
@@ -338,7 +338,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
/**
* Constructs a new instance for the selection of a default Charset.
*
- * @param charsetName the default string Charset to use.
+ * @param charsetName The default string Charset to use.
* @throws UnsupportedCharsetException If no support for the named Charset
is available in this instance of the Java virtual machine.
* @throws IllegalArgumentException If the given charsetName is null.
* @throws IllegalCharsetNameException If the given Charset name is
illegal.
@@ -405,7 +405,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* representation.
*
* @param sourceStr quoted-printable string to convert into its
original form.
- * @param sourceCharset the original string Charset.
+ * @param sourceCharset The original string Charset.
* @return original string.
* @throws DecoderException Thrown if quoted-printable decoding is
unsuccessful.
* @since 1.7
@@ -422,7 +422,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* representation.
*
* @param sourceStr quoted-printable string to convert into its
original form.
- * @param sourceCharset the original string Charset.
+ * @param sourceCharset The original string Charset.
* @return original string.
* @throws DecoderException Thrown if quoted-printable
decoding is unsuccessful.
* @throws UnsupportedEncodingException Thrown if Charset is not supported.
@@ -496,7 +496,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* </p>
*
* @param sourceStr string to convert to quoted-printable form.
- * @param sourceCharset the Charset for sourceStr.
+ * @param sourceCharset The Charset for sourceStr.
* @return quoted-printable string.
* @since 1.7
*/
@@ -515,7 +515,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* </p>
*
* @param sourceStr string to convert to quoted-printable form.
- * @param sourceCharset the Charset for sourceStr.
+ * @param sourceCharset The Charset for sourceStr.
* @return quoted-printable string.
* @throws UnsupportedEncodingException Thrown if the Charset is not
supported.
*/
diff --git a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
index 0f78b721..2b5380bb 100644
--- a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
+++ b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
@@ -66,7 +66,7 @@ abstract class RFC1522Codec {
* to perform the specific decoding.
* </p>
*
- * @param text a string to decode.
+ * @param text A string to decode.
* @return A new decoded String or {@code null} if the input is {@code
null}.
* @throws DecoderException Thrown if there is an error
condition during the decoding process.
* @throws UnsupportedEncodingException Thrown if charset specified in the
"encoded-word" header is not supported.
@@ -129,8 +129,8 @@ abstract class RFC1522Codec {
* class to perform the specific encoding.
* </p>
*
- * @param text a string to encode.
- * @param charset a charset to be used.
+ * @param text A string to encode.
+ * @param charset A charset to be used.
* @return RFC 1522 compliant "encoded-word".
* @throws EncoderException Thrown if there is an error condition during
the Encoding process.
* @see Charset
@@ -157,8 +157,8 @@ abstract class RFC1522Codec {
* class to perform the specific encoding.
* </p>
*
- * @param text a string to encode.
- * @param charsetName the charset to use.
+ * @param text A string to encode.
+ * @param charsetName The charset to use.
* @return RFC 1522 compliant "encoded-word".
* @throws EncoderException Thrown if there is an error
condition during the Encoding process.
* @throws UnsupportedCharsetException Thrown if charset is not available.
diff --git a/src/main/java/org/apache/commons/codec/net/URLCodec.java
b/src/main/java/org/apache/commons/codec/net/URLCodec.java
index faa05ae4..eee73a57 100644
--- a/src/main/java/org/apache/commons/codec/net/URLCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/URLCodec.java
@@ -187,7 +187,7 @@ public class URLCodec implements BinaryEncoder,
BinaryDecoder, StringEncoder, St
/**
* Constructs a new instance for the selection of a default charset.
*
- * @param charset the default string charset to use.
+ * @param charset The default string charset to use.
*/
public URLCodec(final String charset) {
this.charset = charset;
diff --git a/src/main/java/org/apache/commons/codec/net/Utils.java
b/src/main/java/org/apache/commons/codec/net/Utils.java
index ab13426e..011df743 100644
--- a/src/main/java/org/apache/commons/codec/net/Utils.java
+++ b/src/main/java/org/apache/commons/codec/net/Utils.java
@@ -55,7 +55,7 @@ final class Utils {
/**
* Returns the upper case hexadecimal digit of the lower 4 bits of the int.
*
- * @param b the input int.
+ * @param b The input int.
* @return The upper case hexadecimal digit of the lower 4 bits of the int.
*/
static char hexChar(final int b) {
diff --git
a/src/test/java/org/apache/commons/codec/binary/Base16InputStreamTest.java
b/src/test/java/org/apache/commons/codec/binary/Base16InputStreamTest.java
index 947e78c2..27f2df7d 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base16InputStreamTest.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base16InputStreamTest.java
@@ -144,7 +144,7 @@ class Base16InputStreamTest {
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the
Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
private void testByChunk(final byte[] encoded, final byte[] decoded)
throws IOException {
@@ -158,7 +158,7 @@ class Base16InputStreamTest {
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the
Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
@@ -195,7 +195,7 @@ class Base16InputStreamTest {
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the
Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
private void testByteByByte(final byte[] encoded, final byte[] decoded)
throws IOException {
@@ -209,7 +209,7 @@ class Base16InputStreamTest {
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the
Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
diff --git
a/src/test/java/org/apache/commons/codec/binary/Base16OutputStreamTest.java
b/src/test/java/org/apache/commons/codec/binary/Base16OutputStreamTest.java
index 8bbffd5b..16e384d5 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base16OutputStreamTest.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base16OutputStreamTest.java
@@ -117,7 +117,7 @@ class Base16OutputStreamTest extends
AbstractBaseNOutputStreamTest {
* mode over and over again.
*
* @param encoded base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
private void testByChunk(final byte[] encoded, final byte[] decoded)
throws IOException {
@@ -132,7 +132,7 @@ class Base16OutputStreamTest extends
AbstractBaseNOutputStreamTest {
* mode over and over again.
*
* @param encoded base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
@@ -170,7 +170,7 @@ class Base16OutputStreamTest extends
AbstractBaseNOutputStreamTest {
* mode over and over again.
*
* @param encoded base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
private void testByteByByte(final byte[] encoded, final byte[] decoded)
throws IOException {
@@ -185,7 +185,7 @@ class Base16OutputStreamTest extends
AbstractBaseNOutputStreamTest {
* mode over and over again.
*
* @param encoded base16 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec
implementation.
*/
private void testByteByByte(final byte[] encoded, final byte[] decoded,
final boolean lowerCase) throws IOException {
diff --git a/src/test/java/org/apache/commons/codec/binary/Base32Test.java
b/src/test/java/org/apache/commons/codec/binary/Base32Test.java
index 8c10444f..eee6820c 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base32Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base32Test.java
@@ -167,7 +167,7 @@ class Base32Test {
* alphabet where the final bits are zero. This asserts that illegal final
* characters throw an exception when decoding.
*
- * @param nbits the number of trailing bits (must be a factor of 5 and
{@code <40})
+ * @param nbits The number of trailing bits (must be a factor of 5 and
{@code <40})
*/
private static void assertBase32DecodingOfTrailingBits(final int nbits) {
// Requires strict decoding
diff --git
a/src/test/java/org/apache/commons/codec/binary/Base58InputStreamTest.java
b/src/test/java/org/apache/commons/codec/binary/Base58InputStreamTest.java
index 39499a55..2ed0f5a8 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base58InputStreamTest.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base58InputStreamTest.java
@@ -126,7 +126,7 @@ class Base58InputStreamTest {
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the
Base58InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded base58 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @param chunkSize chunk size (line-length) of the base58 encoded data.
* @param separator Line separator in the base58 encoded data.
* @throws Exception Usually signifies a bug in the Base58 commons-codec
implementation.
@@ -164,7 +164,7 @@ class Base58InputStreamTest {
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the
Base58InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded base58 encoded data
- * @param decoded the data from above, but decoded
+ * @param decoded The data from above, but decoded
* @param chunkSize chunk size (line-length) of the base58 encoded data.
* @param separator Line separator in the base58 encoded data.
* @throws Exception Usually signifies a bug in the Base58 commons-codec
implementation.
diff --git a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
index 1c0b4294..cc2d927e 100644
--- a/src/test/java/org/apache/commons/codec/binary/Base64Test.java
+++ b/src/test/java/org/apache/commons/codec/binary/Base64Test.java
@@ -90,7 +90,7 @@ class Base64Test {
* alphabet where the final bits are zero. This asserts that illegal final
* characters throw an exception when decoding.
*
- * @param nbits the number of trailing bits (must be a factor of 6 and
{@code <24})
+ * @param nbits The number of trailing bits (must be a factor of 6 and
{@code <24})
*/
private static void assertBase64DecodingOfTrailingBits(final int nbits) {
final Base64 codec = new Base64(0, null, false, CodecPolicy.STRICT);
diff --git a/src/test/java/org/apache/commons/codec/binary/BaseNTestData.java
b/src/test/java/org/apache/commons/codec/binary/BaseNTestData.java
index 878df76b..cac6187a 100644
--- a/src/test/java/org/apache/commons/codec/binary/BaseNTestData.java
+++ b/src/test/java/org/apache/commons/codec/binary/BaseNTestData.java
@@ -75,7 +75,7 @@ public class BaseNTestData {
/**
* Returns an encoded and decoded copy of the same random data.
*
- * @param codec the codec to use.
+ * @param codec The codec to use.
* @param size amount of random data to generate and encode.
* @return two byte[] arrays: [0] = decoded, [1] = encoded.
*/
diff --git a/src/test/java/org/apache/commons/codec/binary/HexTest.java
b/src/test/java/org/apache/commons/codec/binary/HexTest.java
index 51a27ab0..9f4556f5 100644
--- a/src/test/java/org/apache/commons/codec/binary/HexTest.java
+++ b/src/test/java/org/apache/commons/codec/binary/HexTest.java
@@ -53,7 +53,7 @@ class HexTest {
* The method is overridden in AllocateDirectHexTest to use
* {@link ByteBuffer#allocateDirect(int)}
*
- * @param capacity the capacity
+ * @param capacity The capacity
* @return The byte buffer
*/
protected ByteBuffer allocate(final int capacity) {
@@ -120,7 +120,7 @@ class HexTest {
*
* <p>The buffer is allocated using {@link #allocate(int)}.
*
- * @param string the String to encode
+ * @param string The String to encode
* @return The byte buffer
*/
private ByteBuffer getByteBufferUtf8(final String string) {
diff --git a/src/test/java/org/apache/commons/codec/digest/Binary.java
b/src/test/java/org/apache/commons/codec/digest/Binary.java
index 86ef5829..a7b51fd4 100644
--- a/src/test/java/org/apache/commons/codec/digest/Binary.java
+++ b/src/test/java/org/apache/commons/codec/digest/Binary.java
@@ -24,7 +24,7 @@ class Binary {
/**
* Converts a string of 0s and 1s to a byte array.
*
- * @param binary a string of 0s and 1s to a byte array.
+ * @param binary A string of 0s and 1s to a byte array.
* @return A byte array
*/
static byte[] toByteArray(final String binary) {
diff --git a/src/test/java/org/apache/commons/codec/digest/MurmurHash3Test.java
b/src/test/java/org/apache/commons/codec/digest/MurmurHash3Test.java
index bf20238d..b1908b6a 100644
--- a/src/test/java/org/apache/commons/codec/digest/MurmurHash3Test.java
+++ b/src/test/java/org/apache/commons/codec/digest/MurmurHash3Test.java
@@ -105,9 +105,9 @@ class MurmurHash3Test {
*
* <p>The bytes are added to the incremental hash in the given blocks.</p>
*
- * @param bytes the bytes
- * @param seed the seed
- * @param blocks the blocks
+ * @param bytes The bytes
+ * @param seed The seed
+ * @param blocks The blocks
*/
private static void assertIncrementalHash32(final byte[] bytes, final int
seed, final int... blocks) {
int offset = 0;
@@ -131,9 +131,9 @@ class MurmurHash3Test {
*
* <p>The bytes are added to the incremental hash in the given blocks.</p>
*
- * @param bytes the bytes
- * @param seed the seed
- * @param blocks the blocks
+ * @param bytes The bytes
+ * @param seed The seed
+ * @param blocks The blocks
*/
private static void assertIncrementalHash32x86(final byte[] bytes, final
int seed, final int... blocks) {
int offset = 0;
@@ -172,7 +172,7 @@ class MurmurHash3Test {
/**
* Creates the random blocks of data to process up to max length.
*
- * @param maxLength the max length
+ * @param maxLength The max length
* @return The blocks
*/
private static int[] createRandomBlocks(final int maxLength) {
@@ -191,9 +191,9 @@ class MurmurHash3Test {
/**
* Check if the bytes are negative in the given range.
*
- * @param bytes the bytes
- * @param start the start
- * @param length the length
+ * @param bytes The bytes
+ * @param start The start
+ * @param length The length
* @return true, if negative bytes exist
*/
private static boolean negativeBytes(final byte[] bytes, final int start,
final int length) {
