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-io.git
The following commit(s) were added to refs/heads/master by this push: new cbdbe648 Javadoc cbdbe648 is described below commit cbdbe648e4cf615824e168f3946c2da68bc56929 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu May 18 10:51:38 2023 -0400 Javadoc Use varargs for BOMInputStream.Builder.setByteOrderMarks(ByteOrderMark...) --- .../commons/io/filefilter/WildcardFileFilter.java | 8 ++++++-- .../org/apache/commons/io/input/BOMInputStream.java | 18 ++++++++++-------- .../io/input/BufferedFileChannelInputStream.java | 3 +++ .../commons/io/input/MemoryMappedFileInputStream.java | 3 +++ .../io/input/MessageDigestCalculatingInputStream.java | 3 +++ .../org/apache/commons/io/input/QueueInputStream.java | 4 +++- .../commons/io/input/RandomAccessFileInputStream.java | 4 +++- .../apache/commons/io/input/ReadAheadInputStream.java | 3 +++ .../org/apache/commons/io/input/ReaderInputStream.java | 4 +++- .../commons/io/input/ReversedLinesFileReader.java | 6 ++++-- .../org/apache/commons/io/input/StringInputStream.java | 4 +++- src/main/java/org/apache/commons/io/input/Tailer.java | 4 +++- .../commons/io/input/UncheckedBufferedReader.java | 3 +++ .../commons/io/input/UncheckedFilterInputStream.java | 3 +++ .../apache/commons/io/input/UncheckedFilterReader.java | 3 +++ .../io/input/UnsynchronizedBufferedInputStream.java | 3 +++ .../io/input/UnsynchronizedByteArrayInputStream.java | 3 +++ .../io/input/UnsynchronizedFilterInputStream.java | 3 +++ .../org/apache/commons/io/input/XmlStreamReader.java | 3 +++ .../commons/io/output/DeferredFileOutputStream.java | 3 +++ .../commons/io/output/FileWriterWithEncoding.java | 3 +++ .../apache/commons/io/output/LockableFileWriter.java | 3 +++ .../commons/io/output/UncheckedFilterOutputStream.java | 3 +++ .../commons/io/output/UncheckedFilterWriter.java | 3 +++ .../io/output/UnsynchronizedByteArrayOutputStream.java | 3 +++ .../apache/commons/io/output/WriterOutputStream.java | 9 +++++++-- .../org/apache/commons/io/output/XmlStreamWriter.java | 6 ++++-- 27 files changed, 97 insertions(+), 21 deletions(-) diff --git a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java index df337acb..4315183b 100644 --- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java @@ -39,13 +39,16 @@ import org.apache.commons.io.build.AbstractSupplier; * command lines. The check is case-sensitive by default. See {@link FilenameUtils#wildcardMatchOnSystem(String,String)} for more information. * </p> * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * For example: * </p> * <h2>Using Classic IO</h2> * * <pre> * File dir = FileUtils.current(); - * FileFilter fileFilter = new WildcardFileFilter("*test*.java~*~"); + * FileFilter fileFilter = WildcardFileFilter.builder().setWildcards("*test*.java~*~").get(); * File[] files = dir.listFiles(fileFilter); * for (String file : files) { * System.out.println(file); @@ -56,7 +59,8 @@ import org.apache.commons.io.build.AbstractSupplier; * * <pre> * final Path dir = PathUtils.current(); - * final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new WildcardFileFilter("*test*.java~*~")); + * final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters( + * WildcardFileFilter.builder().setWildcards("*test*.java~*~").get()); * // * // Walk one dir * Files.<b>walkFileTree</b>(dir, Collections.emptySet(), 1, visitor); diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java b/src/main/java/org/apache/commons/io/input/BOMInputStream.java index 252803df..5f78335c 100644 --- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java @@ -45,11 +45,13 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * <li>UTF-32BE - {@link ByteOrderMark#UTF_32LE}</li> * <li>UTF-32LE - {@link ByteOrderMark#UTF_32BE}</li> * </ul> - * + * <p> + * To build an instance, see {@link Builder}. + * </p> * <h2>Example 1 - Detect and exclude a UTF-8 BOM</h2> * * <pre> - * BOMInputStream bomIn = new BOMInputStream(in); + * BOMInputStream bomIn = BOMInputStream.builder().setInputStream(in).get(); * if (bomIn.hasBOM()) { * // has a UTF-8 BOM * } @@ -59,7 +61,7 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * * <pre> * boolean include = true; - * BOMInputStream bomIn = new BOMInputStream(in, include); + * BOMInputStream bomIn = BOMInputStream.builder().setInputStream(in).setInclude(include).get(); * if (bomIn.hasBOM()) { * // has a UTF-8 BOM * } @@ -68,10 +70,10 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * <h2>Example 3 - Detect Multiple BOMs</h2> * * <pre> - * BOMInputStream bomIn = new BOMInputStream(in, - * ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE, - * ByteOrderMark.UTF_32LE, ByteOrderMark.UTF_32BE - * ); + * BOMInputStream bomIn = BOMInputStream.builder() + * .setInputStream(in) + * .setByteOrderMarks(ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE, ByteOrderMark.UTF_32LE, ByteOrderMark.UTF_32BE) + * .get(); * if (bomIn.hasBOM() == false) { * // No BOM found * } else if (bomIn.hasBOM(ByteOrderMark.UTF_16LE)) { @@ -136,7 +138,7 @@ public class BOMInputStream extends ProxyInputStream { * @param byteOrderMarks the ByteOrderMarks to detect and optionally exclude. * @return this */ - public Builder setByteOrderMarks(final ByteOrderMark[] byteOrderMarks) { + public Builder setByteOrderMarks(final ByteOrderMark... byteOrderMarks) { this.byteOrderMarks = byteOrderMarks != null ? byteOrderMarks.clone() : DEFAULT; return this; } diff --git a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java index e514f985..36a717e5 100644 --- a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java @@ -32,6 +32,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * using {@link java.io.BufferedInputStream}. Unfortunately, this is not something already available in JDK, {@code sun.nio.ch.ChannelInputStream} supports * reading a file using NIO, but does not support buffering. * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * This class was ported and adapted from Apache Spark commit 933dc6cb7b3de1d8ccaf73d124d6eb95b947ed19 where it was called {@code NioBufferedFileInputStream}. * </p> * diff --git a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java index 77bcda79..4a6daf50 100644 --- a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java +++ b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java @@ -42,6 +42,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * Note: Use of this class does not necessarily obviate the need to use a {@link BufferedInputStream}. Depending on the * use case, the use of buffering may still further improve performance. For example: * </p> + * <p> + * To build an instance, see {@link Builder}. + * </p> * <pre> * new BufferedInputStream(new GzipInputStream(new MemoryMappedFileInputStream(path)))) * </pre> diff --git a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java index dea07395..c591c61d 100644 --- a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java +++ b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java @@ -28,6 +28,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * This class is an example for using an {@link ObservableInputStream}. It creates its own {@link org.apache.commons.io.input.ObservableInputStream.Observer}, * which calculates a checksum using a MessageDigest, for example an MD5 sum. * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * See the MessageDigest section in the <a href= "https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#MessageDigest"> Java * Cryptography Architecture Standard Algorithm Name Documentation</a> for information about standard algorithm names. * </p> diff --git a/src/main/java/org/apache/commons/io/input/QueueInputStream.java b/src/main/java/org/apache/commons/io/input/QueueInputStream.java index 9f851267..2820c32b 100644 --- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java +++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java @@ -33,7 +33,9 @@ import org.apache.commons.io.output.QueueOutputStream; /** * Simple alternative to JDK {@link java.io.PipedInputStream}; queue input stream provides what's written in queue output stream. - * + * <p> + * To build an instance, see {@link Builder}. + * </p> * <p> * Example usage: * </p> diff --git a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java index 02737b80..6b3ab176 100644 --- a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java +++ b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java @@ -27,7 +27,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; /** * Streams data from a {@link RandomAccessFile} starting at its current position. - * + * <p> + * To build an instance, see {@link Builder}. + * </p> * @since 2.8.0 */ public class RandomAccessFileInputStream extends InputStream { diff --git a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java index 158a0651..8cefa1d9 100644 --- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java @@ -38,6 +38,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * read() call is issued. The read ahead buffer is used to asynchronously read from the underlying input stream. When the current active buffer is exhausted, we * flip the two buffers so that we can start reading from the read ahead buffer without being blocked by disk I/O. * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * This class was ported and adapted from Apache Spark commit 933dc6cb7b3de1d8ccaf73d124d6eb95b947ed19. * </p> * diff --git a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java index 18e70bcf..1be3fe15 100644 --- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java @@ -48,7 +48,9 @@ import org.apache.commons.io.charset.CharsetEncoders; * {@link ReaderInputStream} implements the inverse transformation of {@link java.io.InputStreamReader}; in the following example, reading from {@code in2} * would return the same byte sequence as reading from {@code in} (provided that the initial byte sequence is legal with respect to the charset encoding): * </p> - * + * <p> + * To build an instance, see {@link Builder}. + * </p> * <pre> * InputStream inputStream = ... * Charset cs = ... diff --git a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java index 467450f0..5e646e77 100644 --- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java +++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java @@ -39,8 +39,10 @@ import org.apache.commons.io.StandardLineSeparator; import org.apache.commons.io.build.AbstractStreamBuilder; /** - * Reads lines in a file reversely (similar to a BufferedReader, but starting at - * the last line). Useful for e.g. searching in log files. + * Reads lines in a file reversely (similar to a BufferedReader, but starting at the last line). Useful for e.g. searching in log files. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @since 2.2 */ diff --git a/src/main/java/org/apache/commons/io/input/StringInputStream.java b/src/main/java/org/apache/commons/io/input/StringInputStream.java index f3cdceca..2d172a8c 100644 --- a/src/main/java/org/apache/commons/io/input/StringInputStream.java +++ b/src/main/java/org/apache/commons/io/input/StringInputStream.java @@ -26,7 +26,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; /** * An {@link InputStream} on a String. - * + * <p> + * To build an instance, see {@link Builder}. + * </p> * @since 2.13.0 */ public final class StringInputStream extends ReaderInputStream { diff --git a/src/main/java/org/apache/commons/io/input/Tailer.java b/src/main/java/org/apache/commons/io/input/Tailer.java index 5d74f037..1fd97280 100644 --- a/src/main/java/org/apache/commons/io/input/Tailer.java +++ b/src/main/java/org/apache/commons/io/input/Tailer.java @@ -46,7 +46,9 @@ import org.apache.commons.io.file.attribute.FileTimes; /** * Simple implementation of the UNIX "tail -f" functionality. - * + * <p> + * To build an instance, see {@link Builder}. + * </p> * <h2>1. Create a TailerListener implementation</h2> * <p> * First you need to create a {@link TailerListener} implementation; ({@link TailerListenerAdapter} is provided for diff --git a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java index 78524736..4b765bb9 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java @@ -28,6 +28,9 @@ import org.apache.commons.io.function.Uncheck; /** * A {@link BufferedReader} that throws {@link UncheckedIOException} instead of {@link IOException}. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see BufferedReader * @see IOException diff --git a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java index d2deaf6d..1aafc042 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java @@ -28,6 +28,9 @@ import org.apache.commons.io.function.Uncheck; /** * A {@link BufferedReader} that throws {@link UncheckedIOException} instead of {@link IOException}. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see BufferedReader * @see IOException diff --git a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java index 0dede00d..9d3e86f8 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java @@ -28,6 +28,9 @@ import org.apache.commons.io.function.Uncheck; /** * A {@link FilterReader} that throws {@link UncheckedIOException} instead of {@link IOException}. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see FilterReader * @see IOException diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java index 2c438500..fde86422 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java @@ -32,6 +32,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * takes place when filling that buffer, but this is usually outweighed by the performance benefits. * </p> * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * A typical application pattern for the class looks like this: * </p> * diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java index 740e7290..d0fa0a75 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java @@ -28,6 +28,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; /** * This is an alternative to {@link java.io.ByteArrayInputStream} which removes the synchronization overhead for non-concurrent access; as such this class is * not thread-safe. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see ByteArrayInputStream * @since 2.7 diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java index 3113c5a8..e4530032 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java @@ -31,6 +31,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * and provide some additional functionality on top of it usually inherit from this class. * </p> * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * Provenance: Apache Harmony and modified. * </p> * diff --git a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java index 3320d0d6..3ccf0a41 100644 --- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java +++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java @@ -62,6 +62,9 @@ import org.apache.commons.io.output.XmlStreamWriter; * the character encoding of a feed</a>. * </p> * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * Originally developed for <a href="http://rome.dev.java.net">ROME</a> under Apache License 2.0. * </p> * diff --git a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java index 379cecd4..f6a7b65b 100644 --- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java @@ -32,6 +32,9 @@ import org.apache.commons.io.file.PathUtils; * An output stream which will retain data in memory until a specified threshold is reached, and only then commit it to disk. If the stream is closed before the * threshold is reached, the data will not be written to disk at all. * <p> + * To build an instance, see {@link Builder}. + * </p> + * <p> * This class originated in FileUpload processing. In this use case, you do not know in advance the size of the file being uploaded. If the file is small you * want to store it in memory (for speed), but if the file is large you want to store it to file (to avoid memory issues). * </p> diff --git a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java index c2bb1750..6bab25fb 100644 --- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java +++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java @@ -42,6 +42,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * The encoding must be specified using either the name of the {@link Charset}, the {@link Charset}, or a {@link CharsetEncoder}. If the default encoding is * required then use the {@link java.io.FileWriter} directly, rather than this implementation. * </p> + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @since 1.4 */ diff --git a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java index 76fc2c6d..94cf2192 100644 --- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java +++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java @@ -44,6 +44,9 @@ import org.apache.commons.io.build.AbstractStreamBuilder; * By default, the file will be overwritten, but this may be changed to append. The lock directory may be specified, but defaults to the system property * {@code java.io.tmpdir}. The encoding may also be specified, and defaults to the platform default. * </p> + * <p> + * To build an instance, see {@link Builder}. + * </p> */ public class LockableFileWriter extends Writer { diff --git a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java index 840c3124..8ffa2b3b 100644 --- a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java @@ -27,6 +27,9 @@ import org.apache.commons.io.function.Uncheck; /** * A {@link FilterOutputStream} that throws {@link UncheckedIOException} instead of {@link UncheckedIOException}. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see FilterOutputStream * @see UncheckedIOException diff --git a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java index 3fe885f0..d05053b9 100644 --- a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java +++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java @@ -27,6 +27,9 @@ import org.apache.commons.io.function.Uncheck; /** * A {@link FilterWriter} that throws {@link UncheckedIOException} instead of {@link IOException}. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see FilterWriter * @see IOException diff --git a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java index 31f57244..7778578b 100644 --- a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java @@ -27,6 +27,9 @@ import org.apache.commons.io.input.UnsynchronizedByteArrayInputStream; /** * Implements a version of {@link AbstractByteArrayOutputStream} <b>without</b> any concurrent thread safety. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @since 2.7 */ diff --git a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java index e201f69b..cccf736b 100644 --- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java @@ -42,20 +42,25 @@ import org.apache.commons.io.charset.CharsetDecoders; * is called. In general there is therefore no need to wrap the underlying {@link Writer} in a {@link java.io.BufferedWriter}. {@link WriterOutputStream} can * also be instructed to flush the buffer after each write operation. In this case, all available data is written immediately to the underlying {@link Writer}, * implying that the current position of the {@link Writer} is correlated to the current position of the {@link WriterOutputStream}. + * </p> * <p> * {@link WriterOutputStream} implements the inverse transformation of {@link java.io.OutputStreamWriter}; in the following example, writing to {@code out2} * would have the same result as writing to {@code out} directly (provided that the byte sequence is legal with respect to the charset encoding): - * + * </p> + * <p> + * To build an instance, see {@link Builder}. + * </p> * <pre> * OutputStream out = ... * Charset cs = ... * OutputStreamWriter writer = new OutputStreamWriter(out, cs); * WriterOutputStream out2 = new WriterOutputStream(writer, cs); * </pre> - * + * <p> * {@link WriterOutputStream} implements the same transformation as {@link java.io.InputStreamReader}, except that the control flow is reversed: both classes * transform a byte stream into a character stream, but {@link java.io.InputStreamReader} pulls data from the underlying stream, while * {@link WriterOutputStream} pushes it to the underlying stream. + * </p> * <p> * Note that while there are use cases where there is no alternative to using this class, very often the need to use this class is an indication of a flaw in * the design of the code. This class is typically used in situations where an existing API only accepts an {@link OutputStream} object, but where the stream is diff --git a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java index 1142c70e..b574586e 100644 --- a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java +++ b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java @@ -36,8 +36,10 @@ import org.apache.commons.io.build.AbstractStreamBuilder; import org.apache.commons.io.input.XmlStreamReader; /** - * Character stream that handles all the necessary work to figure out the - * charset encoding of the XML document written to the stream. + * Character stream that handles all the necessary work to figure out the charset encoding of the XML document written to the stream. + * <p> + * To build an instance, see {@link Builder}. + * </p> * * @see XmlStreamReader * @since 2.0