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 e23680f118cb009d14f777f1c152d97dc6c53b95 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Fri May 19 10:38:50 2023 -0400 Javadoc --- .../apache/commons/io/output/UncheckedFilterWriter.java | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) 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 f4ad0d59..45c7f83a 100644 --- a/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java +++ b/src/main/java/org/apache/commons/io/output/UncheckedFilterWriter.java @@ -21,7 +21,10 @@ import java.io.FilterWriter; import java.io.IOException; import java.io.UncheckedIOException; import java.io.Writer; +import java.nio.charset.Charset; +import java.nio.file.OpenOption; +import org.apache.commons.io.build.AbstractOrigin; import org.apache.commons.io.build.AbstractStreamBuilder; import org.apache.commons.io.function.Uncheck; @@ -61,8 +64,17 @@ public final class UncheckedFilterWriter extends FilterWriter { /** * Constructs a new instance. + * <p> + * This builder use the aspects Writer and Charset. + * </p> + * <p> + * You must provide an origin that can be converted to a Writer by this builder, otherwise, this call will throw an + * {@link UnsupportedOperationException}. + * </p> * - * @throws UnsupportedOperationException if the origin cannot be converted to a Writer. + * @return a new instance. + * @throws UnsupportedOperationException if the origin cannot provide a Writer. + * @see AbstractOrigin#getWriter(Charset, OpenOption...) */ @SuppressWarnings("resource") @Override