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
The following commit(s) were added to refs/heads/master by this push:
new 5814fb159 Javadoc
5814fb159 is described below
commit 5814fb1594df9af809c0d80b8f330911a0c83771
Author: Gary D. Gregory <[email protected]>
AuthorDate: Sun Apr 27 10:26:43 2025 -0400
Javadoc
---
.../commons/compress/archivers/dump/DumpArchiveInputStream.java | 6 +++---
.../apache/commons/compress/archivers/dump/TapeInputStream.java | 6 +++---
.../commons/compress/archivers/tar/TarArchiveInputStream.java | 2 +-
.../java/org/apache/commons/compress/archivers/tar/TarFile.java | 2 +-
.../apache/commons/compress/archivers/zip/ExtraFieldUtils.java | 2 +-
.../commons/compress/archivers/zip/ZipArchiveInputStream.java | 2 +-
.../apache/commons/compress/compressors/lzw/LZWInputStream.java | 2 +-
.../compressors/snappy/FramedSnappyCompressorInputStream.java | 2 +-
.../commons/compress/harmony/pack200/NewAttributeBands.java | 6 +++---
.../commons/compress/harmony/unpack200/NewAttributeBands.java | 8 ++++----
10 files changed, 19 insertions(+), 19 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
index 232fce28b..67db871fe 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
@@ -416,7 +416,7 @@ public int read(final byte[] buf, int off, int len) throws
IOException {
}
/**
- * Read BITS segment.
+ * Reads BITS segment.
*/
private void readBITS() throws IOException {
final byte[] buffer = raw.readRecord();
@@ -439,7 +439,7 @@ private void readBITS() throws IOException {
}
/**
- * Read CLRI (deleted inode) segment.
+ * Reads CLRI (deleted inode) segment.
*/
private void readCLRI() throws IOException {
final byte[] buffer = raw.readRecord();
@@ -462,7 +462,7 @@ private void readCLRI() throws IOException {
}
/**
- * Read directory entry.
+ * Reads directory entry.
*/
private void readDirectoryEntry(DumpArchiveEntry entry) throws IOException
{
long size = entry.getEntrySize();
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
index d18e19f53..fbbf4111c 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
@@ -170,7 +170,7 @@ public int read(final byte[] b, int off, final int len)
throws IOException {
}
/**
- * Read next block. All decompression is handled here.
+ * Reads next block. All decompression is handled here.
*
* @param decompress if false the buffer will not be decompressed. This is
an optimization for longer seeks.
*/
@@ -242,7 +242,7 @@ private void readBlock(final boolean decompress) throws
IOException {
}
/**
- * Read buffer
+ * Reads buffer
*/
private void readFully(final byte[] b, final int off, final int len)
throws IOException {
final int count = IOUtils.readFully(in, b, off, len);
@@ -260,7 +260,7 @@ private byte[] readRange(final int len) throws IOException {
}
/**
- * Read a record from the input stream and return the data.
+ * Reads a record from the input stream and return the data.
*
* @return The record data.
* @throws IOException on error
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
index d979e4b59..7761c6362 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
@@ -693,7 +693,7 @@ private void readOldGNUSparse() throws IOException {
}
/**
- * Read a record from the input stream and return the data.
+ * Reads a record from the input stream and return the data.
*
* @return The record data or null if EOF has been hit.
* @throws IOException on error
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarFile.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarFile.java
index ea62570bc..b28037860 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarFile.java
@@ -660,7 +660,7 @@ private void readOldGNUSparse() throws IOException {
}
/**
- * Read a record from the input stream and return the data.
+ * Reads a record from the input stream and return the data.
*
* @return The record data or null if EOF has been hit.
* @throws IOException if reading from the archive fails
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
index 0ec851f75..59fcb856c 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
@@ -67,7 +67,7 @@ public static final class UnparseableExtraField implements
UnparseableExtraField
public static final UnparseableExtraField SKIP = new
UnparseableExtraField(SKIP_KEY);
/**
- * Read the extra field data into an instance of {@link
UnparseableExtraFieldData UnparseableExtraFieldData}.
+ * Reads the extra field data into an instance of {@link
UnparseableExtraFieldData UnparseableExtraFieldData}.
*/
public static final UnparseableExtraField READ = new
UnparseableExtraField(READ_KEY);
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
index ff433499b..1f2efd402 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
@@ -536,7 +536,7 @@ private boolean currentEntryHasOutstandingBytes() {
}
/**
- * Read all data of the current entry from the underlying stream that
hasn't been read, yet.
+ * Reads all data of the current entry from the underlying stream that
hasn't been read, yet.
*/
private void drainCurrentEntryData() throws IOException {
long remaining = current.entry.getCompressedSize() -
current.bytesReadFromStream;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
index 2fd3432e8..eb4c7b92d 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
@@ -126,7 +126,7 @@ public void close() throws IOException {
}
/**
- * Read the next code and expand it.
+ * Reads the next code and expand it.
*
* @return the expanded next code, negative on EOF
* @throws IOException on error
diff --git
a/src/main/java/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.java
index 1c82b27ec..1a2a6bad4 100644
---
a/src/main/java/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/snappy/FramedSnappyCompressorInputStream.java
@@ -280,7 +280,7 @@ private void readNextBlock() throws IOException {
}
/**
- * Read from the current chunk into the given array.
+ * Reads from the current chunk into the given array.
*
* @return -1 if there is no current chunk or the number of bytes read
from the current chunk (which may be -1 if the end of the chunk is reached).
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
index 736481e1a..f3a6b9a52 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
@@ -647,7 +647,7 @@ private void parseLayout() throws IOException {
}
/**
- * Read a 'body' section of the layout from the given stream
+ * Reads a 'body' section of the layout from the given stream
*
* @param reader
* @return List of LayoutElements
@@ -777,7 +777,7 @@ private LayoutElement readNextLayoutElement(final
StringReader reader) throws IO
}
/**
- * Read a UnionCase from the stream
+ * Reads a UnionCase from the stream
*
* @param reader
* @return
@@ -814,7 +814,7 @@ private UnionCase readNextUnionCase(final StringReader
reader) throws IOExceptio
}
/**
- * Read a number from the stream and return it
+ * Reads a number from the stream and return it
*
* @param stream
* @return
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
index 7d36e3a8b..ff6c44ba1 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
@@ -63,7 +63,7 @@ private interface AttributeLayoutElement {
void addToAttribute(int index, NewAttribute attribute);
/**
- * Read the bands associated with this part of the layout.
+ * Reads the bands associated with this part of the layout.
*
* @param in TODO
* @param count TODO
@@ -728,7 +728,7 @@ public void read(final InputStream in) throws IOException,
Pack200Exception {
}
/**
- * Read a 'body' section of the layout from the given stream
+ * Reads a 'body' section of the layout from the given stream
*
* @param stream
* @return List of LayoutElements
@@ -836,7 +836,7 @@ private LayoutElement readNextLayoutElement(final
StringReader stream) throws IO
}
/**
- * Read a UnionCase from the stream.
+ * Reads a UnionCase from the stream.
*
* @param stream source stream.
* @return A UnionCase from the stream.
@@ -873,7 +873,7 @@ private UnionCase readNextUnionCase(final StringReader
stream) throws IOExceptio
}
/**
- * Read a number from the stream and return it
+ * Reads a number from the stream and return it
*
* @param stream
* @return
