Skip to content

Commit d3877a3

Browse files
garydgregorygarydgregory
committed
Better Javadoc @see 
1 parent 110e803 commit d3877a3

5 files changed

Lines changed: 23 additions & 23 deletions

File tree

‎src/main/java/org/apache/commons/codec/CharEncoding.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
* This class is immutable and thread-safe.
5252
* </p>
5353
*
54-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
54+
* @see Charset
5555
* @since 1.4
5656
*/
5757
public class CharEncoding {
@@ -62,7 +62,7 @@ public class CharEncoding {
6262
* Every implementation of the Java platform is required to support this character encoding.
6363
* </p>
6464
*
65-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
65+
* @see Charset
6666
*/
6767
public static final String ISO_8859_1 = "ISO-8859-1";
6868

@@ -72,7 +72,7 @@ public class CharEncoding {
7272
* Every implementation of the Java platform is required to support this character encoding.
7373
* </p>
7474
*
75-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
75+
* @see Charset
7676
*/
7777
public static final String US_ASCII = "US-ASCII";
7878

@@ -83,7 +83,7 @@ public class CharEncoding {
8383
* Every implementation of the Java platform is required to support this character encoding.
8484
* </p>
8585
*
86-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
86+
* @see Charset
8787
*/
8888
public static final String UTF_16 = "UTF-16";
8989

@@ -93,7 +93,7 @@ public class CharEncoding {
9393
* Every implementation of the Java platform is required to support this character encoding.
9494
* </p>
9595
*
96-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
96+
* @see Charset
9797
*/
9898
public static final String UTF_16BE = "UTF-16BE";
9999

@@ -103,7 +103,7 @@ public class CharEncoding {
103103
* Every implementation of the Java platform is required to support this character encoding.
104104
* </p>
105105
*
106-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
106+
* @see Charset
107107
*/
108108
public static final String UTF_16LE = "UTF-16LE";
109109

@@ -113,7 +113,7 @@ public class CharEncoding {
113113
* Every implementation of the Java platform is required to support this character encoding.
114114
* </p>
115115
*
116-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
116+
* @see Charset
117117
*/
118118
public static final String UTF_8 = "UTF-8";
119119
}

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@
2626

2727
/**
2828
* Converts String to and from bytes using the encodings required by the Java specification. These encodings are
29-
* specified in <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">
30-
* Standard charsets</a>.
29+
* specified in standard {@link Charset}.
3130
*
3231
* <p>This class is immutable and thread-safe.</p>
3332
*
3433
* @see CharEncoding
35-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
34+
* @see Charset
35+
* @see StandardCharsets
3636
* @since 1.4
3737
*/
3838
public class StringUtils {
@@ -106,7 +106,7 @@ private static ByteBuffer getByteBuffer(final String string, final Charset chars
106106
* @throws NullPointerException
107107
* Thrown if {@link StandardCharsets#UTF_8} is not initialized, which should never happen since it is
108108
* required by the Java platform specification.
109-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
109+
* @see Charset
110110
* @see #getBytesUnchecked(String, String)
111111
* @since 1.11
112112
*/
@@ -138,7 +138,7 @@ private static byte[] getBytes(final String string, final Charset charset) {
138138
* Thrown if {@link StandardCharsets#ISO_8859_1} is not initialized, which should never happen
139139
* since it is required by the Java platform specification.
140140
* @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException
141-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
141+
* @see Charset
142142
* @see #getBytesUnchecked(String, String)
143143
*/
144144
public static byte[] getBytesIso8859_1(final String string) {
@@ -187,7 +187,7 @@ public static byte[] getBytesUnchecked(final String string, final String charset
187187
* Thrown if {@link StandardCharsets#US_ASCII} is not initialized, which should never happen since it is
188188
* required by the Java platform specification.
189189
* @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException
190-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
190+
* @see Charset
191191
* @see #getBytesUnchecked(String, String)
192192
*/
193193
public static byte[] getBytesUsAscii(final String string) {
@@ -205,7 +205,7 @@ public static byte[] getBytesUsAscii(final String string) {
205205
* Thrown if {@link StandardCharsets#UTF_16} is not initialized, which should never happen since it is
206206
* required by the Java platform specification.
207207
* @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException
208-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
208+
* @see Charset
209209
* @see #getBytesUnchecked(String, String)
210210
*/
211211
public static byte[] getBytesUtf16(final String string) {
@@ -223,7 +223,7 @@ public static byte[] getBytesUtf16(final String string) {
223223
* Thrown if {@link StandardCharsets#UTF_16BE} is not initialized, which should never happen since it is
224224
* required by the Java platform specification.
225225
* @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException
226-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
226+
* @see Charset
227227
* @see #getBytesUnchecked(String, String)
228228
*/
229229
public static byte[] getBytesUtf16Be(final String string) {
@@ -241,7 +241,7 @@ public static byte[] getBytesUtf16Be(final String string) {
241241
* Thrown if {@link StandardCharsets#UTF_16LE} is not initialized, which should never happen since it is
242242
* required by the Java platform specification.
243243
* @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException
244-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
244+
* @see Charset
245245
* @see #getBytesUnchecked(String, String)
246246
*/
247247
public static byte[] getBytesUtf16Le(final String string) {
@@ -259,7 +259,7 @@ public static byte[] getBytesUtf16Le(final String string) {
259259
* Thrown if {@link StandardCharsets#UTF_8} is not initialized, which should never happen since it is
260260
* required by the Java platform specification.
261261
* @since As of 1.7, throws {@link NullPointerException} instead of UnsupportedEncodingException
262-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
262+
* @see Charset
263263
* @see #getBytesUnchecked(String, String)
264264
*/
265265
public static byte[] getBytesUtf8(final String string) {

‎src/main/java/org/apache/commons/codec/net/BCodec.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public BCodec() {
7777
* @param charset
7878
* the default string Charset to use.
7979
*
80-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
80+
* @see Charset
8181
* @since 1.7
8282
*/
8383
public BCodec(final Charset charset) {
@@ -91,7 +91,7 @@ public BCodec(final Charset charset) {
9191
* the default string Charset to use.
9292
* @param decodingPolicy The decoding policy.
9393
*
94-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
94+
* @see Charset
9595
* @since 1.15
9696
*/
9797
public BCodec(final Charset charset, final CodecPolicy decodingPolicy) {
@@ -107,7 +107,7 @@ public BCodec(final Charset charset, final CodecPolicy decodingPolicy) {
107107
* @throws java.nio.charset.UnsupportedCharsetException
108108
* If the named Charset is unavailable
109109
* @since 1.7 throws UnsupportedCharsetException if the named Charset is unavailable
110-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
110+
* @see Charset
111111
*/
112112
public BCodec(final String charsetName) {
113113
this(Charset.forName(charsetName));

‎src/main/java/org/apache/commons/codec/net/QCodec.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public QCodec() {
123123
* @param charset
124124
* the default string Charset to use.
125125
*
126-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
126+
* @see Charset
127127
* @since 1.7
128128
*/
129129
public QCodec(final Charset charset) {
@@ -138,7 +138,7 @@ public QCodec(final Charset charset) {
138138
* @throws java.nio.charset.UnsupportedCharsetException
139139
* If the named Charset is unavailable
140140
* @since 1.7 throws UnsupportedCharsetException if the named Charset is unavailable
141-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
141+
* @see Charset
142142
*/
143143
public QCodec(final String charsetName) {
144144
this(Charset.forName(charsetName));

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ abstract class RFC1522Codec {
6565
* @return RFC 1522 compliant "encoded-word"
6666
* @throws EncoderException
6767
* thrown if there is an error condition during the Encoding process.
68-
* @see <a href="http://download.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
68+
* @see Charset
6969
*/
7070
protected String encodeText(final String text, final Charset charset) throws EncoderException {
7171
if (text == null) {

0 commit comments

Comments
 (0)