You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/01/15 16:29:44 UTC
(commons-compress) 05/06: Add missing Javadoc tag
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit dae7f9ec806982855ea84bdf8e442af7a9e2250d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Jan 15 11:11:11 2024 -0500
Add missing Javadoc tag
Normalize IOException description
---
.../archivers/zip/RandomAccessOutputStream.java | 29 ++++++++--------------
1 file changed, 10 insertions(+), 19 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/RandomAccessOutputStream.java b/src/main/java/org/apache/commons/compress/archivers/zip/RandomAccessOutputStream.java
index 6faa522d5..e47f4c632 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/RandomAccessOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/RandomAccessOutputStream.java
@@ -19,7 +19,6 @@ package org.apache.commons.compress.archivers.zip;
import java.io.IOException;
import java.io.OutputStream;
-
/**
* Abstraction over OutputStream which also allows random access writes.
*/
@@ -28,8 +27,8 @@ abstract class RandomAccessOutputStream extends OutputStream {
/**
* Provides current position in output.
*
- * @return
- * current position.
+ * @return current position.
+ * @throws IOException if an I/O error occurs
*/
public abstract long position() throws IOException;
@@ -41,28 +40,20 @@ abstract class RandomAccessOutputStream extends OutputStream {
/**
* Writes given data to specific position.
*
- * @param position
- * position in the stream
- * @param b
- * data to write
- * @param off
- * offset of the start of data in param b
- * @param len
- * the length of data to write
- * @throws IOException
- * when write fails.
+ * @param position position in the stream
+ * @param b data to write
+ * @param off offset of the start of data in param b
+ * @param len the length of data to write
+ * @throws IOException if an I/O error occurs.
*/
abstract void writeFully(byte[] b, int off, int len, long position) throws IOException;
/**
* Writes given data to specific position.
*
- * @param position
- * position in the stream
- * @param b
- * data to write
- * @throws IOException
- * when write fails.
+ * @param position position in the stream
+ * @param b data to write
+ * @throws IOException if an I/O error occurs.
*/
public void writeFully(final byte[] b, final long position) throws IOException {
writeFully(b, 0, b.length, position);