You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2014/08/23 00:53:56 UTC
svn commit: r1619948 - in /commons/proper/codec/trunk/src:
main/java/org/apache/commons/codec/
main/java/org/apache/commons/codec/binary/
main/java/org/apache/commons/codec/digest/
main/java/org/apache/commons/codec/language/ main/java/org/apache/commo...
Author: ggregory
Date: Fri Aug 22 22:53:55 2014
New Revision: 1619948
URL: http://svn.apache.org/r1619948
Log:
Javadoc 8.
Modified:
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/EncoderException.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java
commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
commons/proper/codec/trunk/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/DecoderException.java Fri Aug 22 22:53:55 2014
@@ -33,7 +33,7 @@ public class DecoderException extends Ex
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 class DecoderException extends Ex
* @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 class DecoderException extends Ex
* 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
*/
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/EncoderException.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/EncoderException.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/EncoderException.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/EncoderException.java Fri Aug 22 22:53:55 2014
@@ -34,7 +34,7 @@ public class EncoderException extends Ex
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 class EncoderException extends Ex
* @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 class EncoderException extends Ex
* 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
*/
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base32.java Fri Aug 22 22:53:55 2014
@@ -175,7 +175,7 @@ public class Base32 extends BaseNCodec {
* <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 class Base32 extends BaseNCodec {
* <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 class Base32 extends BaseNCodec {
* @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 > 0 and lineSeparator is null.
@@ -271,7 +271,7 @@ public class Base32 extends BaseNCodec {
* @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 @@ public class Base32 extends BaseNCodec {
*
* @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) {
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Base64.java Fri Aug 22 22:53:55 2014
@@ -182,7 +182,7 @@ public class Base64 extends BaseNCodec {
* </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 @@ public class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
*
* @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 class Base64 extends BaseNCodec {
* @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 class Base64 extends BaseNCodec {
* @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 class Base64 extends BaseNCodec {
* @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 @@ public class Base64 extends BaseNCodec {
*
* @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) {
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BaseNCodec.java Fri Aug 22 22:53:55 2014
@@ -445,7 +445,7 @@ public abstract class BaseNCodec impleme
*
* @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 abstract class BaseNCodec impleme
* 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 abstract class BaseNCodec impleme
* 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 abstract class BaseNCodec impleme
*
* @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) {
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/BinaryCodec.java Fri Aug 22 22:53:55 2014
@@ -216,11 +216,11 @@ public class BinaryCodec implements Bina
}
/**
- * 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;
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/CharSequenceUtils.java Fri Aug 22 22:53:55 2014
@@ -18,7 +18,7 @@ package org.apache.commons.codec.binary;
/**
* <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
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/Hex.java Fri Aug 22 22:53:55 2014
@@ -117,7 +117,7 @@ public class Hex implements BinaryEncode
* @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
*/
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/binary/StringUtils.java Fri Aug 22 22:53:55 2014
@@ -39,11 +39,11 @@ public class StringUtils {
/**
* <p>
- * Compares two CharSequences, returning {@code true} if they represent equal sequences of characters.
+ * Compares two CharSequences, returning <code>true</code> if they represent equal sequences of characters.
* </p>
*
* <p>
- * {@code null}s are handled without exceptions. Two {@code null} references are considered to be equal. The
+ * <code>null</code>s are handled without exceptions. Two <code>null</code> references are considered to be equal. The
* comparison is case sensitive.
* </p>
*
@@ -61,10 +61,10 @@ public class StringUtils {
*
* @see Object#equals(Object)
* @param cs1
- * the first CharSequence, may be {@code null}
+ * the first CharSequence, may be <code>null</code>
* @param cs2
- * the second CharSequence, may be {@code null}
- * @return {@code true} if the CharSequences are equal (case-sensitive), or both {@code null}
+ * the second CharSequence, may be <code>null</code>
+ * @return <code>true</code> if the CharSequences are equal (case-sensitive), or both <code>null</code>
* @since 1.10
*/
public static boolean equals(final CharSequence cs1, final CharSequence cs2) {
@@ -86,7 +86,7 @@ public class StringUtils {
* @param string
* The string to encode (if null, return null).
* @param charset
- * The {@link Charset} to encode the {@code String}
+ * The {@link Charset} to encode the <code>String</code>
* @return the encoded bytes
*/
private static byte[] getBytes(final String string, final Charset charset) {
@@ -101,8 +101,8 @@ public class StringUtils {
* byte array.
*
* @param string
- * the String to encode, may be {@code null}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * the String to encode, may be <code>null</code>
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @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.
@@ -124,10 +124,10 @@ public class StringUtils {
* </p>
*
* @param string
- * the String to encode, may be {@code null}
+ * the String to encode, may be <code>null</code>
* @param charsetName
* The name of a required {@link java.nio.charset.Charset}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @throws IllegalStateException
* Thrown when a {@link UnsupportedEncodingException} is caught, which should never happen for a
* required charset name.
@@ -150,8 +150,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be {@code null}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * the String to encode, may be <code>null</code>
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @throws NullPointerException
* Thrown if {@link Charsets#US_ASCII} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -168,8 +168,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be {@code null}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * the String to encode, may be <code>null</code>
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -186,8 +186,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be {@code null}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * the String to encode, may be <code>null</code>
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16BE} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -204,8 +204,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be {@code null}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * the String to encode, may be <code>null</code>
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16LE} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -222,8 +222,8 @@ public class StringUtils {
* array.
*
* @param string
- * the String to encode, may be {@code null}
- * @return encoded bytes, or {@code null} if the input string was {@code null}
+ * the String to encode, may be <code>null</code>
+ * @return encoded bytes, or <code>null</code> if the input string was <code>null</code>
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_8} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -246,9 +246,9 @@ public class StringUtils {
* @param bytes
* The bytes to be decoded into characters
* @param charset
- * The {@link Charset} to encode the {@code String}
+ * The {@link Charset} to encode the <code>String</code>
* @return A new <code>String</code> decoded from the specified array of bytes using the given charset,
- * or {@code null} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_8} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -265,11 +265,11 @@ public class StringUtils {
* </p>
*
* @param bytes
- * The bytes to be decoded into characters, may be {@code null}
+ * The bytes to be decoded into characters, may be <code>null</code>
* @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} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws IllegalStateException
* Thrown when a {@link UnsupportedEncodingException} is caught, which should never happen for a
* required charset name.
@@ -291,9 +291,9 @@ public class StringUtils {
* 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}
+ * The bytes to be decoded into characters, may be <code>null</code>
* @return A new <code>String</code> decoded from the specified array of bytes using the ISO-8859-1 charset, or
- * {@code null} if the input byte array was {@code null}.
+ * <code>null</code> if the input byte array was <code>null</code>.
* @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.
@@ -309,7 +309,7 @@ public class StringUtils {
* @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} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws NullPointerException
* Thrown if {@link Charsets#US_ASCII} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -325,7 +325,7 @@ public class StringUtils {
* @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} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -341,7 +341,7 @@ public class StringUtils {
* @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} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16BE} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -357,7 +357,7 @@ public class StringUtils {
* @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} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_16LE} is not initialized, which should never happen since it is
* required by the Java platform specification.
@@ -373,7 +373,7 @@ public class StringUtils {
* @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} if the input byte array was {@code null}.
+ * or <code>null</code> if the input byte array was <code>null</code>.
* @throws NullPointerException
* Thrown if {@link Charsets#UTF_8} is not initialized, which should never happen since it is
* required by the Java platform specification.
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/digest/Sha2Crypt.java Fri Aug 22 22:53:55 2014
@@ -125,7 +125,7 @@ public class Sha2Crypt {
* {@link MessageDigest} algorithm identifier string
* @return complete hash value including prefix and salt
* @throws IllegalArgumentException
- * if the given salt is {@code null} or does not match the allowed pattern
+ * if the given salt is <code>null</code> or does not match the allowed pattern
* @throws IllegalArgumentException
* when a {@link NoSuchAlgorithmException} is caught
* @see MessageDigestAlgorithms
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/AbstractCaverphone.java Fri Aug 22 22:53:55 2014
@@ -69,7 +69,7 @@ public abstract class AbstractCaverphone
* First of two strings to compare
* @param str2
* Second of two strings to compare
- * @return {@code true} if the encodings of these strings are identical, {@code false} otherwise.
+ * @return <code>true</code> if the encodings of these strings are identical, <code>false</code> otherwise.
* @throws EncoderException
*/
public boolean isEncodeEqual(final String str1, final String str2) throws EncoderException {
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Caverphone.java Fri Aug 22 22:53:55 2014
@@ -96,7 +96,7 @@ public class Caverphone implements Strin
* First of two strings to compare
* @param str2
* Second of two strings to compare
- * @return {@code true} if the caverphones of these strings are identical, {@code false} otherwise.
+ * @return <code>true</code> if the caverphones of these strings are identical, <code>false</code> otherwise.
*/
public boolean isCaverphoneEqual(final String str1, final String str2) {
return this.caverphone(str1).equals(this.caverphone(str2));
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/ColognePhonetic.java Fri Aug 22 22:53:55 2014
@@ -150,7 +150,7 @@ import org.apache.commons.codec.StringEn
*
* <h4>Example:</h4>
*
- * {@code "M}ü{@code ller-L}ü{@code denscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"}
+ * <code>"M</code>ü<code>ller-L</code>ü<code>denscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"</code>
*
* </li>
*
@@ -158,7 +158,7 @@ import org.apache.commons.codec.StringEn
* <h3>Step 2:</h3>
* Collapse of all multiple consecutive code digits.
* <h4>Example:</h4>
- * {@code "6005507500206880022" => "6050750206802"}</li>
+ * <code>"6005507500206880022" => "6050750206802"</code></li>
*
* <li>
* <h3>Step 3:</h3>
@@ -166,7 +166,7 @@ import org.apache.commons.codec.StringEn
* if they occur after removing the "0" digits.
*
* <h4>Example:</h4>
- * {@code "6050750206802" => "65752682"}</li>
+ * <code>"6050750206802" => "65752682"</code></li>
*
* </ul>
*
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/DoubleMetaphone.java Fri Aug 22 22:53:55 2014
@@ -223,8 +223,8 @@ public class DoubleMetaphone implements
*
* @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
* @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
- * @return {@code true} if the encoded <code>String</code>s are equal;
- * {@code false} otherwise.
+ * @return <code>true</code> if the encoded <code>String</code>s are equal;
+ * <code>false</code> otherwise.
* @see #isDoubleMetaphoneEqual(String,String,boolean)
*/
public boolean isDoubleMetaphoneEqual(final String value1, final String value2) {
@@ -237,9 +237,9 @@ public class DoubleMetaphone implements
*
* @param value1 The left-hand side of the encoded {@link String#equals(Object)}.
* @param value2 The right-hand side of the encoded {@link String#equals(Object)}.
- * @param alternate use the alternate value if {@code true}.
- * @return {@code true} if the encoded <code>String</code>s are equal;
- * {@code false} otherwise.
+ * @param alternate use the alternate value if <code>true</code>.
+ * @return <code>true</code> if the encoded <code>String</code>s are equal;
+ * <code>false</code> otherwise.
*/
public boolean isDoubleMetaphoneEqual(final String value1, final String value2, final boolean alternate) {
return StringUtils.equals(doubleMetaphone(value1, alternate), doubleMetaphone(value2, alternate));
@@ -868,7 +868,7 @@ public class DoubleMetaphone implements
/**
* Determines whether or not the value starts with a silent letter. It will
- * return {@code true} if the value starts with any of 'GN', 'KN',
+ * return <code>true</code> if the value starts with any of 'GN', 'KN',
* 'PN', 'WR' or 'PS'.
*/
private boolean isSilentStart(final String value) {
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Metaphone.java Fri Aug 22 22:53:55 2014
@@ -408,8 +408,8 @@ public class Metaphone implements String
*
* @param str1 First of two strings to compare
* @param str2 Second of two strings to compare
- * @return {@code true} if the metaphones of these strings are identical,
- * {@code false} otherwise.
+ * @return <code>true</code> if the metaphones of these strings are identical,
+ * <code>false</code> otherwise.
*/
public boolean isMetaphoneEqual(final String str1, final String str2) {
return metaphone(str1).equals(metaphone(str2));
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/Nysiis.java Fri Aug 22 22:53:55 2014
@@ -95,7 +95,7 @@ public class Nysiis implements StringEnc
*
* @param c
* the character to test
- * @return {@code true} if the character is a vowel, {@code false} otherwise
+ * @return <code>true</code> if the character is a vowel, <code>false</code> otherwise
*/
private static boolean isVowel(final char c) {
return c == 'A' || c == 'E' || c == 'I' || c == 'O' || c == 'U';
@@ -182,8 +182,8 @@ public class Nysiis implements StringEnc
* Create an instance of the {@link Nysiis} encoder with the specified strict mode:
*
* <ul>
- * <li>{@code true}: encoded strings have a maximum length of 6</li>
- * <li>{@code false}: encoded strings may have arbitrary length</li>
+ * <li><code>true</code>: encoded strings have a maximum length of 6</li>
+ * <li><code>false</code>: encoded strings may have arbitrary length</li>
* </ul>
*
* @param strict
@@ -231,7 +231,7 @@ public class Nysiis implements StringEnc
/**
* Indicates the strict mode for this {@link Nysiis} encoder.
*
- * @return {@code true} if the encoder is configured for strict mode, {@code false} otherwise
+ * @return <code>true</code> if the encoder is configured for strict mode, <code>false</code> otherwise
*/
public boolean isStrict() {
return this.strict;
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/language/bm/BeiderMorseEncoder.java Fri Aug 22 22:53:55 2014
@@ -56,7 +56,7 @@ import org.apache.commons.codec.StringEn
* If multiple hyphenated words where found, or if the word may contain a name prefix, each encoded word is placed
* in elipses and these blocks are then joined with hyphens. For example, "<code>d'ortley</code>" has a possible
* prefix. The form without prefix encodes to "<code>ortlaj|ortlej</code>", while the form with prefix encodes to
- * "<code>dortlaj|dortlej</code>". Thus, the full, combined encoding is "{@code (ortlaj|ortlej)-(dortlaj|dortlej)}".
+ * "<code>dortlaj|dortlej</code>". Thus, the full, combined encoding is "<code>(ortlaj|ortlej)-(dortlaj|dortlej)</code>".
* <p>
* The encoded forms are often quite a bit longer than the input strings. This is because a single input may have many
* potential phonetic interpretations. For example, "<code>Renault</code>" encodes to
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/QCodec.java Fri Aug 22 22:53:55 2014
@@ -340,7 +340,7 @@ public class QCodec extends RFC1522Codec
/**
* Tests if optional transformation of SPACE characters is to be used
*
- * @return {@code true} if SPACE characters are to be transformed, {@code false} otherwise
+ * @return <code>true</code> if SPACE characters are to be transformed, <code>false</code> otherwise
*/
public boolean isEncodeBlanks() {
return this.encodeBlanks;
@@ -350,7 +350,7 @@ public class QCodec extends RFC1522Codec
* Defines whether optional transformation of SPACE characters is to be used
*
* @param b
- * {@code true} if SPACE characters are to be transformed, {@code false} otherwise
+ * <code>true</code> if SPACE characters are to be transformed, <code>false</code> otherwise
*/
public void setEncodeBlanks(final boolean b) {
this.encodeBlanks = b;
Modified: commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java (original)
+++ commons/proper/codec/trunk/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java Fri Aug 22 22:53:55 2014
@@ -115,7 +115,7 @@ abstract class RFC1522Codec {
*
* @param text
* a string to decode
- * @return A new decoded String or {@code null} if the input is {@code null}.
+ * @return A new decoded String or <code>null</code> if the input is <code>null</code>.
* @throws DecoderException
* thrown if there is an error condition during the decoding process.
* @throws UnsupportedEncodingException
Modified: commons/proper/codec/trunk/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java
URL: http://svn.apache.org/viewvc/commons/proper/codec/trunk/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java?rev=1619948&r1=1619947&r2=1619948&view=diff
==============================================================================
--- commons/proper/codec/trunk/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java (original)
+++ commons/proper/codec/trunk/src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java Fri Aug 22 22:53:55 2014
@@ -22,7 +22,7 @@ import org.apache.commons.codec.StringEn
import org.junit.Test;
/**
- * Tests the {@code ColognePhonetic} class.
+ * Tests the <code>ColognePhonetic</code> class.
*
* <p>Keep this file in UTF-8 encoding for proper Javadoc processing.</p>
*