Javadoc

Author: garydgregory

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

@@ -34,21 +34,38 @@
  * documentation for your implementation to see if any other encodings are supported. </cite>
  * </p>
  *
- * <ul>
- * <li>{@code US-ASCII}<br>
- * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
- * <li>{@code ISO-8859-1}<br>
- * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
- * <li>{@code UTF-8}<br>
- * Eight-bit Unicode Transformation Format.</li>
- * <li>{@code UTF-16BE}<br>
- * Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
- * <li>{@code UTF-16LE}<br>
- * Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
- * <li>{@code UTF-16}<br>
- * Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
- * accepted on input, big-endian used on output.)</li>
- * </ul>
+ * <table>
+ * <caption>Standard Charsets</caption>
+ * <tr>
+ * <th>Charset</th>
+ * <th>Description</th>
+ * </tr>
+ * <tr>
+ * <td style="white-space: nowrap">{@code US-ASCII}</td>
+ * <td>Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</td>
+ * </tr>
+ * <tr>
+ * <td style="white-space: nowrap">{@code ISO-8859-1}</td>
+ * <td>ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</td>
+ * </tr>
+ * <tr>
+ * <td style="white-space: nowrap">{@code UTF-8}</td>
+ * <td>Eight-bit Unicode Transformation Format.</td>
+ * </tr>
+ * <tr>
+ * <td style="white-space: nowrap">{@code UTF-16BE}</td>
+ * <td>Sixteen-bit Unicode Transformation Format, big-endian byte order.</td>
+ * </tr>
+ * <tr>
+ * <td style="white-space: nowrap">{@code UTF-16LE}</td>
+ * <td>Sixteen-bit Unicode Transformation Format, little-endian byte order.</td>
+ * </tr>
+ * <tr>
+ * <td style="white-space: nowrap">{@code UTF-16}</td>
+ * <td>Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
+ * accepted on input, big-endian used on output.)</td>
+ * </tr>
+ * </table>
  *
  * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
  * @since 2.3
@@ -80,7 +97,7 @@ public class Charsets {
      * </p>
      *
      * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
-     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
+     * @deprecated Use {@link java.nio.charset.StandardCharsets#ISO_8859_1}.
      */
     @Deprecated
     public static final Charset ISO_8859_1 = StandardCharsets.ISO_8859_1;
@@ -94,7 +111,7 @@ public class Charsets {
      * </p>
      *
      * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
-     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
+     * @deprecated Use {@link java.nio.charset.StandardCharsets#US_ASCII}.
      */
     @Deprecated
     public static final Charset US_ASCII = StandardCharsets.US_ASCII;
@@ -109,7 +126,7 @@ public class Charsets {
      * </p>
      *
      * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
-     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
+     * @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_16}.
      */
     @Deprecated
     public static final Charset UTF_16 = StandardCharsets.UTF_16;
@@ -123,7 +140,7 @@ public class Charsets {
      * </p>
      *
      * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
-     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
+     * @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_16BE}.
      */
     @Deprecated
     public static final Charset UTF_16BE = StandardCharsets.UTF_16BE;
@@ -137,7 +154,7 @@ public class Charsets {
      * </p>
      *
      * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
-     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
+     * @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_16LE}.
      */
     @Deprecated
     public static final Charset UTF_16LE = StandardCharsets.UTF_16LE;
@@ -151,7 +168,7 @@ public class Charsets {
      * </p>
      *
      * @see <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
-     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
+     * @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_8}.
      */
     @Deprecated
     public static final Charset UTF_8 = StandardCharsets.UTF_8;

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

@@ -2773,7 +2773,9 @@ public static void skipFully(final Reader reader, final long toSkip) throws IOEx
      * <li>It has network timeout associated.</li>
      * </ul>
      * <p>
-     * It can be used in favor of {@link #toByteArray(InputStream)}, since it avoids unnecessary allocation and copy of byte[].<br>
+     * It can be used in favor of {@link #toByteArray(InputStream)}, since it avoids unnecessary allocation and copy of byte[].
+     * </p>
+     * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedInputStream}.
      * </p>
      *
@@ -2797,7 +2799,9 @@ public static InputStream toBufferedInputStream(final InputStream input) throws
      * <li>It has network timeout associated.</li>
      * </ul>
      * <p>
-     * It can be used in favor of {@link #toByteArray(InputStream)}, since it avoids unnecessary allocation and copy of byte[].<br>
+     * It can be used in favor of {@link #toByteArray(InputStream)}, since it avoids unnecessary allocation and copy of byte[].
+     * </p>
+     * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedInputStream}.
      * </p>
      *

src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java

@@ -232,7 +232,7 @@ protected byte[] toByteArrayImpl() {
     /**
      * Gets the current contents of this byte stream as an Input Stream. The
      * returned stream is backed by buffers of {@code this} stream,
-     * avoiding memory allocation and copy, thus saving space and time.<br>
+     * avoiding memory allocation and copy, thus saving space and time.
      *
      * @return the current contents of this output stream.
      * @see java.io.ByteArrayOutputStream#toByteArray()
@@ -244,7 +244,7 @@ protected byte[] toByteArrayImpl() {
     /**
      * Gets the current contents of this byte stream as an Input Stream. The
      * returned stream is backed by buffers of {@code this} stream,
-     * avoiding memory allocation and copy, thus saving space and time.<br>
+     * avoiding memory allocation and copy, thus saving space and time.
      *
      * @param <S> the type of the InputStream which makes up
      *            the {@link SequenceInputStream}.

src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java

@@ -40,7 +40,9 @@ public class ByteArrayOutputStream extends AbstractByteArrayOutputStream<ByteArr
      * <li>It has network timeout associated.</li>
      * </ul>
      * <p>
-     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].<br>
+     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].
+     * </p>
+     * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedInputStream}.
      * </p>
      *
@@ -65,7 +67,9 @@ public static InputStream toBufferedInputStream(final InputStream input)
      * <li>It has network timeout associated.</li>
      * </ul>
      * <p>
-     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].<br>
+     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].
+     * </p>
+     * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedInputStream}.
      * </p>
      *

src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java

@@ -451,8 +451,10 @@ protected void thresholdReached() throws IOException {
 
     /**
      * Converts the current contents of this byte stream to an {@link InputStream}. If the data for this output stream has been retained in memory, the returned
-     * stream is backed by buffers of {@code this} stream, avoiding memory allocation and copy, thus saving space and time.<br>
+     * stream is backed by buffers of {@code this} stream, avoiding memory allocation and copy, thus saving space and time.
+     * <p>
      * Otherwise, the returned stream will be one that is created from the data that has been committed to disk.
+     * </p>
      *
      * @return the current contents of this output stream.
      * @throws IOException if this stream is not yet closed or an error occurs.

src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java

@@ -113,7 +113,9 @@ public static Builder builder() {
      * <li>It has network timeout associated.</li>
      * </ul>
      * <p>
-     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].<br>
+     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].
+     * </p>
+     * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedInputStream}.
      * </p>
      *
@@ -136,7 +138,9 @@ public static InputStream toBufferedInputStream(final InputStream input) throws
      * <li>It has network timeout associated.</li>
      * </ul>
      * <p>
-     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].<br>
+     * It can be used in favor of {@link #toByteArray()}, since it avoids unnecessary allocation and copy of byte[].
+     * </p>
+     * <p>
      * This method buffers the input internally, so there is no need to use a {@link BufferedInputStream}.
      * </p>
      *