Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/CopyUtils.java

@@ -179,7 +179,7 @@ public static int copy(final InputStream input, final OutputStream output) throw
      * Copies and convert bytes from an {@link InputStream} to chars on a
      * {@link Writer}.
      * <p>
-     * This method uses the virtual machine's {@link Charset#defaultCharset() default charset} for byte-to-char conversion.
+     * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} for byte-to-char conversion.
      * </p>
      *
      * @param input the {@link InputStream} to read from
@@ -221,7 +221,7 @@ public static void copy(
      * Serialize chars from a {@link Reader} to bytes on an
      * {@link OutputStream}, and flush the {@link OutputStream}.
      * <p>
-     * This method uses the virtual machine's {@link Charset#defaultCharset() default charset} for byte-to-char conversion.
+     * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} for byte-to-char conversion.
      * </p>
      *
      * @param input the {@link Reader} to read from
@@ -293,7 +293,7 @@ public static int copy(
      * {@link OutputStream}, and
      * flush the {@link OutputStream}.
      * <p>
-     * This method uses the virtual machine's {@link Charset#defaultCharset() default charset} for byte-to-char conversion.
+     * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} for byte-to-char conversion.
      * </p>
      *
      * @param input the {@link String} to read from

src/main/java/org/apache/commons/io/FileUtils.java

