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 c1e54621 Javadoc
c1e54621 is described below
commit c1e546212f53848c96bf96a8c4d523c0e3133b37
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jun 4 10:51:28 2023 -0400
Javadoc
Close HTML tags
---
src/main/java/org/apache/commons/codec/Decoder.java | 2 ++
.../java/org/apache/commons/codec/DecoderException.java | 1 +
src/main/java/org/apache/commons/codec/Encoder.java | 1 +
src/main/java/org/apache/commons/codec/binary/Base32.java | 5 +++--
src/main/java/org/apache/commons/codec/binary/Base64.java | 14 +++++++++-----
.../java/org/apache/commons/codec/binary/BaseNCodec.java | 14 ++++++++++----
.../apache/commons/codec/binary/BaseNCodecInputStream.java | 8 ++++++--
.../commons/codec/binary/BaseNCodecOutputStream.java | 4 +++-
.../org/apache/commons/codec/binary/CharSequenceUtils.java | 4 +++-
9 files changed, 38 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/codec/Decoder.java
b/src/main/java/org/apache/commons/codec/Decoder.java
index 2d525054..afb030b6 100644
--- a/src/main/java/org/apache/commons/codec/Decoder.java
+++ b/src/main/java/org/apache/commons/codec/Decoder.java
@@ -22,8 +22,10 @@ package org.apache.commons.codec;
* <p>
* This is the sister interface of {@link Encoder}. All Decoders implement
this common generic interface.
* Allows a user to pass a generic Object to any Decoder implementation in the
codec package.
+ * </p>
* <p>
* One of the two interfaces at the center of the codec package.
+ * </p>
*/
public interface Decoder {
diff --git a/src/main/java/org/apache/commons/codec/DecoderException.java
b/src/main/java/org/apache/commons/codec/DecoderException.java
index 290a79c9..dc8aa9ba 100644
--- a/src/main/java/org/apache/commons/codec/DecoderException.java
+++ b/src/main/java/org/apache/commons/codec/DecoderException.java
@@ -55,6 +55,7 @@ public class DecoderException extends Exception {
* <p>
* Note that the detail message associated with {@code cause} is not
automatically incorporated into this
* exception's detail message.
+ * </p>
*
* @param message
* The detail message which is saved for later retrieval by the
{@link #getMessage()} method.
diff --git a/src/main/java/org/apache/commons/codec/Encoder.java
b/src/main/java/org/apache/commons/codec/Encoder.java
index 4c7a70e4..186d1335 100644
--- a/src/main/java/org/apache/commons/codec/Encoder.java
+++ b/src/main/java/org/apache/commons/codec/Encoder.java
@@ -23,6 +23,7 @@ package org.apache.commons.codec;
* This is the sister interface of {@link Decoder}. Every implementation of
Encoder provides this
* common generic interface which allows a user to pass a generic Object to
any Encoder implementation
* in the codec package.
+ * </p>
*/
public interface Encoder {
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 8079951e..0ede1ba7 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base32.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base32.java
@@ -584,9 +584,10 @@ public class Base32 extends BaseNCodec {
/**
* Validates whether decoding the final trailing character is possible in
the context
* of the set of possible base 32 values.
- *
- * <p>The character is valid if the lower bits within the provided mask
are zero. This
+ * <p>
+ * The character is valid if the lower bits within the provided mask are
zero. This
* is used to test the final trailing base-32 digit is zero in the bits
that will be discarded.
+ * </p>
*
* @param emptyBitsMask The mask of the lower bits that should be empty
* @param context the context to be used
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 7e37c6ae..81693426 100644
--- a/src/main/java/org/apache/commons/codec/binary/Base64.java
+++ b/src/main/java/org/apache/commons/codec/binary/Base64.java
@@ -67,9 +67,10 @@ public class Base64 extends BaseNCodec {
/**
* This array is a lookup table that translates 6-bit positive integer
index values into their "Base64 Alphabet"
* equivalents as specified in Table 1 of RFC 2045.
- *
+ * <p>
* Thanks to "commons" project in ws.apache.org for this code.
* http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/
+ * </p>
*/
private static final byte[] STANDARD_ENCODE_TABLE = {
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
@@ -96,12 +97,14 @@ public class Base64 extends BaseNCodec {
* This array is a lookup table that translates Unicode characters drawn
from the "Base64 Alphabet" (as specified
* in Table 1 of RFC 2045) into their 6-bit positive integer equivalents.
Characters that are not in the Base64
* alphabet but fall within the bounds of the array are translated to -1.
- *
+ * <p>
* Note: '+' and '-' both decode to 62. '/' and '_' both decode to 63.
This means decoder seamlessly handles both
* URL_SAFE and STANDARD base64. (The encoder, on the other hand, needs to
know ahead of time what to emit).
- *
+ * </p>
+ * <p>
* Thanks to "commons" project in ws.apache.org for this code.
* http://svn.apache.org/repos/asf/webservices/commons/trunk/modules/util/
+ * </p>
*/
private static final byte[] DECODE_TABLE = {
// 0 1 2 3 4 5 6 7 8 9 A B C D E F
@@ -814,9 +817,10 @@ public class Base64 extends BaseNCodec {
/**
* Validates whether decoding the final trailing character is possible in
the context
* of the set of possible base 64 values.
- *
- * <p>The character is valid if the lower bits within the provided mask
are zero. This
+ * <p>
+ * The character is valid if the lower bits within the provided mask are
zero. This
* is used to test the final trailing base-64 digit is zero in the bits
that will be discarded.
+ * </p>
*
* @param emptyBitsMask The mask of the lower bits that should be empty
* @param context the context to be used
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 50aa44fb..aad7d464 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
@@ -32,10 +32,11 @@ import org.apache.commons.codec.EncoderException;
* <p>
* This class is thread-safe.
* </p>
- *
+ * <p>
* You can set 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.
+ * </p>
* <ul>
* <li>Lenient: Any trailing bits are composed into 8-bit bytes where
possible. The remainder are discarded.
* <li>Strict: The decoding will raise an {@link IllegalArgumentException} if
trailing bits are not part of a valid
@@ -307,17 +308,19 @@ public abstract class BaseNCodec implements
BinaryEncoder, BinaryDecoder {
* are not part of a valid encoding. Any unused bits from the final
character must
* be zero. Impossible counts of entire final characters are not
allowed.
* </ul>
- *
- * <p>When strict decoding is enabled it is expected that the decoded
bytes will be re-encoded
+ * <p>
+ * When strict decoding is enabled it is expected that the decoded bytes
will be re-encoded
* to a byte array that matches the original, i.e. no changes occur on the
final
* character. This requires that the input bytes use the same padding and
alphabet
* as the encoder.
+ * </p>
*/
private final CodecPolicy decodingPolicy;
/**
* Note {@code lineLength} is rounded down to the nearest multiple of the
encoded block size.
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
+ *
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 =
3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
* @param lineLength if > 0, use chunking with a length {@code
lineLength}
@@ -331,6 +334,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Note {@code lineLength} is rounded down to the nearest multiple of the
encoded block size.
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
+ *
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 =
3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
* @param lineLength if > 0, use chunking with a length {@code
lineLength}
@@ -345,6 +349,7 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
/**
* Note {@code lineLength} is rounded down to the nearest multiple of the
encoded block size.
* If {@code chunkSeparatorLength} is zero, then chunking is disabled.
+ *
* @param unencodedBlockSize the size of an unencoded block (e.g. Base64 =
3)
* @param encodedBlockSize the size of an encoded block (e.g. Base64 = 4)
* @param lineLength if > 0, use chunking with a length {@code
lineLength}
@@ -676,7 +681,8 @@ public abstract class BaseNCodec implements BinaryEncoder,
BinaryDecoder {
* Extracts buffered data into the provided byte[] array, starting at
position bPos, up to a maximum of bAvail
* bytes. Returns how many bytes were actually extracted.
* <p>
- * Package protected for access from I/O streams.
+ * Package private for access from I/O streams.
+ * </p>
*
* @param b
* byte[] array to extract the buffered data into.
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 f860b4e8..ac147183 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java
@@ -78,8 +78,10 @@ public class BaseNCodecInputStream extends FilterInputStream
{
* Returns true if decoding behavior is strict. Decoding will raise an
* {@link IllegalArgumentException} if trailing bits are not part of a
valid encoding.
*
- * <p>The default is false for lenient encoding. Decoding will compose
trailing bits
+ * <p>
+ * The default is false for lenient encoding. Decoding will compose
trailing bits
* into 8-bit bytes and discard the remainder.
+ * </p>
*
* @return true if using strict decoding
* @since 1.15
@@ -90,7 +92,9 @@ public class BaseNCodecInputStream extends FilterInputStream {
/**
* Marks the current position in this input stream.
- * <p>The {@link #mark} method of {@link BaseNCodecInputStream} does
nothing.</p>
+ * <p>
+ * 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.
* @see #markSupported()
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 d904c243..7992a774 100644
--- a/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
+++ b/src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java
@@ -133,8 +133,10 @@ public class BaseNCodecOutputStream extends
FilterOutputStream {
* Returns true if decoding behavior is strict. Decoding will raise an
* {@link IllegalArgumentException} if trailing bits are not part of a
valid encoding.
*
- * <p>The default is false for lenient encoding. Decoding will compose
trailing bits
+ * <p>
+ * The default is false for lenient encoding. Decoding will compose
trailing bits
* into 8-bit bytes and discard the remainder.
+ * </p>
*
* @return true if using strict decoding
* @since 1.15
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 c6bd9a27..43e99fb3 100644
--- a/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
@@ -32,8 +32,10 @@ public class CharSequenceUtils {
/**
* Green implementation of regionMatches.
*
- * <p>Note: This function differs from the current implementation in
Apache Commons Lang
+ * <p>
+ * Note: This function differs from the current implementation in Apache
Commons Lang
* where the input indices are not valid. It is only used within this
package.
+ * </p>
*
* @param cs
* the {@code CharSequence} to be processed
