Javadoc

Author: garydgregory

src/main/java/org/apache/commons/codec/Charsets.java

@@ -151,8 +151,8 @@ public static Charset toCharset(final Charset charset) {
      * 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
-     * @throws java.nio.charset.UnsupportedCharsetException If the named charset is unavailable
+     * @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) {
         return charset == null ? Charset.defaultCharset() : Charset.forName(charset);

src/main/java/org/apache/commons/codec/Decoder.java

@@ -35,8 +35,8 @@ public interface Decoder {
      * {@link ClassCastException} occurs this decode method will throw a DecoderException.
      *
      * @param source
-     *            the object to decode
-     * @return a 'decoded" object
+     *            the object to decode.
+     * @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

src/main/java/org/apache/commons/codec/Encoder.java

@@ -32,8 +32,8 @@ public interface Encoder {
      * {@code byte[]} or {@code String}s depending on the implementation used.
      *
      * @param source
-     *            An object to encode
-     * @return An "encoded" Object
+     *            An object to encode.
+     * @return An "encoded" Object.
      * @throws EncoderException
      *             An encoder exception is thrown if the encoder experiences a failure condition during the encoding
      *             process.

src/main/java/org/apache/commons/codec/StringEncoderComparator.java

@@ -63,9 +63,9 @@ public StringEncoderComparator(final StringEncoder stringEncoder) {
      * If an {@link EncoderException} is encountered, return {@code 0}.
      *
      * @param o1
-     *            the object to compare
+     *            the object to compare.
      * @param o2
-     *            the object to compare to
+     *            the object to compare to.
      * @return the Comparable.compareTo() return code or 0 if an encoding error was caught.
      * @see Comparable
      */

src/main/java/org/apache/commons/codec/binary/Base16.java

@@ -285,7 +285,7 @@ public boolean isInAlphabet(final byte octet) {
     /**
      * Validates whether decoding allows an entire final trailing character that cannot be used for a complete byte.
      *
-     * @throws IllegalArgumentException if strict decoding is enabled
+     * @throws IllegalArgumentException if strict decoding is enabled.
      */
     private void validateTrailingCharacter() {
         if (isStrictDecoding()) {

src/main/java/org/apache/commons/codec/binary/Base32.java

@@ -517,7 +517,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
      * @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) {
@@ -623,7 +623,7 @@ void decode(final byte[] input, int inPos, final int inAvail, final Context cont
      * @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) {
@@ -733,7 +733,7 @@ byte[] getLineSeparator() {
     /**
      * Returns whether or not the {@code octet} is in the Base32 alphabet.
      *
-     * @param octet The value to test
+     * @param octet The value to test.
      * @return {@code true} if the value is defined in the Base32 alphabet {@code false} otherwise.
      */
     @Override
@@ -748,9 +748,9 @@ public boolean isInAlphabet(final byte octet) {
      * that will be discarded.
      * </p>
      *
-     * @param emptyBitsMask The mask of the lower bits that should be empty
-     * @param context       the context to be used
-     * @throws IllegalArgumentException if the bits being checked contain any non-zero value
+     * @param emptyBitsMask The mask of the lower bits that should be empty.
+     * @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) {
         // Use the long bit work area
@@ -763,7 +763,7 @@ private void validateCharacter(final long emptyBitsMask, final Context context)
     /**
      * Validates whether decoding allows final trailing characters that cannot be created during encoding.
      *
-     * @throws IllegalArgumentException if strict decoding is enabled
+     * @throws IllegalArgumentException if strict decoding is enabled.
      */
     private void validateTrailingCharacters() {
         if (isStrictDecoding()) {

src/main/java/org/apache/commons/codec/binary/Base64.java

@@ -497,7 +497,7 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      * Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
      *
      * @param binaryData    Array containing binary data to encode.
-     * @param isChunked     if {@code true} this encoder will chunk the base64 output into 76 character blocks
+     * @param isChunked     if {@code true} this encoder will chunk the base64 output into 76 character blocks.
      * @param urlSafe       if {@code true} this encoder will emit - and _ instead of the usual + and / characters. <strong>No padding is added when encoding
      *                      using the URL-safe alphabet.</strong>
      * @param maxResultSize The maximum result size to accept.
@@ -536,7 +536,7 @@ public static byte[] encodeBase64Chunked(final byte[] binaryData) {
      * <strong> We changed the behavior of this method from multi-line chunking (1.4) to single-line non-chunking (1.5).</strong>
      * </p>
      *
-     * @param binaryData binary data to encode
+     * @param binaryData binary data to encode.
      * @return String containing Base64 characters.
      * @since 1.4 (NOTE: 1.4 chunked the output, whereas 1.5 does not).
      */
@@ -754,8 +754,8 @@ public static boolean isBase64Url(final String base64) {
     /**
      * Returns a byte-array representation of a {@code BigInteger} without sign bit.
      *
-     * @param bigInt {@code BigInteger} to be converted
-     * @return a byte array representation of the BigInteger parameter
+     * @param bigInt {@code BigInteger} to be converted.
+     * @return a byte array representation of the BigInteger parameter.
      */
     static byte[] toIntegerBytes(final BigInteger bigInt) {
         int bitlen = bigInt.bitLength();

src/main/java/org/apache/commons/codec/binary/BaseNCodec.java

@@ -357,9 +357,9 @@ public String toString() {
      * 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
-     * @return the capacity
-     * @throws OutOfMemoryError if the {@code minCapacity} is negative
+     * @param minCapacity the minimum capacity.
+     * @return the capacity.
+     * @throws OutOfMemoryError if the {@code minCapacity} is negative.
      */
     private static int createPositiveCapacity(final int minCapacity) {
         if (minCapacity < 0) {
@@ -380,7 +380,7 @@ private static int createPositiveCapacity(final int minCapacity) {
     /**
      * Gets a copy of the chunk separator per RFC 2045 section 2.1.
      *
-     * @return the chunk separator
+     * @return the chunk separator.
      * @see <a href="https://www.ietf.org/rfc/rfc2045.txt">RFC 2045 section 2.1</a>
      * @since 1.15
      */
@@ -401,8 +401,8 @@ static int getLength(final byte[] array) {
     /**
      * Checks if a byte value is whitespace or not.
      *
-     * @param byteToCheck the byte to check
-     * @return true if byte is whitespace, false otherwise
+     * @param byteToCheck the byte to check.
+     * @return true if byte is whitespace, false otherwise.
      * @see Character#isWhitespace(int)
      * @deprecated Use {@link Character#isWhitespace(int)}.
      */
@@ -414,10 +414,10 @@ protected static boolean isWhiteSpace(final byte byteToCheck) {
     /**
      * Increases our buffer by the {@link #DEFAULT_BUFFER_RESIZE_FACTOR}.
      *
-     * @param context     the context to be used
+     * @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
+     * @return the resized byte[] buffer.
+     * @throws OutOfMemoryError if the {@code minCapacity} is negative.
      */
     private static byte[] resizeBuffer(final Context context, final int minCapacity) {
         // Overflow-conscious code treats the min and new capacity as unsigned.
@@ -732,7 +732,7 @@ public String encodeToString(final byte[] array) {
      *
      * @param size    minimum spare space required.
      * @param context the context to be used.
-     * @return the buffer
+     * @return the buffer.
      */
     protected byte[] ensureBufferSize(final int size, final Context context) {
         if (context.buffer == null) {

src/main/java/org/apache/commons/codec/binary/BaseNCodecInputStream.java

@@ -162,7 +162,7 @@ public synchronized void mark(final int readLimit) {
     /**
      * {@inheritDoc}
      *
-     * @return Always returns {@code false}
+     * @return Always returns {@code false}.
      */
     @Override
     public boolean markSupported() {

src/main/java/org/apache/commons/codec/binary/BaseNCodecOutputStream.java

@@ -112,7 +112,7 @@ protected BaseNCodecOutputStream(final AbstractBuilder<T, C, B> builder) {
      *
      * @param outputStream the underlying output or null.
      * @param basedCodec   a BaseNCodec.
-     * @param doEncode     true to encode, false to decode, TODO should be an enum?
+     * @param doEncode     true to encode, false to decode, TODO should be an enum?.
      */
     public BaseNCodecOutputStream(final OutputStream outputStream, final C basedCodec, final boolean doEncode) {
         super(outputStream);