Replace "<code>null</code>" with "{@code null}"

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

Author: garydgregory

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

@@ -34,7 +34,7 @@ public class DecoderException extends Exception {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Constructs a new exception with <code>null</code> as its detail message. The cause is not initialized, and may
+     * Constructs a new exception with {@code null} 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 DecoderException(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</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */
@@ -79,7 +79,7 @@ public DecoderException(String message, 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</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */

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

@@ -35,7 +35,7 @@ public class EncoderException extends Exception {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Constructs a new exception with <code>null</code> as its detail message. The cause is not initialized, and may
+     * Constructs a new exception with {@code null} as its detail message. The cause is not initialized, and may
      * subsequently be initialized by a call to {@link #initCause}.
      * 
      * @since 1.4
@@ -66,7 +66,7 @@ public EncoderException(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</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */
@@ -80,7 +80,7 @@ public EncoderException(String message, 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</code>
+     *            The cause which is saved for later retrieval by the {@link #getCause()} method. A {@code null}
      *            value is permitted, and indicates that the cause is nonexistent or unknown.
      * @since 1.4
      */

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

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

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

@@ -56,8 +56,8 @@ private static byte[] getBytes(String string, Charset charset) {
      * byte array.
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     *            the String to encode, may be {@code null}
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws NullPointerException
      *             Thrown if {@link Charsets#ISO_8859_1} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -79,10 +79,10 @@ public static byte[] getBytesIso8859_1(String string) {
      * </p>
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
+     *            the String to encode, may be {@code null}
      * @param charsetName
      *            The name of a required {@link java.nio.charset.Charset}
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws IllegalStateException
      *             Thrown when a {@link UnsupportedEncodingException} is caught, which should never happen for a
      *             required charset name.
@@ -105,8 +105,8 @@ public static byte[] getBytesUnchecked(String string, String charsetName) {
      * array.
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     *            the String to encode, may be {@code null}
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws NullPointerException
      *             Thrown if {@link Charsets#US_ASCII} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -123,8 +123,8 @@ public static byte[] getBytesUsAscii(String string) {
      * array.
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     *            the String to encode, may be {@code null}
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_16} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -141,8 +141,8 @@ public static byte[] getBytesUtf16(String string) {
      * array.
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     *            the String to encode, may be {@code null}
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_16BE} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -159,8 +159,8 @@ public static byte[] getBytesUtf16Be(String string) {
      * array.
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     *            the String to encode, may be {@code null}
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_16LE} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -177,8 +177,8 @@ public static byte[] getBytesUtf16Le(String string) {
      * array.
      * 
      * @param string
-     *            the String to encode, may be <code>null</code>
-     * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
+     *            the String to encode, may be {@code null}
+     * @return encoded bytes, or {@code null} if the input string was {@code null}
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_8} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -202,7 +202,7 @@ private static IllegalStateException newIllegalStateException(String charsetName
      * @param charset
      *            The {@link Charset} to encode the {@code String}
      * @return A new <code>String</code> decoded from the specified array of bytes using the given charset,
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_8} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -219,11 +219,11 @@ private static String newString(byte[] bytes, Charset charset) {
      * </p>
      * 
      * @param bytes
-     *            The bytes to be decoded into characters, may be <code>null</code>
+     *            The bytes to be decoded into characters, may be {@code null}
      * @param charsetName
      *            The name of a required {@link java.nio.charset.Charset}
      * @return A new <code>String</code> decoded from the specified array of bytes using the given charset,
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws IllegalStateException
      *             Thrown when a {@link UnsupportedEncodingException} is caught, which should never happen for a
      *             required charset name.
@@ -245,9 +245,9 @@ public static String newString(byte[] bytes, String charsetName) {
      * Constructs a new <code>String</code> by decoding the specified array of bytes using the ISO-8859-1 charset.
      * 
      * @param bytes
-     *            The bytes to be decoded into characters, may be <code>null</code>
+     *            The bytes to be decoded into characters, may be {@code null}
      * @return A new <code>String</code> decoded from the specified array of bytes using the ISO-8859-1 charset, or
-     *         <code>null</code> if the input byte array was <code>null</code>.
+     *         {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#ISO_8859_1} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -263,7 +263,7 @@ public static String newStringIso8859_1(byte[] bytes) {
      * @param bytes
      *            The bytes to be decoded into characters
      * @return A new <code>String</code> decoded from the specified array of bytes using the US-ASCII charset,
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#US_ASCII} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -279,7 +279,7 @@ public static String newStringUsAscii(byte[] bytes) {
      * @param bytes
      *            The bytes to be decoded into characters
      * @return A new <code>String</code> decoded from the specified array of bytes using the UTF-16 charset
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_16} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -295,7 +295,7 @@ public static String newStringUtf16(byte[] bytes) {
      * @param bytes
      *            The bytes to be decoded into characters
      * @return A new <code>String</code> decoded from the specified array of bytes using the UTF-16BE charset,
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_16BE} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -311,7 +311,7 @@ public static String newStringUtf16Be(byte[] bytes) {
      * @param bytes
      *            The bytes to be decoded into characters
      * @return A new <code>String</code> decoded from the specified array of bytes using the UTF-16LE charset,
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_16LE} is not initialized, which should never happen since it is
      *             required by the Java platform specification.
@@ -327,7 +327,7 @@ public static String newStringUtf16Le(byte[] bytes) {
      * @param bytes
      *            The bytes to be decoded into characters
      * @return A new <code>String</code> decoded from the specified array of bytes using the UTF-8 charset,
-     *         or <code>null</code> if the input byte array was <code>null</code>.
+     *         or {@code null} if the input byte array was {@code null}.
      * @throws NullPointerException
      *             Thrown if {@link Charsets#UTF_8} is not initialized, which should never happen since it is
      *             required by the Java platform specification.

src/main/java/org/apache/commons/codec/net/RFC1522Codec.java

@@ -127,7 +127,7 @@ protected String encodeText(final String text, final String charsetName)
      * {@link #doEncoding(byte [])} method of a concrete class to perform the specific decoding.
      * 
      * @param text a string to decode
-     * @return A new decoded String or <code>null</code> if the input is <code>null</code>.
+     * @return A new decoded String or {@code null} if the input is {@code null}.
      * 
      * @throws DecoderException thrown if there is an error condition during the decoding 
      *  process.