This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-codec.git
The following commit(s) were added to refs/heads/master by this push:
new 8398c1ac Javadoc
8398c1ac is described below
commit 8398c1ac5492951eae3fba5ca9345b7e17edfddd
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 4 10:56:36 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
.../org/apache/commons/codec/binary/Base16.java | 3 +++
.../org/apache/commons/codec/binary/Base64.java | 5 ++++-
.../apache/commons/codec/binary/BaseNCodec.java | 22 ++++++++++++++++++++++
.../apache/commons/codec/digest/MurmurHash3.java | 1 +
.../java/org/apache/commons/codec/net/QCodec.java | 1 +
.../commons/codec/net/QuotedPrintableCodec.java | 1 +
.../org/apache/commons/codec/cli/DigestTest.java | 1 +
.../commons/codec/digest/DigestUtilsTest.java | 4 ++++
.../commons/codec/digest/PureJavaCrc32Test.java | 3 +++
9 files changed, 40 insertions(+), 1 deletion(-)
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 e2415167..fee4f6fc 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base16.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base16.java
@@ -105,6 +105,7 @@ public class Base16 extends BaseNCodec {
private static final int BYTES_PER_ENCODED_BLOCK = 2;
private static final int BYTES_PER_UNENCODED_BLOCK = 1;
+
/**
* This array is a lookup table that translates Unicode characters drawn
from the "Base16 Alphabet" (as specified in Table 5 of RFC 4648) into their
4-bit
* positive integer equivalents. Characters that are not in the Base16
alphabet but fall within the bounds of the array are translated to -1.
@@ -119,6 +120,7 @@ public class Base16 extends BaseNCodec {
-1, 10, 11, 12, 13, 14, 15 //
40-46 A-F
};
// @formatter:on
+
/**
* This array is a lookup table that translates 4-bit positive integer
index values into their "Base16 Alphabet" equivalents as specified in Table 5
of RFC
* 4648.
@@ -141,6 +143,7 @@ public class Base16 extends BaseNCodec {
-1, 10, 11, 12, 13, 14, 15 //
60-66 a-f
};
// @formatter:on
+
/**
* This array is a lookup table that translates 4-bit positive integer
index values into their "Base16 Alphabet" lower-case equivalents.
*/
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 1dbde3c6..b06745d8 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,6 @@ public class Base64 extends BaseNCodec {
return super.setEncodeTable(encodeTable);
}
- // Javadoc 8 can't find {@link
#setDecodeTableFormat(DecodeTableFormat)}
/**
* Sets the URL-safe encoding policy.
* <p>
@@ -157,6 +156,7 @@ public class Base64 extends BaseNCodec {
* @return {@code this} instance.
*/
public Builder setUrlSafe(final boolean urlSafe) {
+ // Javadoc 8 can't find {@link
#setDecodeTableFormat(DecodeTableFormat)}
return setEncodeTable(toUrlSafeEncodeTable(urlSafe));
}
@@ -220,6 +220,7 @@ public class Base64 extends BaseNCodec {
'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'
};
+
/**
* This is a copy of the STANDARD_ENCODE_TABLE above, but with + and /
changed to - and _ to make the encoded Base64 results more URL-SAFE. This table
is
* only used when the Base64's mode is set to URL-SAFE.
@@ -299,6 +300,7 @@ public class Base64 extends BaseNCodec {
/**
* Base64 uses 6-bit fields.
*/
+
/** Mask used to extract 6 bits, used when encoding */
private static final int MASK_6_BITS = 0x3f;
@@ -787,6 +789,7 @@ public class Base64 extends BaseNCodec {
* Line separator for encoding. Not used when decoding. Only used if
lineLength > 0.
*/
private final byte[] lineSeparator;
+
/**
* Convenience variable to help us determine when our buffer is going to
run out of room and needs resizing. {@code encodeSize = 4 +
lineSeparator.length;}
*/
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 cddefa53..d39431d6 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -247,31 +247,38 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* Placeholder for the bytes we're dealing with for our based logic.
Bitwise operations store and extract the encoding or decoding from this
variable.
*/
int ibitWorkArea;
+
/**
* Placeholder for the bytes we're dealing with for our based logic.
Bitwise operations store and extract the encoding or decoding from this
variable.
*/
long lbitWorkArea;
+
/**
* Buffer for streaming.
*/
byte[] buffer;
+
/**
* Position where next character should be written in the buffer.
*/
int pos;
+
/**
* Position where next character should be read from the buffer.
*/
int readPos;
+
/**
* Boolean flag to indicate the EOF has been reached. Once EOF has
been reached, this object becomes useless, and must be thrown away.
*/
boolean eof;
+
/**
* Variable tracks how many characters have been written to the
current line. Only used when encoding. We use it to make sure each encoded line
never
* goes beyond lineLength (if lineLength > 0).
*/
int currentLinePos;
+
/**
* Writes to the buffer only occur after every 3/5 reads when
encoding, and every 4/8 reads when decoding. This variable helps track that.
*/
@@ -295,6 +302,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* @since 1.7
*/
static final int EOF = -1;
+
/**
* MIME chunk size per RFC 2045 section 6.8.
*
@@ -305,6 +313,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* @see <a href="https://www.ietf.org/rfc/rfc2045.txt";>RFC 2045 section
6.8</a>
*/
public static final int MIME_CHUNK_SIZE = 76;
+
/**
* PEM chunk size per RFC 1421 section 4.3.2.4.
*
@@ -316,10 +325,12 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
*/
public static final int PEM_CHUNK_SIZE = 64;
private static final int DEFAULT_BUFFER_RESIZE_FACTOR = 2;
+
/**
* Defines the default buffer size - currently {@value} - must be large
enough for at least one encoded block+separator
*/
private static final int DEFAULT_BUFFER_SIZE = 8192;
+
/**
* The maximum size buffer to allocate.
*
@@ -330,24 +341,29 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* exceeds VM limit. </blockquote>
*/
private static final int MAX_BUFFER_SIZE = Integer.MAX_VALUE - 8;
+
/** Mask used to extract 8 bits, used in decoding bytes */
protected static final int MASK_8BITS = 0xff;
+
/**
* Byte used to pad output.
*/
protected static final byte PAD_DEFAULT = '='; // Allow static access to
default
+
/**
* The default decoding policy.
*
* @since 1.15
*/
protected static final CodecPolicy DECODING_POLICY_DEFAULT =
CodecPolicy.LENIENT;
+
/**
* Chunk separator per RFC 2045 section 2.1.
*
* @see <a href="https://www.ietf.org/rfc/rfc2045.txt";>RFC 2045 section
2.1</a>
*/
static final byte[] CHUNK_SEPARATOR = { '\r', '\n' };
+
/**
* The empty byte array.
*/
@@ -444,21 +460,27 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
*/
@Deprecated
protected final byte PAD = PAD_DEFAULT;
+
/** Pad byte. Instance variable just in case it needs to vary later. */
protected final byte pad;
+
/** Number of bytes in each full block of unencoded data, for example 4
for Base64 and 5 for Base32 */
private final int unencodedBlockSize;
+
/** Number of bytes in each full block of encoded data, for example 3 for
Base64 and 8 for Base32 */
private final int encodedBlockSize;
+
/**
* Chunksize for encoding. Not used when decoding. A value of zero or less
implies no chunking of the encoded data. Rounded down to the nearest multiple of
* encodedBlockSize.
*/
protected final int lineLength;
+
/**
* Size of chunk separator. Not used unless {@link #lineLength} > 0.
*/
private final int chunkSeparatorLength;
+
/**
* Defines the decoding behavior when the input bytes contain leftover
trailing bits that cannot be created by a valid encoding. These can be bits
that are
* unused from the final character or entire characters. The default mode
is lenient decoding. Set this to {@code true} to enable strict decoding.
diff --git a/src/main/java/org/apache/commons/codec/digest/MurmurHash3.java
b/src/main/java/org/apache/commons/codec/digest/MurmurHash3.java
index 49524bb1..5ec7e504 100644
--- a/src/main/java/org/apache/commons/codec/digest/MurmurHash3.java
+++ b/src/main/java/org/apache/commons/codec/digest/MurmurHash3.java
@@ -315,6 +315,7 @@ public final class MurmurHash3 {
*/
@Deprecated
public static final long NULL_HASHCODE = 2862933555777941757L;
+
/**
* A default seed to use for the murmur hash algorithm.
* Has the value {@code 104729}.
diff --git a/src/main/java/org/apache/commons/codec/net/QCodec.java
b/src/main/java/org/apache/commons/codec/net/QCodec.java
index 4d2c162f..8213b40a 100644
--- a/src/main/java/org/apache/commons/codec/net/QCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QCodec.java
@@ -52,6 +52,7 @@ import org.apache.commons.codec.StringEncoder;
* @since 1.3
*/
public class QCodec extends RFC1522Codec implements StringEncoder,
StringDecoder {
+
/**
* BitSet of printable characters as defined in RFC 1522.
*/
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 8f9bc737..62a71f96 100644
--- a/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
+++ b/src/main/java/org/apache/commons/codec/net/QuotedPrintableCodec.java
@@ -291,6 +291,7 @@ public class QuotedPrintableCodec implements BinaryEncoder,
BinaryDecoder, Strin
* The default Charset used for string decoding and encoding.
*/
private final Charset charset;
+
/**
* Indicates whether soft line breaks shall be used during encoding (rule
#3-5).
*/
diff --git a/src/test/java/org/apache/commons/codec/cli/DigestTest.java
b/src/test/java/org/apache/commons/codec/cli/DigestTest.java
index 0bbef394..1955c78e 100644
--- a/src/test/java/org/apache/commons/codec/cli/DigestTest.java
+++ b/src/test/java/org/apache/commons/codec/cli/DigestTest.java
@@ -33,6 +33,7 @@ class DigestTest {
void testEmptyArguments() {
assertThrows(IllegalArgumentException.class, () -> Digest.main(new
String[0]));
}
+
/**
* Tests if null arguments are handled correctly.
*/
diff --git a/src/test/java/org/apache/commons/codec/digest/DigestUtilsTest.java
b/src/test/java/org/apache/commons/codec/digest/DigestUtilsTest.java
index 6bbb805d..b27705b5 100644
--- a/src/test/java/org/apache/commons/codec/digest/DigestUtilsTest.java
+++ b/src/test/java/org/apache/commons/codec/digest/DigestUtilsTest.java
@@ -61,6 +61,7 @@ class DigestUtilsTest {
private static final int SHAKE128_256_BYTE_LEN = 256 / Byte.SIZE;
private static final int SHAKE128_512_BYTE_LEN = 512 / Byte.SIZE;
private static final String EMPTY_STRING = "";
+
/**
* Tests SHAKE128 sample of 0-bit message.
*
@@ -104,6 +105,7 @@ class DigestUtilsTest {
"43 E4 1B 45 A6 53 F2 A5 C4 49 2C 1A DD 54 45 12" +
"DD A2 52 98 33 46 2B 71 A4 1A 45 BE 97 29 0B 6F";
// @formatter:on
+
/**
* Tests SHAKE256 sample of 0-bit message.
*
@@ -147,6 +149,7 @@ class DigestUtilsTest {
"AB 0B AE 31 63 39 89 43 04 E3 58 77 B0 C2 8A 9B" +
"1F D1 66 C7 96 B9 CC 25 8A 06 4A 8F 57 E2 7F 2A";
// @formatter:on
+
/**
* Tests SHAKE128 sample of 1600-bit message.
*
@@ -190,6 +193,7 @@ class DigestUtilsTest {
"44 C9 FB 35 9F D5 6A C0 A9 A7 5A 74 3C FF 68 62" +
"F1 7D 72 59 AB 07 52 16 C0 69 95 11 64 3B 64 39";
// @formatter:on
+
/**
* Tests SHAKE256 sample of 1600-bit message.
*
diff --git
a/src/test/java/org/apache/commons/codec/digest/PureJavaCrc32Test.java
b/src/test/java/org/apache/commons/codec/digest/PureJavaCrc32Test.java
index faa089e4..89f6716a 100644
--- a/src/test/java/org/apache/commons/codec/digest/PureJavaCrc32Test.java
+++ b/src/test/java/org/apache/commons/codec/digest/PureJavaCrc32Test.java
@@ -50,8 +50,10 @@ class PureJavaCrc32Test {
*/
public static class PerformanceTest {
private static final class BenchResult {
+
/** CRC value */
final long value;
+
/** Speed (MB per second) */
final double mbps;
@@ -214,6 +216,7 @@ class PureJavaCrc32Test {
* Generate a table to perform checksums based on the same CRC-32
polynomial that java.util.zip.CRC32 uses.
*/
public static class Table {
+
/** Generate CRC-32 lookup tables */
public static void main(final String[] args) throws
FileNotFoundException {
if (args.length != 1) {
