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 cfb8f3c6 Javadoc
cfb8f3c6 is described below
commit cfb8f3c6eb1db354d4dc24f8d88ca68134392b41
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue May 2 17:42:31 2023 -0400
Javadoc
---
.../apache/commons/io/build/AbstractOrigin.java | 35 ++++++++++++++++++++++
.../commons/io/build/AbstractOriginSupplier.java | 6 ++++
.../commons/io/build/AbstractStreamBuilder.java | 6 ++++
3 files changed, 47 insertions(+)
diff --git a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
index 1e4ca524..cb793ab3 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
@@ -45,6 +45,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class FileOrigin extends AbstractOrigin<File, FileOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public FileOrigin(final File origin) {
super(origin);
}
@@ -69,6 +74,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class InputStreamOrigin extends AbstractOrigin<InputStream,
InputStreamOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public InputStreamOrigin(final InputStream origin) {
super(origin);
}
@@ -88,6 +98,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class OutputStreamOrigin extends
AbstractOrigin<OutputStream, OutputStreamOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public OutputStreamOrigin(final OutputStream origin) {
super(origin);
}
@@ -104,6 +119,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class PathOrigin extends AbstractOrigin<Path, PathOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public PathOrigin(final Path origin) {
super(origin);
}
@@ -128,6 +148,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class ReaderOrigin extends AbstractOrigin<Reader,
ReaderOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public ReaderOrigin(final Reader origin) {
super(origin);
}
@@ -143,6 +168,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class URIOrigin extends AbstractOrigin<URI, URIOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public URIOrigin(final URI origin) {
super(origin);
}
@@ -172,6 +202,11 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
*/
public static class WriterOrigin extends AbstractOrigin<Writer,
WriterOrigin> {
+ /**
+ * Constructs a new instance for the given origin.
+ *
+ * @param origin The origin.
+ */
public WriterOrigin(final Writer origin) {
super(origin);
}
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
index 6935e9e0..9f2c599a 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
@@ -44,6 +44,12 @@ import
org.apache.commons.io.build.AbstractOrigin.WriterOrigin;
*/
public abstract class AbstractOriginSupplier<T, B extends
AbstractOriginSupplier<T, B>> extends AbstractSupplier<T, B> {
+ /**
+ * Throws {@link IllegalArgumentException} if the initialBufferSize is
less than zero.
+ *
+ * @param initialBufferSize the value to test.
+ * @return the input value.
+ */
protected static int checkBufferSize(final int initialBufferSize) {
if (initialBufferSize < 0) {
throw new IllegalArgumentException("Initial buffer size must be at
least 0.");
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
index 3bc2f22d..c42aff52 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
@@ -31,6 +31,12 @@ import org.apache.commons.io.IOUtils;
*/
public abstract class AbstractStreamBuilder<T, B extends
AbstractStreamBuilder<T, B>> extends AbstractOriginSupplier<T, B> {
+ /**
+ * Throws {@link IllegalArgumentException} if the initialBufferSize is
less than zero.
+ *
+ * @param initialBufferSize the value to test.
+ * @return the input value.
+ */
protected static int checkBufferSize(final int initialBufferSize) {
if (initialBufferSize < 0) {
throw new IllegalArgumentException("Initial buffer size must be at
least 0.");
