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
commit 570c7969ff402de05f8024b9799ddc14e30e24ae
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu May 18 16:29:09 2023 -0400
Javadoc
---
.../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 ++++----
6 files changed, 38 insertions(+), 38 deletions(-)
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 f6a7b65b..51406373 100644
--- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
@@ -192,7 +192,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public DeferredFileOutputStream(final int threshold, final File
outputFile) {
@@ -227,7 +227,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public DeferredFileOutputStream(final int threshold, final int
initialBufferSize, final File outputFile) {
@@ -243,7 +243,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public DeferredFileOutputStream(final int threshold, final int
initialBufferSize, final String prefix, final String suffix, final File
directory) {
@@ -259,7 +259,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()}
+ * @deprecated Use {@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 6bab25fb..73b0d747 100644
--- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
+++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java
@@ -171,7 +171,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final File file, final Charset charset)
throws IOException {
@@ -186,7 +186,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
@SuppressWarnings("resource") // Call site is responsible for closing a
new instance.
@@ -201,7 +201,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final File file, final CharsetEncoder
charsetEncoder) throws IOException {
@@ -216,7 +216,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
@SuppressWarnings("resource") // Call site is responsible for closing a
new instance.
@@ -231,7 +231,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final File file, final String charsetName)
throws IOException {
@@ -246,7 +246,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
@SuppressWarnings("resource") // Call site is responsible for closing a
new instance.
@@ -265,7 +265,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final String fileName, final Charset
charset) throws IOException {
@@ -280,7 +280,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final String fileName, final Charset
charset, final boolean append) throws IOException {
@@ -294,7 +294,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final String fileName, final CharsetEncoder
encoding) throws IOException {
@@ -309,7 +309,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final String fileName, final CharsetEncoder
charsetEncoder, final boolean append) throws IOException {
@@ -323,7 +323,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public FileWriterWithEncoding(final String fileName, final String
charsetName) throws IOException {
@@ -338,7 +338,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()}
+ * @deprecated Use {@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 94cf2192..3ab9e0c8 100644
--- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
+++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
@@ -148,7 +148,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final File file) throws IOException {
@@ -162,7 +162,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final File file, final boolean append) throws
IOException {
@@ -192,7 +192,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final File file, final Charset charset) throws
IOException {
@@ -209,7 +209,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final File file, final Charset charset, final
boolean append, final String lockDir) throws IOException {
@@ -244,7 +244,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final File file, final String charsetName)
throws IOException {
@@ -262,7 +262,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final File file, final String charsetName, final
boolean append, final String lockDir) throws IOException {
@@ -275,7 +275,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final String fileName) throws IOException {
@@ -289,7 +289,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public LockableFileWriter(final String fileName, final boolean append)
throws IOException {
@@ -304,7 +304,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()}
+ * @deprecated Use {@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 7778578b..a3aaad54 100644
---
a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
+++
b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java
@@ -129,7 +129,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()}.
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}.
*/
@Deprecated
public UnsynchronizedByteArrayOutputStream() {
@@ -141,7 +141,7 @@ public final class UnsynchronizedByteArrayOutputStream
extends AbstractByteArray
*
* @param size the initial size
* @throws IllegalArgumentException if size is negative
- * @deprecated Use {@link #builder()}.
+ * @deprecated Use {@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 cccf736b..8e2eba4a 100644
--- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java
@@ -221,7 +221,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()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@Deprecated
public WriterOutputStream(final Writer writer) {
@@ -234,7 +234,7 @@ public class WriterOutputStream extends OutputStream {
*
* @param writer the target {@link Writer}
* @param charset the charset encoding
- * @deprecated Use {@link #builder()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@Deprecated
public WriterOutputStream(final Writer writer, final Charset charset) {
@@ -250,7 +250,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()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@Deprecated
public WriterOutputStream(final Writer writer, final Charset charset,
final int bufferSize, final boolean writeImmediately) {
@@ -272,7 +272,7 @@ public class WriterOutputStream extends OutputStream {
* @param writer the target {@link Writer}
* @param decoder the charset decoder
* @since 2.1
- * @deprecated Use {@link #builder()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@Deprecated
public WriterOutputStream(final Writer writer, final CharsetDecoder
decoder) {
@@ -289,7 +289,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()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@Deprecated
public WriterOutputStream(final Writer writer, final CharsetDecoder
decoder, final int bufferSize, final boolean writeImmediately) {
@@ -306,7 +306,7 @@ public class WriterOutputStream extends OutputStream {
*
* @param writer the target {@link Writer}
* @param charsetName the name of the charset encoding
- * @deprecated Use {@link #builder()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@Deprecated
public WriterOutputStream(final Writer writer, final String charsetName) {
@@ -322,7 +322,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()} instead
+ * @deprecated Use {@link #builder()} and {@link Builder#get()} instead
*/
@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 b574586e..df5be5c9 100644
--- a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
+++ b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java
@@ -109,7 +109,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public XmlStreamWriter(final File file) throws FileNotFoundException {
@@ -124,7 +124,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
@SuppressWarnings("resource")
@@ -137,7 +137,7 @@ public class XmlStreamWriter extends Writer {
* with a default encoding of UTF-8.
*
* @param out The output stream
- * @deprecated Use {@link #builder()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public XmlStreamWriter(final OutputStream out) {
@@ -162,7 +162,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()}
+ * @deprecated Use {@link #builder()} and {@link Builder#get()}
*/
@Deprecated
public XmlStreamWriter(final OutputStream out, final String
defaultEncoding) {
