Javadoc 8.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1619948 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

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

@@ -33,7 +33,7 @@ public class DecoderException extends Exception {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may
+     * Constructs a new exception with <code>null</code> as its detail message. The cause is not initialized, and may
      * subsequently be initialized by a call to {@link #initCause}.
      *
      * @since 1.4
@@ -62,7 +62,7 @@ public DecoderException(final String message) {
      * @param message
      *            The detail message which is saved for later retrieval by the {@link #getMessage()} method.
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */
@@ -76,7 +76,7 @@ public DecoderException(final String message, final Throwable cause) {
      * This constructor is useful for exceptions that are little more than wrappers for other throwables.
      *
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */

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

@@ -34,7 +34,7 @@ public class EncoderException extends Exception {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may
+     * Constructs a new exception with <code>null</code> as its detail message. The cause is not initialized, and may
      * subsequently be initialized by a call to {@link #initCause}.
      *
      * @since 1.4
@@ -65,7 +65,7 @@ public EncoderException(final String message) {
      * @param message
      *            The detail message which is saved for later retrieval by the {@link #getMessage()} method.
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */
@@ -79,7 +79,7 @@ public EncoderException(final String message, final Throwable cause) {
      * This constructor is useful for exceptions that are little more than wrappers for other throwables.
      *
      * @param cause
-     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A <code>null</code>
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */

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

@@ -175,7 +175,7 @@ public Base32(final byte pad) {
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
-     * @param useHex if {@code true} then use Base32 Hex alphabet
+     * @param useHex if <code>true</code> then use Base32 Hex alphabet
      */
     public Base32(final boolean useHex) {
         this(0, null, useHex, PAD_DEFAULT);
@@ -186,7 +186,7 @@ public Base32(final boolean useHex) {
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
-     * @param useHex if {@code true} then use Base32 Hex alphabet
+     * @param useHex if <code>true</code> then use Base32 Hex alphabet
      * @param pad byte used as padding byte.
      */
     public Base32(final boolean useHex, final byte pad) {
@@ -246,7 +246,7 @@ public Base32(final int lineLength, final byte[] lineSeparator) {
      * @param lineSeparator
      *            Each line of encoded data will end with this sequence of bytes.
      * @param useHex
-     *            if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
+     *            if <code>true</code>, then use Base32 Hex alphabet, otherwise use Base32 alphabet
      * @throws IllegalArgumentException
      *             The provided lineSeparator included some Base32 characters. That's not going to work! Or the
      *             lineLength &gt; 0 and lineSeparator is null.
@@ -271,7 +271,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
      * @param lineSeparator
      *            Each line of encoded data will end with this sequence of bytes.
      * @param useHex
-     *            if {@code true}, then use Base32 Hex alphabet, otherwise use Base32 alphabet
+     *            if <code>true</code>, then use Base32 Hex alphabet, otherwise use Base32 alphabet
      * @param pad byte used as padding byte.
      * @throws IllegalArgumentException
      *             The provided lineSeparator included some Base32 characters. That's not going to work! Or the
@@ -530,7 +530,7 @@ void encode(final byte[] in, int inPos, final int inAvail, final Context context
      *
      * @param octet
      *            The value to test
-     * @return {@code true} if the value is defined in the the Base32 alphabet {@code false} otherwise.
+     * @return <code>true</code> if the value is defined in the the Base32 alphabet <code>false</code> otherwise.
      */
     @Override
     public boolean isInAlphabet(final byte octet) {

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

@@ -182,7 +182,7 @@ public Base64() {
      * </p>
      *
      * @param urlSafe
-     *            if {@code true}, URL-safe encoding is used. In most cases this should be set to {@code false}.
+     *            if <code>true</code>, URL-safe encoding is used. In most cases this should be set to <code>false</code>.
      * @since 1.4
      */
     public Base64(final boolean urlSafe) {
@@ -486,8 +486,8 @@ void decode(final byte[] in, int inPos, final int inAvail, final Context context
      *
      * @param arrayOctet
      *            byte array to test
-     * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
-     *         {@code false}, otherwise
+     * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
+     *         <code>false</code>, otherwise
      * @deprecated 1.5 Use {@link #isBase64(byte[])}, will be removed in 2.0.
      */
     @Deprecated
@@ -500,7 +500,7 @@ public static boolean isArrayByteBase64(final byte[] arrayOctet) {
      *
      * @param octet
      *            The value to test
-     * @return {@code true} if the value is defined in the the base 64 alphabet, {@code false} otherwise.
+     * @return <code>true</code> if the value is defined in the the base 64 alphabet, <code>false</code> otherwise.
      * @since 1.4
      */
     public static boolean isBase64(final byte octet) {
@@ -513,8 +513,8 @@ public static boolean isBase64(final byte octet) {
      *
      * @param base64
      *            String to test
-     * @return {@code true} if all characters in the String are valid characters in the Base64 alphabet or if
-     *         the String is empty; {@code false}, otherwise
+     * @return <code>true</code> if all characters in the String are valid characters in the Base64 alphabet or if
+     *         the String is empty; <code>false</code>, otherwise
      *  @since 1.5
      */
     public static boolean isBase64(final String base64) {
@@ -527,8 +527,8 @@ public static boolean isBase64(final String base64) {
      *
      * @param arrayOctet
      *            byte array to test
-     * @return {@code true} if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
-     *         {@code false}, otherwise
+     * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
+     *         <code>false</code>, otherwise
      * @since 1.5
      */
     public static boolean isBase64(final byte[] arrayOctet) {
@@ -609,7 +609,7 @@ public static byte[] encodeBase64Chunked(final byte[] binaryData) {
      * @param binaryData
      *            Array containing binary data to encode.
      * @param isChunked
-     *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
+     *            if <code>true</code> this encoder will chunk the base64 output into 76 character blocks
      * @return Base64-encoded data.
      * @throws IllegalArgumentException
      *             Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE}
@@ -624,9 +624,9 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      * @param binaryData
      *            Array containing binary data to encode.
      * @param isChunked
-     *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
+     *            if <code>true</code> 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.
+     *            if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.
      *            <b>Note: no padding is added when encoding using the URL-safe alphabet.</b>
      * @return Base64-encoded data.
      * @throws IllegalArgumentException
@@ -643,9 +643,9 @@ public static byte[] encodeBase64(final byte[] binaryData, final boolean isChunk
      * @param binaryData
      *            Array containing binary data to encode.
      * @param isChunked
-     *            if {@code true} this encoder will chunk the base64 output into 76 character blocks
+     *            if <code>true</code> 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.
+     *            if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.
      *            <b>Note: no padding is added when encoding using the URL-safe alphabet.</b>
      * @param maxResultSize
      *            The maximum result size to accept.
@@ -765,7 +765,7 @@ static byte[] toIntegerBytes(final BigInteger bigInt) {
      *
      * @param octet
      *            The value to test
-     * @return {@code true} if the value is defined in the the Base64 alphabet {@code false} otherwise.
+     * @return <code>true</code> if the value is defined in the the Base64 alphabet <code>false</code> otherwise.
      */
     @Override
     protected boolean isInAlphabet(final byte octet) {

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

@@ -445,7 +445,7 @@ public byte[] encode(final byte[] pArray) {
      *
      * @param value The value to test
      *
-     * @return {@code true} if the value is defined in the current alphabet, {@code false} otherwise.
+     * @return <code>true</code> if the value is defined in the current alphabet, <code>false</code> otherwise.
      */
     protected abstract boolean isInAlphabet(byte value);
 
@@ -454,10 +454,10 @@ public byte[] encode(final byte[] pArray) {
      * The method optionally treats whitespace and pad as valid.
      *
      * @param arrayOctet byte array to test
-     * @param allowWSPad if {@code true}, then whitespace and PAD are also allowed
+     * @param allowWSPad if <code>true</code>, then whitespace and PAD are also allowed
      *
-     * @return {@code true} if all bytes are valid characters in the alphabet or if the byte array is empty;
-     *         {@code false}, otherwise
+     * @return <code>true</code> if all bytes are valid characters in the alphabet or if the byte array is empty;
+     *         <code>false</code>, otherwise
      */
     public boolean isInAlphabet(final byte[] arrayOctet, final boolean allowWSPad) {
         for (int i = 0; i < arrayOctet.length; i++) {
@@ -474,8 +474,8 @@ public boolean isInAlphabet(final byte[] arrayOctet, final boolean allowWSPad) {
      * The method treats whitespace and PAD as valid.
      *
      * @param basen String to test
-     * @return {@code true} if all characters in the String are valid characters in the alphabet or if
-     *         the String is empty; {@code false}, otherwise
+     * @return <code>true</code> if all characters in the String are valid characters in the alphabet or if
+     *         the String is empty; <code>false</code>, otherwise
      * @see #isInAlphabet(byte[], boolean)
      */
     public boolean isInAlphabet(final String basen) {
@@ -489,7 +489,7 @@ public boolean isInAlphabet(final String basen) {
      *
      * @param arrayOctet
      *            byte array to test
-     * @return {@code true} if any byte is a valid character in the alphabet or PAD; {@code false} otherwise
+     * @return <code>true</code> if any byte is a valid character in the alphabet or PAD; <code>false</code> otherwise
      */
     protected boolean containsAlphabetOrPad(final byte[] arrayOctet) {
         if (arrayOctet == null) {

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

@@ -216,11 +216,11 @@ public static byte[] fromAscii(final byte[] ascii) {
     }
 
     /**
-     * Returns {@code true} if the given array is {@code null} or empty (size 0.)
+     * Returns <code>true</code> if the given array is <code>null</code> or empty (size 0.)
      *
      * @param array
      *            the source array
-     * @return {@code true} if the given array is {@code null} or empty (size 0.)
+     * @return <code>true</code> if the given array is <code>null</code> or empty (size 0.)
      */
     private static boolean isEmpty(final byte[] array) {
         return array == null || array.length == 0;

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

@@ -18,7 +18,7 @@
 
 /**
  * <p>
- * Operations on {@link CharSequence} that are {@code null} safe.
+ * Operations on {@link CharSequence} that are <code>null</code> safe.
  * </p>
  * <p>
  * Copied from Apache Commons Lang r1586295 on April 10, 2014 (day of 3.3.2 release).
@@ -33,15 +33,15 @@ public class CharSequenceUtils {
      * Green implementation of regionMatches.
      * 
      * @param cs
-     *            the {@code CharSequence} to be processed
+     *            the <code>CharSequence</code> to be processed
      * @param ignoreCase
      *            whether or not to be case insensitive
      * @param thisStart
-     *            the index to start on the {@code cs} CharSequence
+     *            the index to start on the <code>cs</code> CharSequence
      * @param substring
-     *            the {@code CharSequence} to be looked for
+     *            the <code>CharSequence</code> to be looked for
      * @param start
-     *            the index to start on the {@code substring} CharSequence
+     *            the index to start on the <code>substring</code> CharSequence
      * @param length
      *            character length of the region
      * @return whether the region matched

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

@@ -117,7 +117,7 @@ public static char[] encodeHex(final byte[] data) {
      * @param data
      *            a byte[] to convert to Hex characters
      * @param toLowerCase
-     *            {@code true} converts to lowercase, {@code false} to uppercase
+     *            <code>true</code> converts to lowercase, <code>false</code> to uppercase
      * @return A char[] containing hexadecimal characters
      * @since 1.4
      */