Skip to content

Commit 52fb5b2

Browse files
committed
Javadoc
1 parent 53d22fd commit 52fb5b2

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ public ProxyInputStream(final InputStream proxy) {
6464
* {@link #reset()}. You need to explicitly override those methods if
6565
* you want to add post-processing steps also to them.
6666
* </p>
67+
*
6768
* @since 2.0
6869
* @param n number of bytes read, or -1 if the end of stream was reached
6970
* @throws IOException if the post-processing fails
@@ -103,6 +104,7 @@ public int available() throws IOException {
103104
* {@link #reset()}. You need to explicitly override those methods if
104105
* you want to add pre-processing steps also to them.
105106
* </p>
107+
*
106108
* @since 2.0
107109
* @param n number of bytes that the caller asked to be read
108110
* @throws IOException if the pre-processing fails
@@ -114,6 +116,7 @@ protected void beforeRead(final int n) throws IOException {
114116

115117
/**
116118
* Invokes the delegate's {@code close()} method.
119+
*
117120
* @throws IOException if an I/O error occurs.
118121
*/
119122
@Override
@@ -127,6 +130,7 @@ public void close() throws IOException {
127130
* This method provides a point to implement custom exception
128131
* handling. The default behavior is to re-throw the exception.
129132
* </p>
133+
*
130134
* @param e The IOException thrown
131135
* @throws IOException if an I/O error occurs.
132136
* @since 2.0
@@ -137,6 +141,7 @@ protected void handleIOException(final IOException e) throws IOException {
137141

138142
/**
139143
* Invokes the delegate's {@code mark(int)} method.
144+
*
140145
* @param readLimit read ahead limit
141146
*/
142147
@Override
@@ -146,6 +151,7 @@ public synchronized void mark(final int readLimit) {
146151

147152
/**
148153
* Invokes the delegate's {@code markSupported()} method.
154+
*
149155
* @return true if mark is supported, otherwise false
150156
*/
151157
@Override
@@ -155,6 +161,7 @@ public boolean markSupported() {
155161

156162
/**
157163
* Invokes the delegate's {@code read()} method.
164+
*
158165
* @return the byte read or -1 if the end of stream
159166
* @throws IOException if an I/O error occurs.
160167
*/
@@ -173,6 +180,7 @@ public int read() throws IOException {
173180

174181
/**
175182
* Invokes the delegate's {@code read(byte[])} method.
183+
*
176184
* @param bts the buffer to read the bytes into
177185
* @return the number of bytes read or EOF if the end of stream
178186
* @throws IOException if an I/O error occurs.
@@ -192,6 +200,7 @@ public int read(final byte[] bts) throws IOException {
192200

193201
/**
194202
* Invokes the delegate's {@code read(byte[], int, int)} method.
203+
*
195204
* @param bts the buffer to read the bytes into
196205
* @param off The start offset
197206
* @param len The number of bytes to read
@@ -213,6 +222,7 @@ public int read(final byte[] bts, final int off, final int len) throws IOExcepti
213222

214223
/**
215224
* Invokes the delegate's {@code reset()} method.
225+
*
216226
* @throws IOException if an I/O error occurs.
217227
*/
218228
@Override
@@ -226,14 +236,15 @@ public synchronized void reset() throws IOException {
226236

227237
/**
228238
* Invokes the delegate's {@code skip(long)} method.
229-
* @param ln the number of bytes to skip
239+
*
240+
* @param n the number of bytes to skip
230241
* @return the actual number of bytes skipped
231242
* @throws IOException if an I/O error occurs.
232243
*/
233244
@Override
234-
public long skip(final long ln) throws IOException {
245+
public long skip(final long n) throws IOException {
235246
try {
236-
return in.skip(ln);
247+
return in.skip(n);
237248
} catch (final IOException e) {
238249
handleIOException(e);
239250
return 0;

0 commit comments

Comments
 (0)