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 6e5c9b86 Javadoc
6e5c9b86 is described below
commit 6e5c9b868953a9b5127a894b52baf0a1b8df1542
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:17 2026 -0400
Javadoc
---
.../org/apache/commons/codec/BinaryDecoder.java | 2 +-
.../java/org/apache/commons/codec/Charsets.java | 2 +-
.../java/org/apache/commons/codec/Decoder.java | 2 +-
.../binary/AbstractBaseNCodecStreamBuilder.java | 2 +-
.../org/apache/commons/codec/binary/Base16.java | 2 +-
.../commons/codec/binary/Base16InputStream.java | 2 +-
.../commons/codec/binary/Base16OutputStream.java | 2 +-
.../org/apache/commons/codec/binary/Base32.java | 2 +-
.../commons/codec/binary/Base32InputStream.java | 2 +-
.../commons/codec/binary/Base32OutputStream.java | 2 +-
.../org/apache/commons/codec/binary/Base58.java | 6 ++--
.../commons/codec/binary/Base58InputStream.java | 2 +-
.../commons/codec/binary/Base58OutputStream.java | 6 ++--
.../org/apache/commons/codec/binary/Base64.java | 2 +-
.../commons/codec/binary/Base64InputStream.java | 2 +-
.../commons/codec/binary/Base64OutputStream.java | 2 +-
.../apache/commons/codec/binary/BaseNCodec.java | 8 ++---
.../apache/commons/codec/binary/BinaryCodec.java | 6 ++--
.../java/org/apache/commons/codec/binary/Hex.java | 4 +--
.../java/org/apache/commons/codec/digest/B64.java | 4 +--
.../org/apache/commons/codec/digest/Crc16.java | 36 +++++++++++-----------
.../codec/language/DaitchMokotoffSoundex.java | 4 +--
.../commons/codec/language/DoubleMetaphone.java | 4 +--
.../org/apache/commons/codec/language/Nysiis.java | 2 +-
.../org/apache/commons/codec/language/bm/Lang.java | 6 ++--
.../commons/codec/language/bm/Languages.java | 8 ++---
.../commons/codec/language/bm/PhoneticEngine.java | 4 +--
.../org/apache/commons/codec/language/bm/Rule.java | 16 +++++-----
.../org/apache/commons/codec/net/RFC1522Codec.java | 2 +-
.../org/apache/commons/codec/digest/Binary.java | 2 +-
30 files changed, 73 insertions(+), 73 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/BinaryDecoder.java
b/src/main/java/org/apache/commons/codec/BinaryDecoder.java
index 4807d8f1..8fcc70e9 100644
--- a/src/main/java/org/apache/commons/codec/BinaryDecoder.java
+++ b/src/main/java/org/apache/commons/codec/BinaryDecoder.java
@@ -26,7 +26,7 @@ public interface BinaryDecoder extends Decoder {
* Decodes a byte array and returns the results as a byte array.
*
* @param source A byte array which has been encoded with the appropriate
encoder.
- * @return a byte array that contains decoded content.
+ * @return A byte array that contains decoded content.
* @throws DecoderException A decoder exception is thrown if a Decoder
encounters a failure condition during the decode process.
*/
byte[] decode(byte[] source) throws DecoderException;
diff --git a/src/main/java/org/apache/commons/codec/Charsets.java
b/src/main/java/org/apache/commons/codec/Charsets.java
index f4dcce53..d6edb4e1 100644
--- a/src/main/java/org/apache/commons/codec/Charsets.java
+++ b/src/main/java/org/apache/commons/codec/Charsets.java
@@ -151,7 +151,7 @@ public class Charsets {
* Returns a Charset for the named charset. If the name is null, return
the default Charset.
*
* @param charset The name of the requested charset, may be null.
- * @return a Charset for the named charset.
+ * @return A Charset for the named charset.
* @throws java.nio.charset.UnsupportedCharsetException If the named
charset is unavailable.
*/
public static Charset toCharset(final String charset) {
diff --git a/src/main/java/org/apache/commons/codec/Decoder.java
b/src/main/java/org/apache/commons/codec/Decoder.java
index 2a85a2d9..f3c7241c 100644
--- a/src/main/java/org/apache/commons/codec/Decoder.java
+++ b/src/main/java/org/apache/commons/codec/Decoder.java
@@ -36,7 +36,7 @@ public interface Decoder {
*
* @param source
* the object to decode.
- * @return a 'decoded" object.
+ * @return A 'decoded" object.
* @throws DecoderException
* a decoder exception can be thrown for any number of
reasons. Some good candidates are that the
* parameter passed to this method is null, a param cannot be
cast to the appropriate type for a
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 a24215c8..f885db49 100644
---
a/src/main/java/org/apache/commons/codec/binary/AbstractBaseNCodecStreamBuilder.java
+++
b/src/main/java/org/apache/commons/codec/binary/AbstractBaseNCodecStreamBuilder.java
@@ -65,7 +65,7 @@ public abstract class AbstractBaseNCodecStreamBuilder<T, C
extends BaseNCodec, B
/**
* Creates a new BaseNCodec subclass of type C.
*
- * @return a new BaseNCodec subclass of type C.
+ * @return A new BaseNCodec subclass of type C.
*/
protected abstract C newBaseNCodec();
diff --git a/src/main/java/org/apache/commons/codec/binary/Base16.java
b/src/main/java/org/apache/commons/codec/binary/Base16.java
index 700bcfa5..7a2283d8 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16.java
@@ -162,7 +162,7 @@ public class Base16 extends BaseNCodec {
/**
* Constructs a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.20.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
index 5ed3f956..e352bd79 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16InputStream.java
@@ -60,7 +60,7 @@ public class Base16InputStream extends
BaseNCodecInputStream<Base16, Base16Input
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
index 50063676..897ff525 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java
@@ -60,7 +60,7 @@ public class Base16OutputStream extends
BaseNCodecOutputStream<Base16, Base16Out
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
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 a863521f..f5f7a29f 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -261,7 +261,7 @@ public class Base32 extends BaseNCodec {
* .get()
* </pre>
*
- * @return a new Builder.
+ * @return A new Builder.
* @since 1.17.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
index a00f67a4..c6a97c10 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32InputStream.java
@@ -81,7 +81,7 @@ public class Base32InputStream extends
BaseNCodecInputStream<Base32, Base32Input
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
* @since 1.20.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
index 322d4cf8..7f09603b 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java
@@ -85,7 +85,7 @@ public class Base32OutputStream extends
BaseNCodecOutputStream<Base32, Base32Out
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
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 6ddb8227..73d6cbd2 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base58.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base58.java
@@ -68,7 +68,7 @@ public class Base58 extends BaseNCodec {
/**
* Builds a new Base58 instance with the configured settings.
*
- * @return a new Base58 codec.
+ * @return A new Base58 codec.
*/
@Override
public Base58 get() {
@@ -136,7 +136,7 @@ public class Base58 extends BaseNCodec {
* .get()
* </pre>
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
@@ -318,7 +318,7 @@ public class Base58 extends BaseNCodec {
* </p>
*
* @param accumulate the binary data to convert.
- * @return a StringBuilder with the Base58 representation (not yet
reversed).
+ * @return A StringBuilder with the Base58 representation (not yet
reversed).
*/
private StringBuilder getStringBuilder(final byte[] accumulate) {
BigInteger value = new BigInteger(1, accumulate);
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base58InputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base58InputStream.java
index 394a8bad..e6988214 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base58InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base58InputStream.java
@@ -76,7 +76,7 @@ public class Base58InputStream extends
BaseNCodecInputStream<Base58, Base58Input
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base58OutputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base58OutputStream.java
index 593a35d3..bca12916 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base58OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base58OutputStream.java
@@ -69,7 +69,7 @@ public class Base58OutputStream extends
BaseNCodecOutputStream<Base58, Base58Out
/**
* Builds a new Base58OutputStream instance with the configured
settings.
*
- * @return a new Base58OutputStream.
+ * @return A new Base58OutputStream.
*/
@Override
public Base58OutputStream get() {
@@ -79,7 +79,7 @@ public class Base58OutputStream extends
BaseNCodecOutputStream<Base58, Base58Out
/**
* Creates a new Base58 codec instance.
*
- * @return a new Base58 codec.
+ * @return A new Base58 codec.
*/
@Override
protected Base58 newBaseNCodec() {
@@ -90,7 +90,7 @@ public class Base58OutputStream extends
BaseNCodecOutputStream<Base58, Base58Out
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
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 b22c9333..3afee334 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -342,7 +342,7 @@ public class Base64 extends BaseNCodec {
* .get()
* </pre>
*
- * @return a new Builder.
+ * @return A new Builder.
* @since 1.17.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
index 5e9df109..35d8a690 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64InputStream.java
@@ -83,7 +83,7 @@ public class Base64InputStream extends
BaseNCodecInputStream<Base64, Base64Input
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
diff --git
a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
index d9c1a7ee..f9e7fd3c 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java
@@ -89,7 +89,7 @@ public class Base64OutputStream extends
BaseNCodecOutputStream<Base64, Base64Out
/**
* Constructs a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public static Builder builder() {
return new Builder();
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 bbd361d5..3979ba87 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -300,7 +300,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Returns a String useful for debugging (especially within a
debugger.)
*
- * @return a String useful for debugging.
+ * @return A String useful for debugging.
*/
@Override
public String toString() {
@@ -488,7 +488,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* </p>
*
* @param bigInt {@code BigInteger} to be converted.
- * @return a byte array representation of the BigInteger parameter.
+ * @return A byte array representation of the BigInteger parameter.
*/
static byte[] toUnsignedBytes(final BigInteger value) {
byte[] unsigned = value.equals(BigInteger.ZERO) ? EMPTY_BYTE_ARRAY :
value.toByteArray();
@@ -674,7 +674,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* Decodes a byte[] containing characters in the Base-N alphabet.
*
* @param array A byte array containing Base-N character data.
- * @return a byte array containing binary data.
+ * @return A byte array containing binary data.
*/
@Override
public byte[] decode(final byte[] array) {
@@ -715,7 +715,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* Decodes a String containing characters in the Base-N alphabet.
*
* @param array A String containing Base-N character data.
- * @return a byte array containing binary data.
+ * @return A byte array containing binary data.
*/
public byte[] decode(final String array) {
return decode(StringUtils.getBytesUtf8(array));
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 0627b4e1..666286bb 100644
--- a/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
@@ -137,7 +137,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.
- * @return an array of 0 and 1 character bytes for each bit of the
argument.
+ * @return An array of 0 and 1 character bytes for each bit of the
argument.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
public static byte[] toAsciiBytes(final byte[] raw) {
@@ -166,7 +166,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.
- * @return an array of 0 and 1 characters for each bit of the argument.
+ * @return An array of 0 and 1 characters for each bit of the argument.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
public static char[] toAsciiChars(final byte[] raw) {
@@ -195,7 +195,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.
- * @return a String of 0 and 1 characters representing the binary data.
+ * @return A String of 0 and 1 characters representing the binary data.
* @see org.apache.commons.codec.BinaryEncoder#encode(byte[])
*/
public static String toAsciiString(final byte[] raw) {
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 422563d9..242108f6 100644
--- a/src/main/java/org/apache/commons/codec/binary/Hex.java
+++ b/src/main/java/org/apache/commons/codec/binary/Hex.java
@@ -325,7 +325,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
* Converts a boolean to an alphabet.
*
* @param toLowerCase true for lowercase, false for uppercase.
- * @return an alphabet.
+ * @return An alphabet.
*/
private static char[] toAlphabet(final boolean toLowerCase) {
return toLowerCase ? DIGITS_LOWER : DIGITS_UPPER;
@@ -557,7 +557,7 @@ public class Hex implements BinaryEncoder, BinaryDecoder {
/**
* Returns a string representation of the object, which includes the
charset name.
*
- * @return a string representation of the object.
+ * @return A string representation of the object.
*/
@Override
public String toString() {
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 6a4c5f61..5d6bc6ff 100644
--- a/src/main/java/org/apache/commons/codec/digest/B64.java
+++ b/src/main/java/org/apache/commons/codec/digest/B64.java
@@ -75,7 +75,7 @@ final class B64 {
* </p>
*
* @param num Number of chars to generate.
- * @return a random salt {@link String}.
+ * @return A random salt {@link String}.
*/
static String getRandomSalt(final int num) {
return getRandomSalt(num, new SecureRandom());
@@ -90,7 +90,7 @@ final class B64 {
*
* @param num Number of chars to generate.
* @param random an instance of {@link Random}.
- * @return a random salt {@link String}.
+ * @return A random salt {@link String}.
*/
static String getRandomSalt(final int num, final Random random) {
final StringBuilder saltString = new StringBuilder(num);
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 92df371c..1e218785 100644
--- a/src/main/java/org/apache/commons/codec/digest/Crc16.java
+++ b/src/main/java/org/apache/commons/codec/digest/Crc16.java
@@ -285,7 +285,7 @@ public final class Crc16 implements Checksum {
* <li>CRC-IBM</li>
* </ul>
*
- * @return a new CRC16-CCITT Checksum.
+ * @return A new CRC16-CCITT Checksum.
*/
public static Crc16 arc() {
return builder().setInit(ARC_INIT).table(ARC).get();
@@ -298,7 +298,7 @@ public final class Crc16 implements Checksum {
* Since there are so many CRC-16 variants, we do not pick a default.
* </p>
*
- * @return a new builder.
+ * @return A new builder.
*/
public static Builder builder() {
return new Builder();
@@ -323,7 +323,7 @@ public final class Crc16 implements Checksum {
* <li>KERMIT</li>
* </ul>
*
- * @return a new CRC16-CCITT Checksum.
+ * @return A new CRC16-CCITT Checksum.
*/
public static Crc16 ccitt() {
return builder().setInit(CCITT_INIT).table(CCITT).get();
@@ -337,7 +337,7 @@ public final class Crc16 implements Checksum {
* <li>The XorOut value is {@code 0xFFFF}.</li>
* </ul>
*
- * @return a new CRC16-DNP Checksum.
+ * @return A new CRC16-DNP Checksum.
*/
public static Crc16 dnp() {
return
builder().setInit(DNP_INIT).setXorOut(DNP_XOROUT).table(DNP).get();
@@ -346,7 +346,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-CCITT table.
*
- * @return a copy of the CCRC16-CITT table.
+ * @return A copy of the CCRC16-CITT table.
*/
public static int[] getArcTable() {
return ARC.clone();
@@ -355,7 +355,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-CCITT table.
*
- * @return a copy of the CCRC16-CITT table.
+ * @return A copy of the CCRC16-CITT table.
*/
public static int[] getCcittTable() {
return CCITT.clone();
@@ -364,7 +364,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-DNP table.
*
- * @return a copy of the CCRC16-DNP table.
+ * @return A copy of the CCRC16-DNP table.
*/
public static int[] getDnpTable() {
return DNP.clone();
@@ -373,7 +373,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-IBM-SDLC table.
*
- * @return a copy of the CRC16-IBM-SDLC table.
+ * @return A copy of the CRC16-IBM-SDLC table.
*/
public static int[] getIbmSdlcTable() {
return IBM_SDLC.clone();
@@ -382,7 +382,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-MAXIM table.
*
- * @return a copy of the CRC16-MAXIM table.
+ * @return A copy of the CRC16-MAXIM table.
*/
public static int[] getMaximTable() {
return MAXIM.clone();
@@ -391,7 +391,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-MCRF4XX table.
*
- * @return a copy of the CRC16-MCRF4XX table.
+ * @return A copy of the CRC16-MCRF4XX table.
*/
public static int[] getMcrf4xxTable() {
return MCRF4XX.clone();
@@ -400,7 +400,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-MODBUS table.
*
- * @return a copy of the CRC16-MODBUS table.
+ * @return A copy of the CRC16-MODBUS table.
*/
public static int[] getModbusTable() {
return MODBUS.clone();
@@ -409,7 +409,7 @@ public final class Crc16 implements Checksum {
/**
* Gets a copy of the CRC16-NRSC-5 table.
*
- * @return a copy of the CRC16-NRSC-5 table.
+ * @return A copy of the CRC16-NRSC-5 table.
*/
public static int[] getNrsc5Table() {
return NRSC5.clone();
@@ -434,7 +434,7 @@ public final class Crc16 implements Checksum {
* <li>X-25</li>
* </ul>
*
- * @return a new CRC16-IBM-SDLC Checksum.
+ * @return A new CRC16-IBM-SDLC Checksum.
*/
public static Crc16 ibmSdlc() {
return
builder().setInit(IBM_SDLC_INIT).setXorOut(IBM_SDLC_XOROUT).table(IBM_SDLC).get();
@@ -457,7 +457,7 @@ public final class Crc16 implements Checksum {
* <li>CRC-16/MAXIM-DOW</li>
* </ul>
*
- * @return a new CRC16-MAXIM Checksum.
+ * @return A new CRC16-MAXIM Checksum.
*/
public static Crc16 maxim() {
return
builder().setInit(MAXIM_INIT).setXorOut(MAXIM_XOROUT).table(MAXIM).get();
@@ -471,7 +471,7 @@ public final class Crc16 implements Checksum {
* <li>The XorOut value is {@code 0x0000}.</li>
* </ul>
*
- * @return a new CRC16-MCRF4XX Checksum.
+ * @return A new CRC16-MCRF4XX Checksum.
*/
public static Crc16 mcrf4xx() {
return builder().setInit(MCRF4XX_INIT).table(MCRF4XX).get();
@@ -495,7 +495,7 @@ public final class Crc16 implements Checksum {
* <li>MODBUST</li>
* </ul>
*
- * @return a new CRC16-MODBUS Checksum.
+ * @return A new CRC16-MODBUS Checksum.
*/
public static Crc16 modbus() {
return builder().setInit(MODBUS_INIT).table(MODBUS).get();
@@ -509,7 +509,7 @@ public final class Crc16 implements Checksum {
* <li>The XorOut value is {@code 0x0000}.</li>
* </ul>
*
- * @return a new CRC16-NRSC-5 Checksum.
+ * @return A new CRC16-NRSC-5 Checksum.
*/
public static Crc16 nrsc5() {
return builder().setInit(NRSC5_INIT).table(NRSC5).get();
@@ -523,7 +523,7 @@ public final class Crc16 implements Checksum {
* <li>The XorOut value is {@code 0xFFFF}.</li>
* </ul>
*
- * @return a new CRC16-USB Checksum.
+ * @return A new CRC16-USB Checksum.
*/
public static Crc16 usb() {
return
builder().setInit(USB_INIT).setXorOut(USB_XOROUT).table(USB).get();
diff --git
a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
index cbade2b6..c3fb703e 100644
--- a/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
+++ b/src/main/java/org/apache/commons/codec/language/DaitchMokotoffSoundex.java
@@ -84,7 +84,7 @@ public class DaitchMokotoffSoundex implements StringEncoder {
/**
* Creates a new branch, identical to this branch.
*
- * @return a new, identical branch.
+ * @return A new, identical branch.
*/
private Branch createBranch() {
final Branch branch = new Branch();
@@ -342,7 +342,7 @@ public class DaitchMokotoffSoundex implements StringEncoder
{
*
* @param input
* the input string to clean up.
- * @return a cleaned up string.
+ * @return A cleaned up string.
*/
private String cleanup(final String input) {
final StringBuilder sb = new StringBuilder();
diff --git
a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
index 262d7536..2915db9d 100644
--- a/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
+++ b/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
@@ -328,7 +328,7 @@ public class DoubleMetaphone implements StringEncoder {
* Encodes a value with Double Metaphone.
*
* @param value String to encode.
- * @return an encoded string.
+ * @return An encoded string.
*/
public String doubleMetaphone(final String value) {
return doubleMetaphone(value, false);
@@ -339,7 +339,7 @@ public class DoubleMetaphone implements StringEncoder {
*
* @param value String to encode.
* @param alternate use alternate encode.
- * @return an encoded string.
+ * @return An encoded string.
*/
public String doubleMetaphone(String value, final boolean alternate) {
value = cleanInput(value);
diff --git a/src/main/java/org/apache/commons/codec/language/Nysiis.java
b/src/main/java/org/apache/commons/codec/language/Nysiis.java
index d18feefd..efcc13f6 100644
--- a/src/main/java/org/apache/commons/codec/language/Nysiis.java
+++ b/src/main/java/org/apache/commons/codec/language/Nysiis.java
@@ -115,7 +115,7 @@ public class Nysiis implements StringEncoder {
* the next character.
* @param aNext
* the after next character.
- * @return a transcoded array of characters, starting from the current
position.
+ * @return A transcoded array of characters, starting from the current
position.
*/
private static char[] transcodeRemaining(final char prev, final char curr,
final char next, final char aNext) {
// 1. EV -> AF
diff --git a/src/main/java/org/apache/commons/codec/language/bm/Lang.java
b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
index b02a72f5..63aa8f24 100644
--- a/src/main/java/org/apache/commons/codec/language/bm/Lang.java
+++ b/src/main/java/org/apache/commons/codec/language/bm/Lang.java
@@ -116,7 +116,7 @@ public class Lang {
*
* @param nameType
* the NameType to look up.
- * @return a Lang encapsulating the language guessing rules for that name
type.
+ * @return A Lang encapsulating the language guessing rules for that name
type.
*/
public static Lang instance(final NameType nameType) {
return LANGS.get(nameType);
@@ -133,7 +133,7 @@ public class Lang {
* the fully-qualified resource name to load.
* @param languages
* the languages that these rules will support.
- * @return a Lang encapsulating the loaded language-guessing rules.
+ * @return A Lang encapsulating the loaded language-guessing rules.
*/
public static Lang loadFromResource(final String
languageRulesResourceName, final Languages languages) {
final List<LangRule> rules = new ArrayList<>();
@@ -209,7 +209,7 @@ public class Lang {
*
* @param input
* the word.
- * @return a Set of Strings of language names that are potential matches
for the input word.
+ * @return A Set of Strings of language names that are potential matches
for the input word.
*/
public Languages.LanguageSet guessLanguages(final String input) {
final String text = input.toLowerCase(Locale.ENGLISH);
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 822b26d4..0ec3b237 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
@@ -74,7 +74,7 @@ public class Languages {
* Gets a language set for the given languages.
*
* @param languages a language set.
- * @return a LanguageSet.
+ * @return A LanguageSet.
*/
public static LanguageSet from(final Set<String> languages) {
return languages.isEmpty() ? NO_LANGUAGES : new
SomeLanguages(languages);
@@ -122,7 +122,7 @@ public class Languages {
* Returns an instance restricted to this instances and the given
values'.
*
* @param other The other instance.
- * @return an instance restricted to this instances and the given
values'.
+ * @return An instance restricted to this instances and the given
values'.
*/
public abstract LanguageSet restrictTo(LanguageSet other);
}
@@ -298,7 +298,7 @@ public class Languages {
* Gets an instance for the given name type.
*
* @param nameType The name type to lookup.
- * @return an instance for the given name type.
+ * @return An instance for the given name type.
*/
public static Languages getInstance(final NameType nameType) {
return LANGUAGES.get(nameType);
@@ -308,7 +308,7 @@ public class Languages {
* Gets a new instance for the given resource name.
*
* @param languagesResourceName the resource name to lookup.
- * @return a new instance.
+ * @return A new instance.
*/
public static Languages getInstance(final String languagesResourceName) {
// read languages list
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 628033ef..1bd12118 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
@@ -249,7 +249,7 @@ public class PhoneticEngine {
*
* @param strings Strings to join.
* @param sep String to separate them with.
- * @return a single String consisting of each element of {@code strings}
interleaved by {@code sep}.
+ * @return A single String consisting of each element of {@code strings}
interleaved by {@code sep}.
*/
private static String join(final List<String> strings, final String sep) {
return strings.stream().collect(Collectors.joining(sep));
@@ -373,7 +373,7 @@ public class PhoneticEngine {
* String to phoneticise; a String with dashes or spaces
separating each word.
* @param languageSet
* set of possible origin languages.
- * @return a phonetic representation of the input; a String containing
'-'-separated phonetic representations of the
+ * @return A phonetic representation of the input; a String containing
'-'-separated phonetic representations of the
* input.
*/
public String encode(String input, final Languages.LanguageSet
languageSet) {
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 eede01dc..d0e71382 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
@@ -180,7 +180,7 @@ public class Rule {
* Deprecated since 1.9.
*
* @param right the Phoneme to join.
- * @return a new Phoneme.
+ * @return A new Phoneme.
* @deprecated Since 1.9
*/
@Deprecated
@@ -192,7 +192,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.
- * @return a new Phoneme.
+ * @return A new Phoneme.
*/
public Phoneme mergeWithLanguage(final LanguageSet lang) {
return new Phoneme(phonemeText.toString(), languages.merge(lang));
@@ -217,7 +217,7 @@ public class Rule {
/**
* Gets an iteration of phonemes.
*
- * @return an iteration of phonemes.
+ * @return An iteration of phonemes.
*/
Iterable<Phoneme> getPhonemes();
@@ -363,7 +363,7 @@ public class Rule {
* @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.
+ * @return A list of Rules that apply.
*/
public static List<Rule> getInstance(final NameType nameType, final
RuleType rt, final Languages.LanguageSet langs) {
final Map<String, List<Rule>> ruleMap = getInstanceMap(nameType, rt,
langs);
@@ -378,7 +378,7 @@ public class Rule {
* @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.
+ * @return A list of Rules that apply.
*/
public static List<Rule> getInstance(final NameType nameType, final
RuleType rt, final String lang) {
return getInstance(nameType, rt, LanguageSet.from(new
HashSet<>(Arrays.asList(lang))));
@@ -390,7 +390,7 @@ public class Rule {
* @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.
+ * @return A map containing all Rules that apply, grouped by the first
character of the rule pattern.
* @since 1.9
*/
public static Map<String, List<Rule>> getInstanceMap(final NameType
nameType, final RuleType rt, final Languages.LanguageSet langs) {
@@ -403,7 +403,7 @@ public class Rule {
* @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.
+ * @return A map containing all Rules that apply, grouped by the first
character of the rule pattern.
* @since 1.9
*/
public static Map<String, List<Rule>> getInstanceMap(final NameType
nameType, final RuleType rt, final String lang) {
@@ -531,7 +531,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.
- * @return an RPattern that will match this regex.
+ * @return An RPattern that will match this regex.
*/
private static RPattern pattern(final String regex) {
final boolean startsWith = regex.startsWith("^");
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 547db90b..0f78b721 100644
--- a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
+++ b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
@@ -108,7 +108,7 @@ abstract class RFC1522Codec {
* Decodes an array of bytes using the defined encoding scheme.
*
* @param bytes Data to be decoded.
- * @return a byte array that contains decoded data.
+ * @return A byte array that contains decoded data.
* @throws DecoderException Thrown if a Decoder encounters a failure
condition during the decode process.
*/
protected abstract byte[] doDecoding(byte[] bytes) throws DecoderException;
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 f98d4fd0..86ef5829 100644
--- a/src/test/java/org/apache/commons/codec/digest/Binary.java
+++ b/src/test/java/org/apache/commons/codec/digest/Binary.java
@@ -25,7 +25,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.
- * @return a byte array
+ * @return A byte array
*/
static byte[] toByteArray(final String binary) {
// Ensure the binary string length is a multiple of 8
