Javadoc

Author: garydgregory

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 Path getPath() {
      */
     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 InputStream getInputStream(final OpenOption... options) {
      */
     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 OutputStream getOutputStream(final OpenOption... options) {
      */
     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 Path getPath() {
      */
     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 Reader getReader(final Charset charset) throws IOException {
      */
     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 Path getPath() {
      */
     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);
         }

src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java

@@ -44,6 +44,12 @@
  */
 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.");

src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java

@@ -31,6 +31,12 @@
  */
 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.");