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 1bdbb60ddb88ffa78f7f1a724fc4c7aff45bce20 Author: Gary D. Gregory <[email protected]> AuthorDate: Fri Feb 14 08:18:17 2025 -0500 Javadoc improvements --- .../io/input/MemoryMappedFileInputStream.java | 4 ++-- .../io/input/RandomAccessFileInputStream.java | 5 +++-- .../commons/io/input/ReadAheadInputStream.java | 4 ++-- .../apache/commons/io/input/ReaderInputStream.java | 7 +++--- .../commons/io/input/ReversedLinesFileReader.java | 4 ++-- .../commons/io/input/UncheckedBufferedReader.java | 5 +++-- .../io/input/UncheckedFilterInputStream.java | 5 +++-- .../commons/io/input/UncheckedFilterReader.java | 3 ++- .../input/UnsynchronizedBufferedInputStream.java | 2 +- .../input/UnsynchronizedByteArrayInputStream.java | 3 ++- .../io/input/UnsynchronizedFilterInputStream.java | 2 +- .../apache/commons/io/input/XmlStreamReader.java | 2 +- .../commons/io/monitor/FileAlterationObserver.java | 2 ++ .../commons/io/output/ChunkedOutputStream.java | 2 +- .../io/output/DeferredFileOutputStream.java | 2 +- .../commons/io/output/FileWriterWithEncoding.java | 2 +- .../commons/io/output/LockableFileWriter.java | 7 +++--- .../commons/io/output/ProxyOutputStream.java | 6 +++--- .../io/output/RandomAccessFileOutputStream.java | 25 ++++++++++++++++++++++ .../io/output/UncheckedFilterOutputStream.java | 4 ++-- .../commons/io/output/UncheckedFilterWriter.java | 5 +++-- .../UnsynchronizedByteArrayOutputStream.java | 2 +- .../commons/io/output/WriterOutputStream.java | 5 +++-- .../apache/commons/io/output/XmlStreamWriter.java | 4 ++-- .../serialization/ValidatingObjectInputStream.java | 21 ++++++++++++++++++ 25 files changed, 95 insertions(+), 38 deletions(-) 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 d1dc7c441..2472525e9 100644 --- a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java +++ b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java @@ -108,14 +108,14 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getPath()}</li> + * <li>{@link #getPath()} gets the target aspect.</li> * <li>{@link #getBufferSize()}</li> * </ul> * * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to a {@link Path}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link Path} using {@link #getPath()}. * @see #getPath() * @see #getBufferSize() * @see #getUnchecked() 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 8fd2b29e4..3e25bc625 100644 --- a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java +++ b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java @@ -77,7 +77,7 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link RandomAccessFile}</li> + * <li>{@link RandomAccessFile} gets the target aspect.</li> * <li>{@link File}</li> * <li>closeOnClose</li> * </ul> @@ -85,7 +85,8 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws IllegalStateException if both RandomAccessFile and origin are set. - * @throws UnsupportedOperationException if the origin cannot be converted to a {@link File}. + * @throws UnsupportedOperationException if the origin cannot be converted to a {@link RandomAccessFile}. + * @throws IOException if an I/O error occurs converting to an {@link RandomAccessFile} using {@link #getRandomAccessFile()}. * @see AbstractOrigin#getFile() * @see #getUnchecked() */ 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 cb08547fa..34ceab0bf 100644 --- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java @@ -87,7 +87,7 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getInputStream()}</li> + * <li>{@link #getInputStream()} gets the target aspect.</li> * <li>{@link #getBufferSize()}</li> * <li>{@link ExecutorService}</li> * </ul> @@ -95,7 +95,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}. * @see #getInputStream() * @see #getBufferSize() * @see #getUnchecked() 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 e12659a9a..5e40591db 100644 --- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java +++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java @@ -126,15 +126,16 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getReader()}</li> + * <li>{@link #getReader()} gets the target aspect.</li> * <li>{@link #getBufferSize()}</li> * <li>{@link #getCharset()}</li> * <li>{@link CharsetEncoder}</li> * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide a Reader. - * @throws IllegalStateException if the {@code origin} is {@code null}. + * @throws UnsupportedOperationException if the origin cannot provide a {@link Reader}. + * @throws IllegalStateException if the {@code origin} is {@code null}. + * @throws IOException if an I/O error occurs converting to a {@link Reader} using {@link #getReader()}. * @see #getReader() * @see CharsetEncoder * @see #getBufferSize() 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 d12aadf13..f49f7349e 100644 --- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java +++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java @@ -104,7 +104,7 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getInputStream()}</li> + * <li>{@link #getPath()} gets the target aspect.</li> * <li>{@link #getBufferSize()}</li> * <li>{@link #getCharset()}</li> * </ul> @@ -112,7 +112,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to a {@link Path}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to a {@link Path} using {@link #getPath()}. * @see #getPath() * @see #getBufferSize() * @see #getCharset() 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 78e839c02..a399226b1 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java @@ -87,17 +87,18 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getReader()}</li> + * <li>{@link #getReader()} gets the target aspect.</li> * <li>{@link #getBufferSize()}</li> * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide a Reader. + * @throws UnsupportedOperationException if the origin cannot provide a {@link Reader}. * @throws IllegalStateException if the {@code origin} is {@code null}. * @see #getReader() * @see #getBufferSize() * @see #getUnchecked() */ + @SuppressWarnings("resource") @Override public UncheckedBufferedReader get() { // This an unchecked class, so this method is as well. 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 0739f4cc9..fd0451f3a 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java @@ -82,14 +82,15 @@ public Builder() { * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getInputStream()}</li> + * <li>{@link #getInputStream()} gets the target aspect.</li> * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide an InputStream. + * @throws UnsupportedOperationException if the origin cannot provide an {@link #getInputStream()}. * @see #getInputStream() * @see #getUnchecked() */ + @SuppressWarnings("resource") @Override public UncheckedFilterInputStream get() { // This an unchecked class, so this method is as well. 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 1835b6eac..185b18be6 100644 --- a/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java +++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterReader.java @@ -86,11 +86,12 @@ public Builder() { * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide a Reader. + * @throws UnsupportedOperationException if the origin cannot provide a {@link Reader}. * @throws IllegalStateException if the {@code origin} is {@code null}. * @see #getReader() * @see #getUnchecked() */ + @SuppressWarnings("resource") @Override public UncheckedFilterReader get() { // This an unchecked class, so this method is as well. 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 74e464c8c..f4ed2d120 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java @@ -106,7 +106,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}. * @see #getInputStream() * @see #getBufferSize() * @see #getUnchecked() 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 d7229ddd8..874e18543 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedByteArrayInputStream.java @@ -106,8 +106,9 @@ public Builder() { * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide a byte[]. + * @throws UnsupportedOperationException if the origin cannot provide a {@code byte[]}. * @throws IllegalStateException if the {@code origin} is {@code null}. + * @throws IOException if an I/O error occurs converting to an {@code byte[]} using {@link AbstractOrigin#getByteArray()}. * @see AbstractOrigin#getByteArray() * @see #getUnchecked() */ 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 bf2156e29..7589f9d08 100644 --- a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java +++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java @@ -92,7 +92,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}. * @see #getInputStream() * @see #getUnchecked() */ 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 04c46982b..d60b71607 100644 --- a/src/main/java/org/apache/commons/io/input/XmlStreamReader.java +++ b/src/main/java/org/apache/commons/io/input/XmlStreamReader.java @@ -148,7 +148,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link InputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}. * @throws XmlStreamReaderException thrown if the Charset encoding could not be determined according to the specification. * @see #getInputStream() * @see #getUnchecked() diff --git a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java index 330fe3417..bfab0305c 100644 --- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java +++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java @@ -30,6 +30,7 @@ import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOCase; +import org.apache.commons.io.build.AbstractOrigin; import org.apache.commons.io.build.AbstractOriginSupplier; import org.apache.commons.io.comparator.NameFileComparator; import org.apache.commons.io.filefilter.TrueFileFilter; @@ -144,6 +145,7 @@ private Builder() { /** * Gets a new {@link FileAlterationObserver} instance. * + * @throws IOException if an I/O error occurs converting to an {@link File} using {@link AbstractOrigin#getFile()}. * @see #getUnchecked() */ @Override 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 1b048a24b..a89da0296 100644 --- a/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ChunkedOutputStream.java @@ -74,7 +74,7 @@ public Builder() { /** * Builds a new {@link UnsynchronizedByteArrayOutputStream}. * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getOutputStream()} is the target aspect.</li> 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 de3f0afb4..50b2d18a8 100644 --- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java @@ -94,7 +94,7 @@ public Builder() { /** * Builds a new {@link DeferredFileOutputStream}. * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getBufferSize()}</li> 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 d41b5280a..25adddec7 100644 --- a/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java +++ b/src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java @@ -100,7 +100,7 @@ public Builder() { * You must set an aspect that supports {@link File} on this builder, otherwise, this method throws an exception. * </p> * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link File} is the target aspect.</li> 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 f91cd1c28..1f578ca52 100644 --- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java +++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java @@ -90,10 +90,10 @@ public Builder() { * You must set an aspect that supports {@link File} on this builder, otherwise, this method throws an exception. * </p> * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> - * <li>{@link File}</li> + * <li>{@link File} is the target aspect.</li> * <li>{@link #getCharset()}</li> * <li>append</li> * <li>lockDirectory</li> @@ -101,7 +101,8 @@ public Builder() { * * @return a new instance. * @throws UnsupportedOperationException if the origin cannot provide a File. - * @throws IllegalStateException if the {@code origin} is {@code null}. + * @throws IllegalStateException if the {@code origin} is {@code null}. + * @throws IOException if an I/O error occurs converting to an {@link File} using {@link #getFile()}. * @see AbstractOrigin#getFile() * @see #getUnchecked() */ diff --git a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java index 3606607d5..05ad0c8c4 100644 --- a/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/ProxyOutputStream.java @@ -55,16 +55,16 @@ public Builder() { /** * Builds a new {@link ProxyOutputStream}. * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> - * <li>{@link #getOutputStream()}</li> + * <li>{@link #getOutputStream()} is the target aspect.</li> * </ul> * * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link OutputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link OutputStream} using {@link #getOutputStream()}. * @see #getOutputStream() * @see #getUnchecked() */ diff --git a/src/main/java/org/apache/commons/io/output/RandomAccessFileOutputStream.java b/src/main/java/org/apache/commons/io/output/RandomAccessFileOutputStream.java index 5274e7c76..f2f61d1d2 100644 --- a/src/main/java/org/apache/commons/io/output/RandomAccessFileOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/RandomAccessFileOutputStream.java @@ -17,12 +17,14 @@ package org.apache.commons.io.output; +import java.io.File; import java.io.IOException; import java.io.OutputStream; import java.io.RandomAccessFile; import java.nio.file.StandardOpenOption; import java.util.Objects; +import org.apache.commons.io.build.AbstractOrigin; import org.apache.commons.io.build.AbstractStreamBuilder; /** @@ -60,6 +62,29 @@ private Builder() { setOpenOptions(StandardOpenOption.WRITE); } + /** + * Builds a new {@link RandomAccessFileOutputStream}. + * <p> + * You must set an aspect that supports {@link RandomAccessFile} or {@link File}, otherwise, this method throws an exception. Only set one of + * RandomAccessFile or an origin that can be converted to a File. + * </p> + * <p> + * This builder uses the following aspects: + * </p> + * <ul> + * <li>{@link RandomAccessFile} is the target aspect.</li> + * <li>{@link File}</li> + * <li>closeOnClose</li> + * </ul> + * + * @return a new instance. + * @throws IllegalStateException if the {@code origin} is {@code null}. + * @throws IllegalStateException if both RandomAccessFile and origin are set. + * @throws UnsupportedOperationException if the origin cannot be converted to a {@link RandomAccessFile}. + * @throws IOException if an I/O error occurs converting to an {@link RandomAccessFile} using {@link #getRandomAccessFile()}. + * @see AbstractOrigin#getFile() + * @see #getUnchecked() + */ @Override public RandomAccessFileOutputStream get() throws IOException { return new RandomAccessFileOutputStream(getRandomAccessFile()); 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 2c1bdb44c..4f8ca18e8 100644 --- a/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterOutputStream.java @@ -77,7 +77,7 @@ public Builder() { * You must set an aspect that supports {@link #getOutputStream()} on this builder, otherwise, this method throws an exception. * </p> * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getOutputStream()}</li> @@ -86,7 +86,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link OutputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link OutputStream} using {@link #getOutputStream()}. * @see #getOutputStream() * @see #getUnchecked() */ 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 8104036b6..ba53a0fcd 100644 --- a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java +++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java @@ -78,14 +78,15 @@ public Builder() { * You must set an aspect that supports {@link #getWriter()} on this builder, otherwise, this method throws an exception. * </p> * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getWriter()}</li> * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide a Writer. + * @throws UnsupportedOperationException if the origin cannot provide a {@link Writer}. + * @throws IOException if an I/O error occurs converting to an {@link Writer} using {@link #getWriter()}. * @see #getWriter() * @see #getUnchecked() */ 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 88f808eb8..3c3b46cb7 100644 --- a/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/UnsynchronizedByteArrayOutputStream.java @@ -75,7 +75,7 @@ public Builder() { * Builds a new {@link UnsynchronizedByteArrayOutputStream}. * * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getBufferSize()}</li> 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 0254a02bf..bd1278a08 100644 --- a/src/main/java/org/apache/commons/io/output/WriterOutputStream.java +++ b/src/main/java/org/apache/commons/io/output/WriterOutputStream.java @@ -120,7 +120,7 @@ public Builder() { * You must set an aspect that supports {@link #getWriter()} on this builder, otherwise, this method throws an exception. * </p> * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getWriter()}</li> @@ -130,7 +130,8 @@ public Builder() { * </ul> * * @return a new instance. - * @throws UnsupportedOperationException if the origin cannot provide a Writer. + * @throws UnsupportedOperationException if the origin cannot provide a {@link Writer}. + * @throws IOException if an I/O error occurs converting to an {@link Writer} using {@link #getWriter()}. * @see #getWriter() * @see #getUnchecked() */ 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 196516900..e6389631b 100644 --- a/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java +++ b/src/main/java/org/apache/commons/io/output/XmlStreamWriter.java @@ -81,7 +81,7 @@ public Builder() { * You must set an aspect that supports {@link #getOutputStream()} on this builder, otherwise, this method throws an exception. * </p> * <p> - * This builder use the following aspects: + * This builder uses the following aspects: * </p> * <ul> * <li>{@link #getOutputStream()}</li> @@ -91,7 +91,7 @@ public Builder() { * @return a new instance. * @throws IllegalStateException if the {@code origin} is {@code null}. * @throws UnsupportedOperationException if the origin cannot be converted to an {@link OutputStream}. - * @throws IOException if an I/O error occurs. + * @throws IOException if an I/O error occurs converting to an {@link OutputStream} using {@link #getOutputStream()}. * @see #getOutputStream() * @see #getUnchecked() */ diff --git a/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java b/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java index d627d6f8f..cb98cad5a 100644 --- a/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java +++ b/src/main/java/org/apache/commons/io/serialization/ValidatingObjectInputStream.java @@ -165,6 +165,27 @@ public Builder accept(final String... patterns) { return this; } + /** + * Builds a new {@link ValidatingObjectInputStream}. + * <p> + * You must set an aspect that supports {@link #getInputStream()} on this builder, otherwise, this method throws an exception. + * </p> + * <p> + * This builder uses the following aspects: + * </p> + * <ul> + * <li>{@link #getInputStream()} gets the target aspect.</li> + * <li>predicate</li> + * <li>charsetDecoder</li> + * <li>writeImmediately</li> + * </ul> + * + * @return a new instance. + * @throws UnsupportedOperationException if the origin cannot provide a {@link InputStream}. + * @throws IOException if an I/O error occurs converting to an {@link InputStream} using {@link #getInputStream()}. + * @see #getWriter() + * @see #getUnchecked() + */ @Override public ValidatingObjectInputStream get() throws IOException { return new ValidatingObjectInputStream(getInputStream(), predicate);
