Skip to content

Commit 202ffe2

Browse files
committed
Use the same parameter names as in the superclass
Javadoc
1 parent fab1b2c commit 202ffe2

File tree

1 file changed

+28
-19
lines changed

1 file changed

+28
-19
lines changed

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

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public ProxyOutputStream get() throws IOException {
8484
/**
8585
* Constructs a new ProxyOutputStream.
8686
*
87-
* @param delegate the OutputStream to delegate to
87+
* @param delegate the OutputStream to delegate to.
8888
*/
8989
public ProxyOutputStream(final OutputStream delegate) {
9090
// the delegate is stored in a protected superclass variable named 'out'
@@ -100,9 +100,10 @@ public ProxyOutputStream(final OutputStream delegate) {
100100
* Subclasses can override this method to add common post-processing
101101
* functionality without having to override all the write methods.
102102
* The default implementation does nothing.
103+
* </p>
103104
*
104-
* @param n number of bytes written
105-
* @throws IOException if the post-processing fails
105+
* @param n number of bytes written.
106+
* @throws IOException if the post-processing fails.
106107
* @since 2.0
107108
*/
108109
@SuppressWarnings("unused") // Possibly thrown from subclasses.
@@ -118,9 +119,10 @@ protected void afterWrite(final int n) throws IOException {
118119
* Subclasses can override this method to add common pre-processing
119120
* functionality without having to override all the write methods.
120121
* The default implementation does nothing.
122+
* </p>
121123
*
122-
* @param n number of bytes to be written
123-
* @throws IOException if the pre-processing fails
124+
* @param n number of bytes to be written.
125+
* @throws IOException if the pre-processing fails.
124126
* @since 2.0
125127
*/
126128
@SuppressWarnings("unused") // Possibly thrown from subclasses.
@@ -130,6 +132,7 @@ protected void beforeWrite(final int n) throws IOException {
130132

131133
/**
132134
* Invokes the delegate's {@code close()} method.
135+
*
133136
* @throws IOException if an I/O error occurs.
134137
*/
135138
@Override
@@ -139,6 +142,7 @@ public void close() throws IOException {
139142

140143
/**
141144
* Invokes the delegate's {@code flush()} method.
145+
*
142146
* @throws IOException if an I/O error occurs.
143147
*/
144148
@Override
@@ -153,9 +157,11 @@ public void flush() throws IOException {
153157
/**
154158
* Handle any IOExceptions thrown.
155159
* <p>
156-
* This method provides a point to implement custom exception
160+
* This method provides a point to implement custom exception.
157161
* handling. The default behavior is to re-throw the exception.
158-
* @param e The IOException thrown
162+
* </p>
163+
*
164+
* @param e The IOException thrown.
159165
* @throws IOException if an I/O error occurs.
160166
* @since 2.0
161167
*/
@@ -189,15 +195,16 @@ OutputStream unwrap() {
189195

190196
/**
191197
* Invokes the delegate's {@code write(byte[])} method.
192-
* @param bts the bytes to write
198+
*
199+
* @param b the bytes to write.
193200
* @throws IOException if an I/O error occurs.
194201
*/
195202
@Override
196-
public void write(final byte[] bts) throws IOException {
203+
public void write(final byte[] b) throws IOException {
197204
try {
198-
final int len = IOUtils.length(bts);
205+
final int len = IOUtils.length(b);
199206
beforeWrite(len);
200-
out.write(bts);
207+
out.write(b);
201208
afterWrite(len);
202209
} catch (final IOException e) {
203210
handleIOException(e);
@@ -206,25 +213,27 @@ public void write(final byte[] bts) throws IOException {
206213

207214
/**
208215
* Invokes the delegate's {@code write(byte[])} method.
209-
* @param bts the bytes to write
210-
* @param st The start offset
211-
* @param end The number of bytes to write
216+
*
217+
* @param b the bytes to write.
218+
* @param off The start offset.
219+
* @param len The number of bytes to write.
212220
* @throws IOException if an I/O error occurs.
213221
*/
214222
@Override
215-
public void write(final byte[] bts, final int st, final int end) throws IOException {
223+
public void write(final byte[] b, final int off, final int len) throws IOException {
216224
try {
217-
beforeWrite(end);
218-
out.write(bts, st, end);
219-
afterWrite(end);
225+
beforeWrite(len);
226+
out.write(b, off, len);
227+
afterWrite(len);
220228
} catch (final IOException e) {
221229
handleIOException(e);
222230
}
223231
}
224232

225233
/**
226234
* Invokes the delegate's {@code write(int)} method.
227-
* @param b the byte to write
235+
*
236+
* @param b the byte to write.
228237
* @throws IOException if an I/O error occurs.
229238
*/
230239
@Override

0 commit comments

Comments
 (0)