Skip to content

Commit 059a07c

Browse files
author
Gary Gregory
committed
Javadoc nits.
1 parent 9a212e8 commit 059a07c

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ public class ObservableInputStream extends ProxyInputStream {
4343
*/
4444
public static abstract class Observer {
4545

46-
/** Called to indicate, that {@link InputStream#read()} has been invoked
46+
/**
47+
* Called to indicate, that {@link InputStream#read()} has been invoked
4748
* on the {@link ObservableInputStream}, and will return a value.
4849
* @param pByte The value, which is being returned. This will never be -1 (EOF),
4950
* because, in that case, {@link #finished()} will be invoked instead.
@@ -53,7 +54,8 @@ public void data(final int pByte) throws IOException {
5354
// noop
5455
}
5556

56-
/** Called to indicate, that {@link InputStream#read(byte[])}, or
57+
/**
58+
* Called to indicate that {@link InputStream#read(byte[])}, or
5759
* {@link InputStream#read(byte[], int, int)} have been called, and are about to
5860
* invoke data.
5961
* @param pBuffer The byte array, which has been passed to the read call, and where
@@ -66,7 +68,8 @@ public void data(final byte[] pBuffer, final int pOffset, final int pLength) thr
6668
// noop
6769
}
6870

69-
/** Called to indicate, that EOF has been seen on the underlying stream.
71+
/**
72+
* Called to indicate that EOF has been seen on the underlying stream.
7073
* This method may be called multiple times, if the reader keeps invoking
7174
* either of the read methods, and they will consequently keep returning
7275
* EOF.
@@ -76,15 +79,16 @@ public void finished() throws IOException {
7679
// noop
7780
}
7881

79-
/** Called to indicate, that the {@link ObservableInputStream} has been closed.
82+
/**
83+
* Called to indicate that the {@link ObservableInputStream} has been closed.
8084
* @throws IOException if an i/o-error occurs
8185
*/
8286
public void closed() throws IOException {
8387
// noop
8488
}
8589

8690
/**
87-
* Called to indicate, that an error occurred on the underlying stream.
91+
* Called to indicate that an error occurred on the underlying stream.
8892
* @param pException the exception to throw
8993
* @throws IOException if an i/o-error occurs
9094
*/

0 commit comments

Comments
 (0)