ppkarwasz commented on code in PR #784:
URL: https://github.com/apache/commons-io/pull/784#discussion_r2371522649
##########
src/main/java/org/apache/commons/io/build/AbstractOrigin.java:
##########
@@ -53,15 +58,246 @@
import org.apache.commons.io.output.WriterOutputStream;
/**
- * Abstracts the origin of data for builders like a {@link File}, {@link
Path}, {@link Reader}, {@link Writer}, {@link InputStream}, {@link
OutputStream}, and
- * {@link URI}.
+ * Abstract base class that encapsulates the <em>origin</em> of data used by
Commons IO builders.
* <p>
- * Some methods may throw {@link UnsupportedOperationException} if that method
is not implemented in a concrete subclass, see {@link #getFile()} and
- * {@link #getPath()}.
+ * An origin represents where bytes/characters come from or go to, such as a
{@link File}, {@link Path},
+ * {@link Reader}, {@link Writer}, {@link InputStream}, {@link OutputStream},
or {@link URI}. Concrete subclasses
+ * expose only the operations that make sense for the underlying source or
sink; invoking an unsupported operation
+ * results in {@link UnsupportedOperationException} (see, for example, {@link
#getFile()} and {@link #getPath()}).
* </p>
*
- * @param <T> the type of instances to build.
- * @param <B> the type of builder subclass.
+ * <p>
+ * The table below summarizes which views and conversions are supported for
each origin type.
+ * Column headers show the target view; cells indicate whether that view is
available from the origin in that row.
+ * </p>
+ *
+ * <table>
+ * <caption>Origin support matrix</caption>
Review Comment:
In
https://github.com/apache/commons-io/pull/784/commits/ffb3780f46763c5330d61710e9d439a18e1f6f3e
I added an additional column, which summarizes what kind of `Channel` one can
expect from various origins.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