@@ -2755,7 +2755,7 @@ public static byte[] readFileToByteArray(final File file) throws IOException {
     }
 
     /**
-     * Reads the contents of a file into a String using the virtual machine's {@link Charset#defaultCharset() default charset}. The
+     * Reads the contents of a file into a String using the virtual machine's {@linkplain Charset#defaultCharset() default charset}. The
      * file is always closed.
      *
      * @param file the file to read, must not be {@code null}.
@@ -2804,7 +2804,7 @@ public static String readFileToString(final File file, final String charsetName)
     }
 
     /**
-     * Reads the contents of a file line by line to a List of Strings using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Reads the contents of a file line by line to a List of Strings using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * The file is always closed.
      *
      * @param file the file to read, must not be {@code null}.
@@ -3212,7 +3212,7 @@ public static boolean waitFor(final File file, final int seconds) {
     }
 
     /**
-     * Writes a CharSequence to a file creating the file if it does not exist using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Writes a CharSequence to a file creating the file if it does not exist using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param file the file to write.
      * @param data the content to write to the file.
@@ -3226,7 +3226,7 @@ public static void write(final File file, final CharSequence data) throws IOExce
     }
 
     /**
-     * Writes a CharSequence to a file creating the file if it does not exist using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Writes a CharSequence to a file creating the file if it does not exist using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param file   the file to write.
      * @param data   the content to write to the file.
@@ -3501,7 +3501,7 @@ public static void writeLines(final File file, final String charsetName, final C
     }
 
     /**
-     * Writes a String to a file creating the file if it does not exist using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Writes a String to a file creating the file if it does not exist using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param file the file to write
      * @param data the content to write to the file
@@ -3514,7 +3514,7 @@ public static void writeStringToFile(final File file, final String data) throws
     }
 
     /**
-     * Writes a String to a file creating the file if it does not exist using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Writes a String to a file creating the file if it does not exist using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param file   the file to write
      * @param data   the content to write to the file

src/main/java/org/apache/commons/io/HexDump.java

@@ -169,7 +169,7 @@ public static void dump(final byte[] data, final long offset,
      * data array are dumped.
      * </p>
      * <p>
-     * This method uses the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * </p>
      *
      * @param data  the byte array to be dumped

src/main/java/org/apache/commons/io/IOUtils.java

@@ -1269,7 +1269,7 @@ public static long copy(final InputStream inputStream, final OutputStream output
 
     /**
      * Copies bytes from an {@link InputStream} to chars on a
-     * {@link Writer} using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * {@link Writer} using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method buffers the input internally, so there is no need to use a
      * {@link BufferedInputStream}.
@@ -1421,8 +1421,8 @@ public static long copy(final Reader reader, final Appendable output, final Char
     }
 
     /**
-     * Copies chars from a {@link Reader} to bytes on an {@link OutputStream} using the the virtual machine's {@link Charset#defaultCharset() default charset},
-     * and calling flush.
+     * Copies chars from a {@link Reader} to bytes on an {@link OutputStream} using the the virtual machine's {@linkplain Charset#defaultCharset() default
+     * charset}, and calling flush.
      * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedReader}.
      * </p>
@@ -2319,7 +2319,7 @@ public static List<String> readLines(final CharSequence csq) throws UncheckedIOE
 
     /**
      * Gets the contents of an {@link InputStream} as a list of Strings,
-     * one entry per line, using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * one entry per line, using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method buffers the input internally, so there is no need to use a
      * {@link BufferedInputStream}.
@@ -2967,7 +2967,7 @@ static byte[] toByteArray(final IOTriFunction<byte[], Integer, Integer, Integer>
 
     /**
      * Gets the contents of a {@link Reader} as a {@code byte[]}
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method buffers the input internally, so there is no need to use a
      * {@link BufferedReader}.
@@ -3032,7 +3032,7 @@ public static byte[] toByteArray(final Reader reader, final String charsetName)
 
     /**
      * Gets the contents of a {@link String} as a {@code byte[]}
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This is the same as {@link String#getBytes()}.
      * </p>
@@ -3093,7 +3093,7 @@ public static byte[] toByteArray(final URLConnection urlConnection) throws IOExc
 
     /**
      * Gets the contents of an {@link InputStream} as a character array
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method buffers the input internally, so there is no need to use a
      * {@link BufferedInputStream}.
@@ -3178,7 +3178,7 @@ public static char[] toCharArray(final Reader reader) throws IOException {
 
     /**
      * Converts the specified CharSequence to an input stream, encoded as bytes
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param input the CharSequence to convert.
      * @return an input stream.
@@ -3223,7 +3223,7 @@ public static InputStream toInputStream(final CharSequence input, final String c
 
     /**
      * Converts the specified string to an input stream, encoded as bytes
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param input the string to convert.
      * @return an input stream.
@@ -3268,7 +3268,7 @@ public static InputStream toInputStream(final String input, final String charset
 
     /**
      * Gets the contents of a {@code byte[]} as a String
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param input the byte array to read.
      * @return the requested String.
@@ -3300,7 +3300,7 @@ public static String toString(final byte[] input, final String charsetName) {
 
     /**
      * Gets the contents of an {@link InputStream} as a String
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method buffers the input internally, so there is no need to use a
      * {@link BufferedInputStream}.
@@ -3429,7 +3429,7 @@ public static String toString(final Reader reader) throws IOException {
     }
 
     /**
-     * Gets the contents at the given URI using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Gets the contents at the given URI using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param uri The URI source.
      * @return The contents of the URL as a String.
@@ -3470,7 +3470,7 @@ public static String toString(final URI uri, final String charsetName) throws IO
     }
 
     /**
-     * Gets the contents at the given URL using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Gets the contents at the given URL using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param url The URL source.
      * @return The contents of the URL as a String.
@@ -3528,7 +3528,7 @@ public static void write(final byte[] data, final OutputStream output)
 
     /**
      * Writes bytes from a {@code byte[]} to chars on a {@link Writer}
-     * using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method uses {@link String#String(byte[])}.
      * </p>
@@ -3591,7 +3591,7 @@ public static void write(final byte[] data, final Writer writer, final String ch
     /**
      * Writes chars from a {@code char[]} to bytes on an {@link OutputStream}.
      * <p>
-     * This method uses the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * </p>
      *
      * @param data   the char array to write, do not modify during output, null ignored.
@@ -3742,7 +3742,7 @@ public static void write(final CharSequence data, final Writer writer) throws IO
 
     /**
      * Writes chars from a {@link String} to bytes on an
-     * {@link OutputStream} using the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * {@link OutputStream} using the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * <p>
      * This method uses {@link String#getBytes()}.
      * </p>
@@ -3941,7 +3941,7 @@ public static void writeChunked(final char[] data, final Writer writer) throws I
 
     /**
      * Writes the {@link #toString()} value of each item in a collection to an {@link OutputStream} line by line, using the virtual machine's
-     * {@link Charset#defaultCharset() default charset} and the specified line ending.
+     * {@linkplain Charset#defaultCharset() default charset} and the specified line ending.
      *
      * @param lines      the lines to write, null entries produce blank lines.
      * @param lineEnding the line separator to use, null is system default.

src/main/java/org/apache/commons/io/charset/CharsetDecoders.java

@@ -30,7 +30,7 @@ public final class CharsetDecoders {
     /**
      * Returns the given non-null CharsetDecoder or a new default CharsetDecoder.
      * <p>
-     * Null input maps to the virtual machine's {@link Charset#defaultCharset() default charset} decoder.
+     * Null input maps to the virtual machine's {@linkplain Charset#defaultCharset() default charset} decoder.
      * </p>
      *
      * @param charsetDecoder The CharsetDecoder to test.

src/main/java/org/apache/commons/io/charset/CharsetEncoders.java

@@ -31,7 +31,7 @@ public final class CharsetEncoders {
     /**
      * Returns the given non-null CharsetEncoder or a new default CharsetEncoder.
      * <p>
-     * Null input maps to the virtual machine's {@link Charset#defaultCharset() default charset} decoder.
+     * Null input maps to the virtual machine's {@linkplain Charset#defaultCharset() default charset} decoder.
      * </p>
      *
      * @param charsetEncoder The CharsetEncoder to test.

src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java

@@ -218,7 +218,7 @@ public MagicNumberFileFilter(final String magicNumber) {
      * MagicNumberFileFilter tarFileFilter = MagicNumberFileFilter("ustar", 257);
      * </pre>
      * <p>
-     * This method uses the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * This method uses the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      * </p>
      *
      * @param magicNumber the magic number to look for in the file.

src/main/java/org/apache/commons/io/input/ReaderInputStream.java

@@ -225,8 +225,8 @@ private ReaderInputStream(final Builder builder) throws IOException {
     }
 
     /**
-     * Constructs a new {@link ReaderInputStream} that uses the virtual machine's {@link Charset#defaultCharset() default charset} with a default input buffer
-     * size of {@value IOUtils#DEFAULT_BUFFER_SIZE} characters.
+     * Constructs a new {@link ReaderInputStream} that uses the virtual machine's {@linkplain Charset#defaultCharset() default charset} with a default input
+     * buffer size of {@value IOUtils#DEFAULT_BUFFER_SIZE} characters.
      *
      * @param reader the target {@link Reader}
      * @deprecated Use {@link ReaderInputStream#builder()} instead

src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java

@@ -354,7 +354,7 @@ private ReversedLinesFileReader(final Builder builder) throws IOException {
     }
 
     /**
-     * Constructs a ReversedLinesFileReader with default block size of 4KB and the virtual machine's {@link Charset#defaultCharset() default charset}.
+     * Constructs a ReversedLinesFileReader with default block size of 4KB and the virtual machine's {@linkplain Charset#defaultCharset() default charset}.
      *
      * @param file the file to be read
      * @throws IOException if an I/O error occurs.

src/main/java/org/apache/commons/io/input/Tailer.java

@@ -495,7 +495,7 @@ public String toString() {
     private static final String RAF_READ_ONLY_MODE = "r";
 
     /**
-     * The the virtual machine's {@link Charset#defaultCharset() default charset} used for reading files.
+     * The the virtual machine's {@linkplain Charset#defaultCharset() default charset} used for reading files.
      */
     private static final Charset DEFAULT_CHARSET = Charset.defaultCharset();