Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/input/ProxyInputStream.java

@@ -359,6 +359,9 @@ public synchronized void reset() throws IOException {
 
     /**
      * Sets the underlying input stream.
+     * <p>
+     * Use with caution.
+     * </p>
      *
      * @param in The input stream to set in {@link java.io.FilterInputStream#in}.
      * @return {@code this} instance.
@@ -389,7 +392,7 @@ public long skip(final long n) throws IOException {
     /**
      * Unwraps this instance by returning the underlying {@link InputStream}.
      * <p>
-     * Use with caution; useful to query the underlying {@link InputStream}.
+     * Use with caution.
      * </p>
      *
      * @return the underlying {@link InputStream}.

src/main/java/org/apache/commons/io/input/ProxyReader.java

@@ -260,6 +260,9 @@ public synchronized void reset() throws IOException {
 
     /**
      * Sets the underlying reader.
+     * <p>
+     * Use with caution.
+     * </p>
      *
      * @param in The input stream to set in {@code java.io.Reader#in}.
      * @return {@code this} instance.
@@ -291,7 +294,7 @@ public long skip(final long ln) throws IOException {
     /**
      * Unwraps this instance by returning the underlying {@link Reader}.
      * <p>
-     * Use with caution; useful to query the underlying {@link Reader}.
+     * Use with caution.
      * </p>
      *
      * @return the underlying {@link Reader}.

src/main/java/org/apache/commons/io/output/ProxyOutputStream.java

@@ -162,6 +162,9 @@ protected void handleIOException(final IOException e) throws IOException {
 
     /**
      * Sets the underlying output stream.
+     * <p>
+     * Use with caution.
+     * </p>
      *
      * @param out the underlying output stream.
      * @return {@code this} instance.
@@ -175,7 +178,7 @@ public ProxyOutputStream setReference(final OutputStream out) {
     /**
      * Unwraps this instance by returning the underlying {@link OutputStream}.
      * <p>
-     * Use with caution; useful to query the underlying {@link OutputStream}.
+     * Use with caution.
      * </p>
      *
      * @return the underlying {@link OutputStream}.

src/main/java/org/apache/commons/io/output/ProxyWriter.java

@@ -183,6 +183,9 @@ protected void handleIOException(final IOException e) throws IOException {
 
     /**
      * Sets the underlying writer.
+     * <p>
+     * Use with caution.
+     * </p>
      *
      * @param out the underlying output writer.
      * @return {@code this} instance.
@@ -196,7 +199,7 @@ public ProxyWriter setReference(final Writer out) {
     /**
      * Unwraps this instance by returning the underlying {@link Writer}.
      * <p>
-     * Use with caution; useful to query the underlying {@link Writer}.
+     * Use with caution.
      * </p>
      *
      * @return the underlying {@link Writer}.