Skip to content

Commit 350a4bf

Browse files
committed
Javadoc
1 parent faac372 commit 350a4bf

4 files changed

Lines changed: 8 additions & 10 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import org.apache.commons.io.function.IOIntConsumer;
2828

2929
/**
30-
* A proxy stream which acts as a {@link FilterInputStream}, by passing all method calls on to the proxied stream, not changing which methods are called.
30+
* An input stream proxy which delegates to the wrapped input stream.
3131
* <p>
3232
* It is an alternative base class to {@link FilterInputStream} to increase reusability, because {@link FilterInputStream} changes the methods being called,
3333
* such as read(byte[]) to read(byte[], int, int).

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@
2626
import org.apache.commons.io.IOUtils;
2727

2828
/**
29-
* A Proxy stream which acts as expected, that is it passes the method
30-
* calls on to the proxied stream and doesn't change which methods are
31-
* being called.
29+
* A reader proxy which delegates to the wrapped reader.
3230
* <p>
3331
* It is an alternative base class to FilterReader
3432
* to increase reusability, because FilterReader changes the

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@
2525
import org.apache.commons.io.build.AbstractStreamBuilder;
2626

2727
/**
28-
* A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called. It is
29-
* an alternative base class to FilterOutputStream to increase reusability.
28+
* An output stream proxy which delegates to the wrapped output stream.
3029
* <p>
3130
* See the protected methods for ways in which a subclass can easily decorate a stream with custom pre-, post- or error processing functionality.
3231
* </p>

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@
2323
import org.apache.commons.io.IOUtils;
2424

2525
/**
26-
* A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't
27-
* change which methods are being called. It is an alternative base class to FilterWriter to increase reusability,
28-
* because FilterWriter changes the methods being called, such as {@code write(char[]) to write(char[], int, int)}
29-
* and {@code write(String) to write(String, int, int)}.
26+
* A writer proxy which delegates to the wrapped writer.
27+
* <p>
28+
* It is an alternative base class to FilterWriter to increase reusability, because FilterWriter changes the methods being called, such as
29+
* {@code write(char[]) to write(char[], int, int)} and {@code write(String) to write(String, int, int)}.
30+
* </p>
3031
*/
3132
public class ProxyWriter extends FilterWriter {
3233

0 commit comments

Comments
 (0)