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
commit d3877a3f0f017af6d64dabd26fc38ec1bf185531 Author: Gary Gregory <[email protected]> AuthorDate: Sun Jun 4 12:29:47 2023 -0400 Better Javadoc @see --- .../java/org/apache/commons/codec/CharEncoding.java | 14 +++++++------- .../org/apache/commons/codec/binary/StringUtils.java | 20 ++++++++++---------- .../java/org/apache/commons/codec/net/BCodec.java | 6 +++--- .../java/org/apache/commons/codec/net/QCodec.java | 4 ++-- .../org/apache/commons/codec/net/RFC1522Codec.java | 2 +- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/src/main/java/org/apache/commons/codec/CharEncoding.java b/src/main/java/org/apache/commons/codec/CharEncoding.java index f82a7282..62e147fe 100644 --- a/src/main/java/org/apache/commons/codec/CharEncoding.java +++ b/src/main/java/org/apache/commons/codec/CharEncoding.java @@ -51,7 +51,7 @@ package org.apache.commons.codec; * This class is immutable and thread-safe. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @since 1.4 */ public class CharEncoding { @@ -62,7 +62,7 @@ public class CharEncoding { * Every implementation of the Java platform is required to support this character encoding. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public static final String ISO_8859_1 = "ISO-8859-1"; @@ -72,7 +72,7 @@ public class CharEncoding { * Every implementation of the Java platform is required to support this character encoding. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public static final String US_ASCII = "US-ASCII"; @@ -83,7 +83,7 @@ public class CharEncoding { * Every implementation of the Java platform is required to support this character encoding. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public static final String UTF_16 = "UTF-16"; @@ -93,7 +93,7 @@ public class CharEncoding { * Every implementation of the Java platform is required to support this character encoding. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public static final String UTF_16BE = "UTF-16BE"; @@ -103,7 +103,7 @@ public class CharEncoding { * Every implementation of the Java platform is required to support this character encoding. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public static final String UTF_16LE = "UTF-16LE"; @@ -113,7 +113,7 @@ public class CharEncoding { * Every implementation of the Java platform is required to support this character encoding. * </p> * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public static final String UTF_8 = "UTF-8"; } diff --git a/src/main/java/org/apache/commons/codec/binary/StringUtils.java b/src/main/java/org/apache/commons/codec/binary/StringUtils.java index c0e017f4..5ca7eb5d 100644 --- a/src/main/java/org/apache/commons/codec/binary/StringUtils.java +++ b/src/main/java/org/apache/commons/codec/binary/StringUtils.java @@ -26,13 +26,13 @@ import org.apache.commons.codec.CharEncoding; /** * Converts String to and from bytes using the encodings required by the Java specification. These encodings are - * specified in <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";> - * Standard charsets</a>. + * specified in standard {@link Charset}. * * <p>This class is immutable and thread-safe.</p> * * @see CharEncoding - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset + * @see StandardCharsets * @since 1.4 */ public class StringUtils { @@ -106,7 +106,7 @@ public class StringUtils { * @throws NullPointerException * Thrown if {@link StandardCharsets#UTF_8} is not initialized, which should never happen since it is * required by the Java platform specification. - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) * @since 1.11 */ @@ -138,7 +138,7 @@ public class StringUtils { * Thrown if {@link StandardCharsets#ISO_8859_1} is not initialized, which should never happen * since it is required by the Java platform specification. * @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) */ public static byte[] getBytesIso8859_1(final String string) { @@ -187,7 +187,7 @@ public class StringUtils { * Thrown if {@link StandardCharsets#US_ASCII} is not initialized, which should never happen since it is * required by the Java platform specification. * @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) */ public static byte[] getBytesUsAscii(final String string) { @@ -205,7 +205,7 @@ public class StringUtils { * Thrown if {@link StandardCharsets#UTF_16} is not initialized, which should never happen since it is * required by the Java platform specification. * @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) */ public static byte[] getBytesUtf16(final String string) { @@ -223,7 +223,7 @@ public class StringUtils { * Thrown if {@link StandardCharsets#UTF_16BE} is not initialized, which should never happen since it is * required by the Java platform specification. * @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) */ public static byte[] getBytesUtf16Be(final String string) { @@ -241,7 +241,7 @@ public class StringUtils { * Thrown if {@link StandardCharsets#UTF_16LE} is not initialized, which should never happen since it is * required by the Java platform specification. * @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) */ public static byte[] getBytesUtf16Le(final String string) { @@ -259,7 +259,7 @@ public class StringUtils { * Thrown if {@link StandardCharsets#UTF_8} is not initialized, which should never happen since it is * required by the Java platform specification. * @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @see #getBytesUnchecked(String, String) */ public static byte[] getBytesUtf8(final String string) { diff --git a/src/main/java/org/apache/commons/codec/net/BCodec.java b/src/main/java/org/apache/commons/codec/net/BCodec.java index 6da4600b..943f2ea8 100644 --- a/src/main/java/org/apache/commons/codec/net/BCodec.java +++ b/src/main/java/org/apache/commons/codec/net/BCodec.java @@ -77,7 +77,7 @@ public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder * @param charset * the default string Charset to use. * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @since 1.7 */ public BCodec(final Charset charset) { @@ -91,7 +91,7 @@ public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder * the default string Charset to use. * @param decodingPolicy The decoding policy. * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @since 1.15 */ public BCodec(final Charset charset, final CodecPolicy decodingPolicy) { @@ -107,7 +107,7 @@ public class BCodec extends RFC1522Codec implements StringEncoder, StringDecoder * @throws java.nio.charset.UnsupportedCharsetException * If the named Charset is unavailable * @since 1.7 throws UnsupportedCharsetException if the named Charset is unavailable - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public BCodec(final String charsetName) { this(Charset.forName(charsetName)); diff --git a/src/main/java/org/apache/commons/codec/net/QCodec.java b/src/main/java/org/apache/commons/codec/net/QCodec.java index 5a6745f2..6717cf78 100644 --- a/src/main/java/org/apache/commons/codec/net/QCodec.java +++ b/src/main/java/org/apache/commons/codec/net/QCodec.java @@ -123,7 +123,7 @@ public class QCodec extends RFC1522Codec implements StringEncoder, StringDecoder * @param charset * the default string Charset to use. * - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset * @since 1.7 */ public QCodec(final Charset charset) { @@ -138,7 +138,7 @@ public class QCodec extends RFC1522Codec implements StringEncoder, StringDecoder * @throws java.nio.charset.UnsupportedCharsetException * If the named Charset is unavailable * @since 1.7 throws UnsupportedCharsetException if the named Charset is unavailable - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ public QCodec(final String charsetName) { this(Charset.forName(charsetName)); diff --git a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java index a607ce65..2a16aa38 100644 --- a/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java +++ b/src/main/java/org/apache/commons/codec/net/RFC1522Codec.java @@ -65,7 +65,7 @@ abstract class RFC1522Codec { * @return RFC 1522 compliant "encoded-word" * @throws EncoderException * thrown if there is an error condition during the Encoding process. - * @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html";>Standard charsets</a> + * @see Charset */ protected String encodeText(final String text, final Charset charset) throws EncoderException { if (text == null) {
