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 bebf1ffa Javadoc bebf1ffa is described below commit bebf1ffa3906b560bc9f27f5606c77ee9153ebf9 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Wed May 31 17:06:44 2023 -0400 Javadoc --- .../commons/io/filefilter/WildcardFileFilter.java | 12 +++++----- .../commons/io/input/AutoCloseInputStream.java | 2 +- .../apache/commons/io/input/BOMInputStream.java | 8 +++---- .../io/input/BufferedFileChannelInputStream.java | 8 +++---- .../commons/io/input/CharSequenceInputStream.java | 8 +++---- .../input/MessageDigestCalculatingInputStream.java | 6 ++--- .../apache/commons/io/input/QueueInputStream.java | 2 +- .../io/input/RandomAccessFileInputStream.java | 4 ++-- .../commons/io/input/ReadAheadInputStream.java | 4 ++-- .../java/org/apache/commons/io/input/Tailer.java | 28 +++++++++++----------- .../input/UnsynchronizedByteArrayInputStream.java | 6 ++--- .../apache/commons/io/input/XmlStreamReader.java | 16 ++++++------- .../commons/io/output/ChunkedOutputStream.java | 4 ++-- .../io/output/DeferredFileOutputStream.java | 8 +++---- .../commons/io/output/FileWriterWithEncoding.java | 24 +++++++++---------- .../commons/io/output/LockableFileWriter.java | 18 +++++++------- .../UnsynchronizedByteArrayOutputStream.java | 4 ++-- .../commons/io/output/WriterOutputStream.java | 14 +++++------ .../apache/commons/io/output/XmlStreamWriter.java | 8 +++---- 19 files changed, 92 insertions(+), 92 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 e3907d19..0b21e7a0 100644 --- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java @@ -177,7 +177,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab * @param wildcards the list of wildcards to match, not null * @throws IllegalArgumentException if the pattern list is null * @throws ClassCastException if the list does not contain Strings - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WildcardFileFilter(final List<String> wildcards) { @@ -191,7 +191,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab * @param ioCase how to handle case sensitivity, null means case-sensitive * @throws IllegalArgumentException if the pattern list is null * @throws ClassCastException if the list does not contain Strings - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WildcardFileFilter(final List<String> wildcards, final IOCase ioCase) { @@ -203,7 +203,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab * * @param wildcard the wildcard to match * @throws IllegalArgumentException if the pattern is null - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WildcardFileFilter(final String wildcard) { @@ -215,7 +215,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab * * @param wildcards the array of wildcards to match * @throws NullPointerException if the pattern array is null - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WildcardFileFilter(final String... wildcards) { @@ -228,7 +228,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab * @param wildcard the wildcard to match, not null * @param ioCase how to handle case sensitivity, null means case-sensitive * @throws NullPointerException if the pattern is null - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WildcardFileFilter(final String wildcard, final IOCase ioCase) { @@ -241,7 +241,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab * @param wildcards the array of wildcards to match, not null * @param ioCase how to handle case sensitivity, null means case-sensitive * @throws NullPointerException if the pattern array is null - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WildcardFileFilter(final String[] wildcards, final IOCase ioCase) { diff --git a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java index 05885896..187e59b9 100644 --- a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java +++ b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java @@ -94,7 +94,7 @@ public class AutoCloseInputStream extends ProxyInputStream { * Creates an automatically closing proxy for the given input stream. * * @param in underlying input stream - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public AutoCloseInputStream(final InputStream in) { 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 5531c02a..425af99c 100644 --- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java @@ -219,7 +219,7 @@ public class BOMInputStream extends ProxyInputStream { * * @param delegate * the InputStream to delegate to - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BOMInputStream(final InputStream delegate) { @@ -233,7 +233,7 @@ public class BOMInputStream extends ProxyInputStream { * the InputStream to delegate to * @param include * true to include the UTF-8 BOM or false to exclude it - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BOMInputStream(final InputStream delegate, final boolean include) { @@ -249,7 +249,7 @@ public class BOMInputStream extends ProxyInputStream { * true to include the specified BOMs or false to exclude them * @param boms * The BOMs to detect and optionally exclude - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BOMInputStream(final InputStream delegate, final boolean include, final ByteOrderMark... boms) { @@ -272,7 +272,7 @@ public class BOMInputStream extends ProxyInputStream { * the InputStream to delegate to * @param boms * The BOMs to detect and exclude - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BOMInputStream(final InputStream delegate, final ByteOrderMark... boms) { 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 e0d6734f..182090da 100644 --- a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java +++ b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java @@ -110,7 +110,7 @@ public final class BufferedFileChannelInputStream extends InputStream { * * @param file The file to stream. * @throws IOException If an I/O error occurs - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BufferedFileChannelInputStream(final File file) throws IOException { @@ -123,7 +123,7 @@ public final class BufferedFileChannelInputStream extends InputStream { * @param file The file to stream. * @param bufferSize buffer size. * @throws IOException If an I/O error occurs - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BufferedFileChannelInputStream(final File file, final int bufferSize) throws IOException { @@ -135,7 +135,7 @@ public final class BufferedFileChannelInputStream extends InputStream { * * @param path The path to stream. * @throws IOException If an I/O error occurs - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BufferedFileChannelInputStream(final Path path) throws IOException { @@ -148,7 +148,7 @@ public final class BufferedFileChannelInputStream extends InputStream { * @param path The path to stream. * @param bufferSize buffer size. * @throws IOException If an I/O error occurs - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public BufferedFileChannelInputStream(final Path path, final int bufferSize) throws IOException { diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java index 1ccde6ad..a7e77cf5 100644 --- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java +++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java @@ -104,7 +104,7 @@ public class CharSequenceInputStream extends InputStream { * @param cs the input character sequence. * @param charset the character set name to use. * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public CharSequenceInputStream(final CharSequence cs, final Charset charset) { @@ -118,7 +118,7 @@ public class CharSequenceInputStream extends InputStream { * @param charset the character set name to use, null maps to the default Charset. * @param bufferSize the buffer size to use. * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public CharSequenceInputStream(final CharSequence cs, final Charset charset, final int bufferSize) { @@ -141,7 +141,7 @@ public class CharSequenceInputStream extends InputStream { * @param cs the input character sequence. * @param charset the character set name to use. * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public CharSequenceInputStream(final CharSequence cs, final String charset) { @@ -155,7 +155,7 @@ public class CharSequenceInputStream extends InputStream { * @param charset the character set name to use, null maps to the default Charset. * @param bufferSize the buffer size to use. * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public CharSequenceInputStream(final CharSequence cs, final String charset, final int bufferSize) { 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 0ee92f7c..96198aaa 100644 --- a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java +++ b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java @@ -178,7 +178,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream { * * @param inputStream the stream to calculate the message digest for * @throws NoSuchAlgorithmException if no Provider supports a MessageDigestSpi implementation for the specified algorithm. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public MessageDigestCalculatingInputStream(final InputStream inputStream) throws NoSuchAlgorithmException { @@ -190,7 +190,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream { * * @param inputStream the stream to calculate the message digest for * @param messageDigest the message digest to use - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public MessageDigestCalculatingInputStream(final InputStream inputStream, final MessageDigest messageDigest) { @@ -206,7 +206,7 @@ public class MessageDigestCalculatingInputStream extends ObservableInputStream { * <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. * @throws NoSuchAlgorithmException if no Provider supports a MessageDigestSpi implementation for the specified algorithm. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public MessageDigestCalculatingInputStream(final InputStream inputStream, final String algorithm) throws NoSuchAlgorithmException { 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 6af18bab..5956fcf9 100644 --- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java +++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java @@ -146,7 +146,7 @@ public class QueueInputStream extends InputStream { * Constructs a new instance with given queue and zero timeout. * * @param blockingQueue backing queue for the stream. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public QueueInputStream(final BlockingQueue<Integer> blockingQueue) { 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 36a36ecd..02218696 100644 --- a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java +++ b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java @@ -123,7 +123,7 @@ public class RandomAccessFileInputStream extends InputStream { * Constructs a new instance configured to leave the underlying file open when this stream is closed. * * @param file The file to stream. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public RandomAccessFileInputStream(final RandomAccessFile file) { @@ -135,7 +135,7 @@ public class RandomAccessFileInputStream extends InputStream { * * @param file The file to stream. * @param closeOnClose Whether to close the underlying file when this stream is closed. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public RandomAccessFileInputStream(final RandomAccessFile file, final boolean closeOnClose) { 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 d4790ba4..02b79a03 100644 --- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java @@ -182,7 +182,7 @@ public class ReadAheadInputStream extends FilterInputStream { * * @param inputStream The underlying input stream. * @param bufferSizeInBytes The buffer size. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public ReadAheadInputStream(final InputStream inputStream, final int bufferSizeInBytes) { @@ -195,7 +195,7 @@ public class ReadAheadInputStream extends FilterInputStream { * @param inputStream The underlying input stream. * @param bufferSizeInBytes The buffer size. * @param executorService An executor service for the read-ahead thread. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public ReadAheadInputStream(final InputStream inputStream, final int bufferSizeInBytes, final ExecutorService executorService) { 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 ab050d5b..70ba0f2c 100644 --- a/src/main/java/org/apache/commons/io/input/Tailer.java +++ b/src/main/java/org/apache/commons/io/input/Tailer.java @@ -493,7 +493,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param reOpen whether to close/reopen the file between chunks. * @param bufferSize buffer size. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final Charset charset, final TailerListener listener, final long delayMillis, final boolean end, @@ -517,7 +517,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param file the file to follow. * @param listener the TailerListener to use. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final TailerListener listener) { @@ -536,7 +536,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param listener the TailerListener to use. * @param delayMillis the delay between checks of the file for new content in milliseconds. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final TailerListener listener, final long delayMillis) { @@ -557,7 +557,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param delayMillis the delay between checks of the file for new content in milliseconds. * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end) { @@ -580,7 +580,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @param reOpen whether to close/reopen the file between chunks. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen) { @@ -605,7 +605,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param reOpen whether to close/reopen the file between chunks. * @param bufferSize buffer size. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen, @@ -631,7 +631,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @param bufferSize buffer size. * @return The new tailer. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public static Tailer create(final File file, final TailerListener listener, final long delayMillis, final boolean end, final int bufferSize) { @@ -696,7 +696,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @param reOpen if true, close and reopen the file between reading chunks * @param bufSize Buffer size - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final Charset charset, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen, @@ -709,7 +709,7 @@ public class Tailer implements Runnable, AutoCloseable { * * @param file The file to follow. * @param listener the TailerListener to use. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final TailerListener listener) { @@ -722,7 +722,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param file the file to follow. * @param listener the TailerListener to use. * @param delayMillis the delay between checks of the file for new content in milliseconds. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final TailerListener listener, final long delayMillis) { @@ -736,7 +736,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param listener the TailerListener to use. * @param delayMillis the delay between checks of the file for new content in milliseconds. * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end) { @@ -751,7 +751,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param delayMillis the delay between checks of the file for new content in milliseconds. * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @param reOpen if true, close and reopen the file between reading chunks - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen) { @@ -767,7 +767,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @param reOpen if true, close and reopen the file between reading chunks * @param bufferSize Buffer size - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end, final boolean reOpen, final int bufferSize) { @@ -782,7 +782,7 @@ public class Tailer implements Runnable, AutoCloseable { * @param delayMillis the delay between checks of the file for new content in milliseconds. * @param end Set to true to tail from the end of the file, false to tail from the beginning of the file. * @param bufferSize Buffer size - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public Tailer(final File file, final TailerListener listener, final long delayMillis, final boolean end, final int bufferSize) { 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 aecf72e3..a3f489b2 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java @@ -164,7 +164,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream { * Creates a new byte array input stream. * * @param data the buffer - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public UnsynchronizedByteArrayInputStream(final byte[] data) { @@ -181,7 +181,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream { * @param offset the offset into the buffer * * @throws IllegalArgumentException if the offset is less than zero - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public UnsynchronizedByteArrayInputStream(final byte[] data, final int offset) { @@ -203,7 +203,7 @@ public class UnsynchronizedByteArrayInputStream extends InputStream { * @param length the length of the buffer * * @throws IllegalArgumentException if the offset or length less than zero - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public UnsynchronizedByteArrayInputStream(final byte[] data, final int offset, final int length) { 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 2e2f0f42..1e0c2f4a 100644 --- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java +++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java @@ -350,7 +350,7 @@ public class XmlStreamReader extends Reader { * @param file File to create a Reader from. * @throws NullPointerException if the input is {@code null}. * @throws IOException thrown if there is a problem reading the file. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamReader(final File file) throws IOException { @@ -369,7 +369,7 @@ public class XmlStreamReader extends Reader { * @param inputStream InputStream to create a Reader from. * @throws NullPointerException if the input stream is {@code null}. * @throws IOException thrown if there is a problem reading the stream. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamReader(final InputStream inputStream) throws IOException { @@ -405,7 +405,7 @@ public class XmlStreamReader extends Reader { * @throws NullPointerException if the input stream is {@code null}. * @throws IOException thrown if there is a problem reading the stream. * @throws XmlStreamReaderException thrown if the charset encoding could not be determined according to the specification. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamReader(final InputStream inputStream, final boolean lenient) throws IOException { @@ -442,7 +442,7 @@ public class XmlStreamReader extends Reader { * @throws NullPointerException if the input stream is {@code null}. * @throws IOException thrown if there is a problem reading the stream. * @throws XmlStreamReaderException thrown if the charset encoding could not be determined according to the specification. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") // InputStream is managed through a InputStreamReader in this instance. @@ -469,7 +469,7 @@ public class XmlStreamReader extends Reader { * @param httpContentType content-type header to use for the resolution of the charset encoding. * @throws NullPointerException if the input stream is {@code null}. * @throws IOException thrown if there is a problem reading the file. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamReader(final InputStream inputStream, final String httpContentType) throws IOException { @@ -507,7 +507,7 @@ public class XmlStreamReader extends Reader { * @throws NullPointerException if the input stream is {@code null}. * @throws IOException thrown if there is a problem reading the file. * @throws XmlStreamReaderException thrown if the charset encoding could not be determined according to the specification. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamReader(final InputStream inputStream, final String httpContentType, final boolean lenient) throws IOException { @@ -546,7 +546,7 @@ public class XmlStreamReader extends Reader { * @throws NullPointerException if the input stream is {@code null}. * @throws IOException thrown if there is a problem reading the file. * @throws XmlStreamReaderException thrown if the charset encoding could not be determined according to the specification. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") // InputStream is managed through a InputStreamReader in this instance. @@ -573,7 +573,7 @@ public class XmlStreamReader extends Reader { * @throws NullPointerException if the input is {@code null}. * @throws IOException thrown if there is a problem reading the file. * @since 2.11.0 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") // InputStream is managed through another reader in this instance. diff --git a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java index 581ae126..396fd360 100644 --- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java @@ -97,7 +97,7 @@ public class ChunkedOutputStream extends FilterOutputStream { * Creates a new stream that uses a chunk size of {@link IOUtils#DEFAULT_BUFFER_SIZE}. * * @param stream the stream to wrap - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public ChunkedOutputStream(final OutputStream stream) { @@ -110,7 +110,7 @@ public class ChunkedOutputStream extends FilterOutputStream { * @param stream the stream to wrap * @param chunkSize the chunk size to use; must be a positive number. * @throws IllegalArgumentException if the chunk size is <= 0 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public ChunkedOutputStream(final OutputStream stream, final int chunkSize) { 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 b732f142..66a3cabf 100644 --- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java @@ -200,7 +200,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream { * * @param threshold The number of bytes at which to trigger an event. * @param outputFile The file to which data is saved beyond the threshold. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public DeferredFileOutputStream(final int threshold, final File outputFile) { @@ -236,7 +236,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream { * @param initialBufferSize The initial size of the in memory buffer. * @param outputFile The file to which data is saved beyond the threshold. * @since 2.5 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public DeferredFileOutputStream(final int threshold, final int initialBufferSize, final File outputFile) { @@ -252,7 +252,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream { * @param suffix Suffix to use for the temporary file. * @param directory Temporary file directory. * @since 2.5 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public DeferredFileOutputStream(final int threshold, final int initialBufferSize, final String prefix, final String suffix, final File directory) { @@ -268,7 +268,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream { * @param suffix Suffix to use for the temporary file. * @param directory Temporary file directory. * @since 1.4 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public DeferredFileOutputStream(final int threshold, final String prefix, final String suffix, final File directory) { 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 45cb6dec..751f0e36 100644 --- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java +++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java @@ -183,7 +183,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param charset the encoding to use, not null * @throws NullPointerException if the file or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final File file, final Charset charset) throws IOException { @@ -198,7 +198,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param append true if content should be appended, false to overwrite. * @throws NullPointerException if the file is null. * @throws IOException in case of an I/O error. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") // Call site is responsible for closing a new instance. @@ -213,7 +213,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param charsetEncoder the encoding to use, not null * @throws NullPointerException if the file or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final File file, final CharsetEncoder charsetEncoder) throws IOException { @@ -228,7 +228,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param append true if content should be appended, false to overwrite. * @throws NullPointerException if the file is null. * @throws IOException in case of an I/O error. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") // Call site is responsible for closing a new instance. @@ -243,7 +243,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param charsetName the name of the requested charset, not null * @throws NullPointerException if the file or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final File file, final String charsetName) throws IOException { @@ -258,7 +258,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param append true if content should be appended, false to overwrite. * @throws NullPointerException if the file is null. * @throws IOException in case of an I/O error. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") // Call site is responsible for closing a new instance. @@ -277,7 +277,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param charset the charset to use, not null * @throws NullPointerException if the file name or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final String fileName, final Charset charset) throws IOException { @@ -292,7 +292,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param append true if content should be appended, false to overwrite * @throws NullPointerException if the file name or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final String fileName, final Charset charset, final boolean append) throws IOException { @@ -306,7 +306,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param encoding the encoding to use, not null * @throws NullPointerException if the file name or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final String fileName, final CharsetEncoder encoding) throws IOException { @@ -321,7 +321,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param append true if content should be appended, false to overwrite * @throws NullPointerException if the file name or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final String fileName, final CharsetEncoder charsetEncoder, final boolean append) throws IOException { @@ -335,7 +335,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param charsetName the name of the requested charset, not null * @throws NullPointerException if the file name or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final String fileName, final String charsetName) throws IOException { @@ -350,7 +350,7 @@ public class FileWriterWithEncoding extends ProxyWriter { * @param append true if content should be appended, false to overwrite * @throws NullPointerException if the file name or encoding is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public FileWriterWithEncoding(final String fileName, final String charsetName, final boolean append) throws IOException { 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 dd730e73..064de220 100644 --- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java +++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java @@ -158,7 +158,7 @@ public class LockableFileWriter extends Writer { * @param file the file to write to, not null * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final File file) throws IOException { @@ -172,7 +172,7 @@ public class LockableFileWriter extends Writer { * @param append true if content should be appended, false to overwrite * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final File file, final boolean append) throws IOException { @@ -202,7 +202,7 @@ public class LockableFileWriter extends Writer { * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error * @since 2.3 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final File file, final Charset charset) throws IOException { @@ -219,7 +219,7 @@ public class LockableFileWriter extends Writer { * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error * @since 2.3 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final File file, final Charset charset, final boolean append, final String lockDir) throws IOException { @@ -254,7 +254,7 @@ public class LockableFileWriter extends Writer { * @throws IOException in case of an I/O error * @throws java.nio.charset.UnsupportedCharsetException thrown instead of {@link java.io.UnsupportedEncodingException} in version 2.2 if the encoding is not * supported. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final File file, final String charsetName) throws IOException { @@ -272,7 +272,7 @@ public class LockableFileWriter extends Writer { * @throws IOException in case of an I/O error * @throws java.nio.charset.UnsupportedCharsetException thrown instead of {@link java.io.UnsupportedEncodingException} in version 2.2 if the encoding is not * supported. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final File file, final String charsetName, final boolean append, final String lockDir) throws IOException { @@ -285,7 +285,7 @@ public class LockableFileWriter extends Writer { * @param fileName the file to write to, not null * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final String fileName) throws IOException { @@ -299,7 +299,7 @@ public class LockableFileWriter extends Writer { * @param append true if content should be appended, false to overwrite * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final String fileName, final boolean append) throws IOException { @@ -314,7 +314,7 @@ public class LockableFileWriter extends Writer { * @param lockDir the directory in which the lock file should be held * @throws NullPointerException if the file is null * @throws IOException in case of an I/O error - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public LockableFileWriter(final String fileName, final boolean append, final String lockDir) throws 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 39604416..15f2fb71 100644 --- a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java @@ -134,7 +134,7 @@ public final class UnsynchronizedByteArrayOutputStream extends AbstractByteArray * Creates a new byte array output stream. The buffer capacity is initially * * {@value AbstractByteArrayOutputStream#DEFAULT_SIZE} bytes, though its size increases if necessary. - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public UnsynchronizedByteArrayOutputStream() { @@ -146,7 +146,7 @@ public final class UnsynchronizedByteArrayOutputStream extends AbstractByteArray * * @param size the initial size * @throws IllegalArgumentException if size is negative - * @deprecated Use {@link #builder()} and {@link Builder#get()}. + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}. */ @Deprecated public UnsynchronizedByteArrayOutputStream(final int size) { 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 8e67fc96..dc4cd6fd 100644 --- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java @@ -233,7 +233,7 @@ public class WriterOutputStream extends OutputStream { * characters. The output buffer will only be flushed when it overflows or when {@link #flush()} or {@link #close()} is called. * * @param writer the target {@link Writer} - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer) { @@ -246,7 +246,7 @@ public class WriterOutputStream extends OutputStream { * * @param writer the target {@link Writer} * @param charset the charset encoding - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer, final Charset charset) { @@ -262,7 +262,7 @@ public class WriterOutputStream extends OutputStream { * @param writeImmediately If {@code true} the output buffer will be flushed after each write operation, i.e. all available data will be written to the * underlying {@link Writer} immediately. If {@code false}, the output buffer will only be flushed when it overflows or when * {@link #flush()} or {@link #close()} is called. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer, final Charset charset, final int bufferSize, final boolean writeImmediately) { @@ -284,7 +284,7 @@ public class WriterOutputStream extends OutputStream { * @param writer the target {@link Writer} * @param decoder the charset decoder * @since 2.1 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer, final CharsetDecoder decoder) { @@ -301,7 +301,7 @@ public class WriterOutputStream extends OutputStream { * underlying {@link Writer} immediately. If {@code false}, the output buffer will only be flushed when it overflows or when * {@link #flush()} or {@link #close()} is called. * @since 2.1 - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer, final CharsetDecoder decoder, final int bufferSize, final boolean writeImmediately) { @@ -318,7 +318,7 @@ public class WriterOutputStream extends OutputStream { * * @param writer the target {@link Writer} * @param charsetName the name of the charset encoding - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer, final String charsetName) { @@ -334,7 +334,7 @@ public class WriterOutputStream extends OutputStream { * @param writeImmediately If {@code true} the output buffer will be flushed after each write operation, i.e. all available data will be written to the * underlying {@link Writer} immediately. If {@code false}, the output buffer will only be flushed when it overflows or when * {@link #flush()} or {@link #close()} is called. - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public WriterOutputStream(final Writer writer, final String charsetName, final int bufferSize, final boolean writeImmediately) { 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 53509447..b40a2aca 100644 --- a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java +++ b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java @@ -119,7 +119,7 @@ public class XmlStreamWriter extends Writer { * @param file The file to write to * @throws FileNotFoundException if there is an error creating or * opening the file - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamWriter(final File file) throws FileNotFoundException { @@ -134,7 +134,7 @@ public class XmlStreamWriter extends Writer { * @param defaultEncoding The default encoding if not encoding could be detected * @throws FileNotFoundException if there is an error creating or * opening the file - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated @SuppressWarnings("resource") @@ -147,7 +147,7 @@ public class XmlStreamWriter extends Writer { * with a default encoding of UTF-8. * * @param out The output stream - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamWriter(final OutputStream out) { @@ -172,7 +172,7 @@ public class XmlStreamWriter extends Writer { * * @param out The output stream * @param defaultEncoding The default encoding if not encoding could be detected - * @deprecated Use {@link #builder()} and {@link Builder#get()} + * @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()} */ @Deprecated public XmlStreamWriter(final OutputStream out, final String defaultEncoding) {