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 38f4aac5d Fix grammar issues and typos (#687)
38f4aac5d is described below
commit 38f4aac5d91b56bbe376302a807d82648f6a0893
Author: Martin Wiesner <mawie...@users.noreply.github.com>
AuthorDate: Wed Sep 17 20:43:32 2025 +0200
Fix grammar issues and typos (#687)
* Fix grammar issues and typos
- fixes some grammar issues, mainly in JavaDoc and in examples.xml
- gets rid of several typos
* Addresses reviewer's feedback.
* Update Javadoc for ExceptionTableEntry constructor
Clarify the documentation for ExceptionTableEntry constructor.
---------
Co-authored-by: Gary Gregory <garydgreg...@users.noreply.github.com>
---
.../compress/archivers/dump/DumpArchiveException.java | 2 +-
.../commons/compress/archivers/sevenz/SevenZFile.java | 4 ++--
.../archivers/sevenz/SevenZMethodConfiguration.java | 4 ++--
.../commons/compress/archivers/tar/TarArchiveEntry.java | 2 +-
.../compress/archivers/tar/TarArchiveInputStream.java | 2 +-
.../compress/archivers/tar/TarArchiveOutputStream.java | 6 +++---
.../compress/archivers/tar/TarArchiveStructSparse.java | 2 +-
.../compress/archivers/zip/ExplodingInputStream.java | 2 +-
.../commons/compress/archivers/zip/GeneralPurposeBit.java | 4 ++--
.../commons/compress/archivers/zip/PKWareExtraHeader.java | 2 +-
.../archivers/zip/X0017_StrongEncryptionHeader.java | 2 +-
.../zip/X0019_EncryptionRecipientCertificateList.java | 2 +-
.../commons/compress/archivers/zip/X7875_NewUnix.java | 2 +-
.../compress/archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../org/apache/commons/compress/archivers/zip/ZipFile.java | 14 +++++++-------
.../apache/commons/compress/archivers/zip/ZipIoUtil.java | 4 ++--
.../compress/archivers/zip/ZipSplitOutputStream.java | 2 +-
.../archivers/zip/ZipSplitReadOnlySeekableByteChannel.java | 4 ++--
.../org/apache/commons/compress/archivers/zip/ZipUtil.java | 4 ++--
.../org/apache/commons/compress/changes/ChangeSet.java | 2 +-
.../commons/compress/compressors/gzip/ExtraField.java | 4 ++--
.../compressors/gzip/GzipCompressorInputStream.java | 2 +-
.../commons/compress/compressors/gzip/GzipParameters.java | 2 +-
.../compress/compressors/lz77support/LZ77Compressor.java | 6 +++---
.../commons/compress/compressors/lzw/LZWInputStream.java | 4 ++--
.../commons/compress/compressors/pack200/Pack200Utils.java | 4 ++--
.../compressors/zstandard/ZstdCompressorOutputStream.java | 4 ++--
.../apache/commons/compress/harmony/pack200/CpBands.java | 4 ++--
.../apache/commons/compress/harmony/unpack200/Archive.java | 2 +-
.../compress/harmony/unpack200/Pack200UnpackerAdapter.java | 2 +-
.../harmony/unpack200/bytecode/ExceptionTableEntry.java | 9 +++++----
.../compress/utils/CloseShieldFilterInputStream.java | 2 +-
.../apache/commons/compress/utils/CountingInputStream.java | 2 +-
.../org/apache/commons/compress/utils/FileNameUtils.java | 4 ++--
.../compress/utils/FixedLengthBlockOutputStream.java | 2 +-
.../compress/utils/MultiReadOnlySeekableByteChannel.java | 6 +++---
.../compress/utils/SeekableInMemoryByteChannel.java | 8 ++++----
.../commons/compress/utils/SkipShieldingInputStream.java | 2 +-
src/site/xdoc/examples.xml | 10 +++++-----
39 files changed, 74 insertions(+), 73 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveException.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveException.java
index 21eb4a11e..5ee2d1acf 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveException.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveException.java
@@ -22,7 +22,7 @@
import org.apache.commons.compress.archivers.ArchiveException;
/**
- * Signals that an dump archive exception of some sort has occurred.
+ * Signals that a dump archive exception of some sort has occurred.
*
* @since 1.3
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java
index 84724e246..28dfddb27 100644
--- a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFile.java
@@ -64,12 +64,12 @@
/**
* Reads a 7z file, using SeekableByteChannel under the covers.
* <p>
- * The 7z file format is a flexible container that can contain many
compression and encryption types, but at the moment only only Copy, LZMA,
LZMA2, BZIP2,
+ * The 7z file format is a flexible container that can contain many
compression and encryption types, but at the moment only Copy, LZMA, LZMA2,
BZIP2,
* Deflate and AES-256 + SHA-256 are supported.
* </p>
* <p>
* The format is very Windows/Intel specific, so it uses little-endian byte
order, doesn't store user/group or permission bits, and represents times using
NTFS
- * timestamps (100 nanosecond units since 1 January 1601). Hence the official
tools recommend against using it for backup purposes on *nix, and recommend
+ * timestamps (100 nanosecond units since 1 January 1601). Hence, the official
tools recommend against using it for backup purposes on *nix, and recommend
* .tar.7z or .tar.lzma or .tar.xz instead.
* </p>
* <p>
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java
index 2118cafb2..b560cebba 100644
---
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java
+++
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java
@@ -37,12 +37,12 @@
* <tr>
* <td>BZIP2</td>
* <td>Number</td>
- * <td>Block Size - an number between 1 and 9</td>
+ * <td>Block Size - a number between 1 and 9</td>
* </tr>
* <tr>
* <td>DEFLATE</td>
* <td>Number</td>
- * <td>Compression Level - an number between 1 and 9</td>
+ * <td>Compression Level - a number between 1 and 9</td>
* </tr>
* <tr>
* <td>LZMA2</td>
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
index 6d5b81e98..652ba1fbc 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
@@ -107,7 +107,7 @@
* and gid larger than 07777777L (7 7s) the sign bit of the first byte is set,
and the rest of the field is the binary representation of the number. See
* {@link TarUtils#parseOctalOrBinary(byte[], int, int)}.
* <p>
- * The C structure for a old GNU Tar Entry's header is:
+ * The C structure for an old GNU Tar Entry's header is:
* </p>
* <pre>
* struct oldgnu_header {
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 0103cd4c5..295e6c3b2 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
@@ -748,7 +748,7 @@ protected byte[] readRecord() throws IOException {
/**
* For sparse tar entries, there are many "holes"(consisting of all 0) in
the file. Only the non-zero data is stored in tar files, and they are stored
* separately. The structure of non-zero data is introduced by the sparse
headers using the offset, where a block of non-zero data starts, and numbytes,
the
- * length of the non-zero data block. When reading sparse entries, the
actual data is read out with "holes" and non-zero data combined together
according to
+ * length of the non-zero data block. When reading sparse entries, the
actual data is read out with "holes" and non-zero data combined according to
* the sparse headers.
*
* @param buf The buffer into which to place bytes read.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
index 3533b614e..4ab04832a 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
@@ -51,7 +51,7 @@
* <p>
* tar archives consist of a sequence of records of 512 bytes each that are
grouped into blocks. Prior to Apache Commons Compress 1.14 it has been possible
to
* configure a record size different from 512 bytes and arbitrary block sizes.
Starting with Compress 1.15 512 is the only valid option for the record size and
- * the block size must be a multiple of 512. Also the default block size
changed from 10240 bytes prior to Compress 1.15 to 512 bytes with Compress 1.15.
+ * the block size must be a multiple of 512. Also, the default block size
changed from 10240 bytes prior to Compress 1.15 to 512 bytes with Compress 1.15.
* </p>
*
* @NotThreadSafe
@@ -436,8 +436,8 @@ public int getRecordSize() {
* <p>
* I.e. if the given name is too long to be written to a plain tar header
then
* <ul>
- * <li>it creates a pax header who's name is given by the paxHeaderName
parameter if longFileMode is POSIX</li>
- * <li>it creates a GNU longlink entry who's type is given by the linkType
parameter if longFileMode is GNU</li>
+ * <li>it creates a pax header whose name is given by the paxHeaderName
parameter if longFileMode is POSIX</li>
+ * <li>it creates a GNU longlink entry whose type is given by the linkType
parameter if longFileMode is GNU</li>
* <li>it throws an exception if longFileMode is ERROR</li>
* <li>it truncates the name if longFileMode is TRUNCATE</li>
* </ul>
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
index afa8e1a4b..daecc998a 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
@@ -42,7 +42,7 @@ public final class TarArchiveStructSparse {
* Constructs a new instance.
*
* @param offset An offset greater or equal to zero.
- * @param numBytes An count greater or equal to zero.
+ * @param numBytes A count greater or equal to zero.
*/
public TarArchiveStructSparse(final long offset, final long numBytes) {
if (offset < 0) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
index fbf54b201..b03798ab7 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
@@ -68,7 +68,7 @@ final class ExplodingInputStream extends InputStream
implements InputStreamStati
private long treeSizes;
/**
- * Constructs a new stream decompressing the content of the specified
stream using the explode algorithm.
+ * Constructs a new stream decompressing the content of the specified
stream using the <em>explode</em> algorithm.
*
* @param dictionarySize the size of the sliding dictionary (4096 or 8192)
* @param numberOfTrees the number of trees (2 or 3)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java
b/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java
index f0857635e..a8a98486c 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java
@@ -63,8 +63,8 @@ public final class GeneralPurposeBit implements Cloneable {
* Indicates that file names are written in UTF-8.
*
* <p>
- * The only reason this is public is that {@link
ZipArchiveOutputStream#EFS_FLAG} was public in Apache Commons Compress 1.0 and
we needed a substitute for
- * it.
+ * The only reason this is public is that {@link
ZipArchiveOutputStream#EFS_FLAG} was public in Apache Commons Compress 1.0,
+ * and we needed a substitute for it.
* </p>
*/
public static final int UFT8_NAMES_FLAG = 1 << 11;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
index cada98d46..09a77ca73 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
@@ -28,7 +28,7 @@
* Base class for all PKWare strong crypto extra headers.
*
* <p>
- * This base class acts as a marker so you know you can ignore all extra
fields that extend this class if you are not interested in the meta data of
PKWare
+ * This base class acts as a marker so you know you can ignore all extra
fields that extend this class if you are not interested in the metadata of
PKWare
* strong encryption.
* </p>
*
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
index 089ba517b..e21735488 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
@@ -48,7 +48,7 @@
* <ul>
* <li>0x0007 - reserved for future use
* <li>0x000F - reserved for future use
- * <li>0x0100 - Indicates non-OAEP key wrapping was used. If this this field
is set, the version needed to extract must be at least 61. This means OAEP key
+ * <li>0x0100 - Indicates non-OAEP key wrapping was used. If this field is
set, the version needed to extract must be at least 61. This means OAEP key
* wrapping is not used when generating a Master Session Key using ErdData.
* <li>0x4000 - ErdData must be decrypted using 3DES-168, otherwise use the
same algorithm used for encrypting the file contents.
* <li>0x8000 - reserved for future use
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X0019_EncryptionRecipientCertificateList.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X0019_EncryptionRecipientCertificateList.java
index e91f5ee3f..42e4caa0b 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X0019_EncryptionRecipientCertificateList.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X0019_EncryptionRecipientCertificateList.java
@@ -22,7 +22,7 @@
* PKCS#7 Encryption Recipient Certificate List (0x0019).
*
* <p>
- * This field MAY contain information about each of the certificates used in
encryption processing and it can be used to identify who is allowed to decrypt
+ * This field MAY contain information about each of the certificates used in
encryption processing, and it can be used to identify who is allowed to decrypt
* encrypted files. This field should only appear in the archive extra data
record. This field is not required and serves only to aid archive modifications
by
* preserving public encryption key data. Individual security requirements may
dictate that this data be omitted to deter information exposure.
* </p>
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
index f2311efcb..ac3cedb75 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
@@ -92,7 +92,7 @@ static byte[] trimLeadingZeroesForceMinLength(final byte[]
array) {
*
* 2.) Fundamentally, ZIP files are about shrinking things, so let's
save a few bytes per entry while we can.
*
- * 3.) Of all the people creating ZIP files using commons- compress,
how many care about Unix UID/GID attributes of the files they store? (for
example,
+ * 3.) Of all the people creating ZIP files using commons-compress,
how many care about Unix UID/GID attributes of the files they store? (for
example,
* I am probably thinking way too hard about this and no one cares!)
*
* 4.) InfoZip's tool, even though it carefully stores every UID/GID
for every file zipped on a Unix machine (by default) currently appears unable to
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
index 9b643bfff..07d3492c5 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
@@ -1446,7 +1446,7 @@ public void setUseZip64(final Zip64Mode mode) {
* <ul>
* <li>mode is Always</li>
* <li>or we already know it is going to be needed</li>
- * <li>or the size is unknown and we can ensure it won't hurt other
implementations if we add it (i.e. we can erase its usage</li>
+ * <li>or the size is unknown, and we can ensure it won't hurt other
implementations if we add it (i.e. we can erase its usage</li>
* </ul>
*/
private boolean shouldAddZip64Extra(final ZipArchiveEntry entry, final
Zip64Mode mode) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index 287bf4b37..3e28361c3 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -74,7 +74,7 @@
* Replacement for {@link java.util.zip.ZipFile}.
* <p>
* This class adds support for file name encodings other than UTF-8 (which is
required to work on ZIP files created by native ZIP tools and is able to skip a
- * preamble like the one found in self extracting archives. Furthermore it
returns instances of
+ * preamble like the one found in self extracting archives. Furthermore, it
returns instances of
* {@code org.apache.commons.compress.archivers.zip.ZipArchiveEntry} instead
of {@link java.util.zip.ZipEntry}.
* </p>
* <p>
@@ -123,7 +123,7 @@ protected int read(final long pos, final ByteBuffer buf)
throws IOException {
* See {@link
org.apache.commons.compress.utils.SeekableInMemoryByteChannel} to read from an
in-memory archive.
* </p>
* <p>
- * By default the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
+ * By default, the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
* when the archive is big. The {@code ignoreLocalFileHeader} parameter
can be set to {@code true} which restricts parsing to the central directory.
* Unfortunately the local file header may contain information not present
inside of the central directory which will not be available when the argument is
* set to {@code true}. This includes the content of the Unicode extra
field, so setting {@code
@@ -221,7 +221,7 @@ public Builder setUseUnicodeExtraFields(final boolean
useUnicodeExtraFields) {
* Sets the factory {@link IOFunction} to create a Zstd {@link
InputStream}. Defaults to
* {@link
ZstdCompressorInputStream#ZstdCompressorInputStream(InputStream)}.
* <p>
- * Call this method to plugin an alternate Zstd input stream
implementation.
+ * Call this method to plug in an alternate Zstd input stream
implementation.
* </p>
*
* @param zstdInpStreamFactory the factory {@link IOFunction} to
create a Zstd {@link InputStream}; {@code null} resets to the default.
@@ -576,7 +576,7 @@ private static SeekableByteChannel openZipChannel(final
Path path, final long ma
}
/**
- * Searches for the and positions the stream at the start of the "End
of central dir record".
+ * Searches for the end positions the stream at the start of the "End
of central dir record".
*
* @return true if it's Zip64 end of central directory or false if it's
Zip32
*/
@@ -793,7 +793,7 @@ public ZipFile(final File file, final String encoding,
final boolean useUnicodeE
/**
* Opens the given file for reading, assuming the specified encoding for
file names.
* <p>
- * By default the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
+ * By default, the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
* when the archive is big. The {@code ignoreLocalFileHeader} parameter
can be set to {@code true} which restricts parsing to the central directory.
* Unfortunately the local file header may contain information not present
inside of the central directory which will not be available when the argument is
* set to {@code true}. This includes the content of the Unicode extra
field, so setting {@code
@@ -859,7 +859,7 @@ public ZipFile(final Path path, final String encoding,
final boolean useUnicodeE
/**
* Opens the given path for reading, assuming the specified encoding for
file names.
* <p>
- * By default the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
+ * By default, the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
* when the archive is big. The {@code ignoreLocalFileHeader} parameter
can be set to {@code true} which restricts parsing to the central directory.
* Unfortunately the local file header may contain information not present
inside of the central directory which will not be available when the argument is
* set to {@code true}. This includes the content of the Unicode extra
field, so setting {@code
@@ -965,7 +965,7 @@ public ZipFile(final SeekableByteChannel channel, final
String channelDescriptio
* {@link org.apache.commons.compress.utils.SeekableInMemoryByteChannel}
allows you to read from an in-memory archive.
* </p>
* <p>
- * By default the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
+ * By default, the central directory record and all local file headers of
the archive will be read immediately which may take a considerable amount of
time
* when the archive is big. The {@code ignoreLocalFileHeader} parameter
can be set to {@code true} which restricts parsing to the central directory.
* Unfortunately the local file header may contain information not present
inside of the central directory which will not be available when the argument is
* set to {@code true}. This includes the content of the Unicode extra
field, so setting {@code
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipIoUtil.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipIoUtil.java
index 38bc9464b..ea77f97d7 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipIoUtil.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipIoUtil.java
@@ -38,7 +38,7 @@ final class ZipIoUtil {
* @param channel The target channel.
* @param buffer The source bytes.
* @param position The file position at which the transfer is to begin;
must be non-negative
- * @throws IOException If some I/O error occurs or fails or fails to write
all bytes.
+ * @throws IOException If some I/O error occurs or fails to write all
bytes.
*/
static void writeAll(final FileChannel channel, final ByteBuffer buffer,
final long position) throws IOException {
for (long currentPos = position; buffer.hasRemaining();) {
@@ -62,7 +62,7 @@ static void writeAll(final FileChannel channel, final
ByteBuffer buffer, final l
*
* @param channel The target channel.
* @param buffer The source bytes.
- * @throws IOException If some I/O error occurs or fails or fails to write
all bytes.
+ * @throws IOException If some I/O error occurs or fails to write all
bytes.
*/
static void writeAll(final WritableByteChannel channel, final ByteBuffer
buffer) throws IOException {
while (buffer.hasRemaining()) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
index 4603cc117..accc0b8a0 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
@@ -226,7 +226,7 @@ public long position() {
* an archive.
* </p>
*
- * @param unsplittableContentSize the split size request must be less than
or equal to the the split size.
+ * @param unsplittableContentSize the split size request must be less than
or equal to the split size.
* @throws IllegalArgumentException if unsplittable content size is bigger
than the split segment size.
* @throws IOException if an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
index 5dc263e57..8e63979c9 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitReadOnlySeekableByteChannel.java
@@ -246,8 +246,8 @@ public static SeekableByteChannel forPaths(final Path
lastSegmentPath, final Ite
* Concatenates the given channels.
*
* <p>
- * The channels should be add in ascending order, for example z01, z02,
... z99, ZIP please note that the .zip file is the last segment and should be
added
- * as the last one in the channels
+ * The channels should be added in ascending order, for example z01, z02,
... z99, ZIP.
+ * Please note that the .zip file is the last segment and should be added
as the last one in the channels.
* </p>
*
* @param channels the channels to concatenate
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
index ec9126791..f382d8fdd 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
@@ -86,8 +86,8 @@ public abstract class ZipUtil {
* Approximately 128 years, in milliseconds (ignoring leap years, etc.).
*
* <p>
- * This establish an approximate high-bound value for DOS times in
milliseconds since epoch, used to enable an efficient but sufficient bounds
check to
- * avoid generating extended last modified time entries.
+ * This establishes an approximate high-bound value for DOS times in
milliseconds since epoch, used to enable an efficient but sufficient
+ * bounds check to avoid generating extended last modified time entries.
* </p>
* <p>
* Calculating the exact number is locale dependent, would require loading
TimeZone data eagerly, and would make little practical sense. Since DOS times
diff --git a/src/main/java/org/apache/commons/compress/changes/ChangeSet.java
b/src/main/java/org/apache/commons/compress/changes/ChangeSet.java
index 85732d38d..36c2b0ec8 100644
--- a/src/main/java/org/apache/commons/compress/changes/ChangeSet.java
+++ b/src/main/java/org/apache/commons/compress/changes/ChangeSet.java
@@ -60,7 +60,7 @@ public void add(final E entry, final InputStream input) {
*
* @param entry the entry to add
* @param input the data stream to add
- * @param replace indicates the this change should replace existing entries
+ * @param replace indicates this change should replace existing entries
*/
public void add(final E entry, final InputStream input, final boolean
replace) {
addAddition(new Change<>(entry, input, replace));
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
index eb9583c4b..3761341cd 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
@@ -133,7 +133,7 @@ public boolean equals(final Object obj) {
}
/**
- * The 2 character ISO-8859-1 string made from the si1 and si2 bytes
of the sub field id.
+ * The 2 character ISO-8859-1 string made from the si1 and si2 bytes
of the subfield id.
*
* @return Two character ID.
*/
@@ -165,7 +165,7 @@ public int hashCode() {
private static final byte[] ZERO_BYTES = {};
/**
- * Converts {@code XLEN} length bytes of "extra field" into an new
instance.
+ * Converts {@code XLEN} length bytes of "extra field" into a new instance.
* <p>
* The bytes for the {@code XLEN} field is not included in the input.
* </p>
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
index a6664cc5a..916f76720 100644
---
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
@@ -349,7 +349,7 @@ public long getCompressedCount() {
}
/**
- * Provides the stream's meta data - may change with each stream when
decompressing concatenated streams.
+ * Provides the stream's metadata - may change with each stream when
decompressing concatenated streams.
*
* @return the stream's meta data
* @since 1.8
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
index e5b5ed0e9..d58cfbfd6 100644
---
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
+++
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipParameters.java
@@ -564,7 +564,7 @@ public void setDeflateStrategy(final int deflateStrategy) {
* Sets the extra subfields. Note that a non-null extra will appear in the
gzip header regardless of the presence of subfields, while a null extra will not
* appear at all.
*
- * @param extra the series of extra sub fields.
+ * @param extra the series of extra subfields.
* @since 1.28.0
*/
public void setExtraField(final ExtraField extra) {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
index 5ee128b1a..9105187ac 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
@@ -28,7 +28,7 @@
*
* <p>
* Most LZ77 derived algorithms split input data into blocks of uncompressed
data (called literal blocks) and back-references (pairs of offsets and lengths)
- * that state "add {@code length} bytes that are the same as those already
written starting {@code offset} bytes before the current position. The details
of how
+ * that state add {@code length} bytes that are the same as those already
written starting {@code offset} bytes before the current position. The details
of how
* those blocks and back-references are encoded are quite different between
the algorithms and some algorithms perform additional steps (Huffman encoding
in the
* case of DEFLATE for example).
* </p>
@@ -195,9 +195,9 @@ protected Block(final BlockType type) {
}
/**
- * Gets the the block type.
+ * Gets the block type.
*
- * @return the the block type.
+ * @return the block type.
*/
public BlockType getType() {
return type;
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 fa4130c2d..2015b96de 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
@@ -194,9 +194,9 @@ protected int getPrefix(final int offset) {
}
/**
- * Gets the prefixes length.
+ * Gets the prefixes' length.
*
- * @return the prefixes length.
+ * @return the prefixes' length.
*/
protected int getPrefixesLength() {
return prefixes.length;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200Utils.java
b/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200Utils.java
index 4d7d60ec9..229cb4244 100644
---
a/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200Utils.java
+++
b/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200Utils.java
@@ -48,7 +48,7 @@ public class Pack200Utils {
* </p>
*
* <p>
- * Note this methods implicitly sets the segment length to -1.
+ * Note: this method implicitly sets the segment length to -1.
* </p>
*
* @param jar the JAR archive to normalize
@@ -72,7 +72,7 @@ public static void normalize(final File jar) throws
IOException {
* </p>
*
* <p>
- * Note this methods implicitly sets the segment length to -1.
+ * Note: this method implicitly sets the segment length to -1.
* </p>
*
* @param from the JAR archive to normalize
diff --git
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
index e3bc7a7f2..20dd3446c 100644
---
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
@@ -254,8 +254,8 @@ public Builder setLevel(final int level) {
* <p>
* Zstd can still find matches of smaller size, by updating its search
algorithm to look for this size and larger. Using larger values increase
* compression and decompression speed, but decrease the ratio. The
value must be between {@link ZstdConstants#ZSTD_MINMATCH_MIN} and
- * {@link ZstdConstants#ZSTD_MINMATCH_MAX}. Note that currently, for
all strategies < {@code btopt}, effective minimum is 4. , for all strategies
- * > {@code fast}, effective maximum is {@code 6}.
+ * {@link ZstdConstants#ZSTD_MINMATCH_MAX}. Note that currently, for
all strategies < {@code btopt}, effective minimum is {@code 4},
+ * for all strategies > {@code fast}, effective maximum is {@code
6}.
* </p>
* <p>
* The value {@code 0} means use the default minMatchLength.
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
index e16d96025..d1b81b65c 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
@@ -189,8 +189,8 @@ public CPConstant<?> getConstant(final Object value) {
/**
* Gets a constant pool class for the given class name.
*
- * @param className a fully-qualifed class name.
- * @return a a constant pool class.
+ * @param className a fully-qualified class name.
+ * @return a constant pool class.
*/
public CPClass getCPClass(String className) {
if (className == null) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
index 2dd0bb62e..024a9bfc8 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
@@ -73,7 +73,7 @@ public class Archive {
* Creates an Archive with streams for the input and output files. Note:
If you use this method then calling {@link #setRemovePackFile(boolean)} will
have
* no effect.
*
- * @param inputStream the input stream, preferably a {@link
BoundedInputStream}. The bound can the the file size.
+ * @param inputStream the input stream, preferably a {@link
BoundedInputStream}. The bound can the file size.
* @param outputStream the JAR output stream.
* @throws IOException if an I/O error occurs
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
index 2a9b8bc07..92d40a029 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
@@ -128,7 +128,7 @@ static BoundedInputStream newBoundedInputStream(final
String first, final String
* @param url The URL.
* @return a new BoundedInputStream
* @throws IOException if an I/O error occurs.
- * @throws URISyntaxException if the URL is not formatted strictly
according to to RFC2396 and cannot be converted to a URI.
+ * @throws URISyntaxException if the URL is not formatted strictly
according to RFC2396 and cannot be converted to a URI.
*/
static BoundedInputStream newBoundedInputStream(final URL url) throws
IOException, URISyntaxException {
return newBoundedInputStream(Paths.get(url.toURI()));
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
index 37d49af41..a10be1cd2 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
@@ -40,10 +40,11 @@ public class ExceptionTableEntry {
private int catchTypeIndex;
/**
- * Constructs a new ExceptionTableEntry. Exception tables are of two
kinds: either a normal one (with a Throwable as the catchType) or a finally
clause
- * (which has no catchType). In the class file, the finally clause is
represented as catchType == 0.
- *
- * To create a finally clause with this method, pass in null for the
catchType.
+ * Constructs a new ExceptionTableEntry. Exception tables are of two
kinds: either a normal one (with a Throwable as the catchType) or a
+ * {@code finally} clause (which has no catchType). In the class file, the
{@code finally} clause is represented as catchType == 0.
+ * <p>
+ * To create a {@code finally} clause with this method, pass in null for
the catchType.
+ * </p>
*
* @param startPC int
* @param endPC int
diff --git
a/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
b/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
index eddc34a93..d04482902 100644
---
a/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/CloseShieldFilterInputStream.java
@@ -33,7 +33,7 @@
public class CloseShieldFilterInputStream extends FilterInputStream {
/**
- * Creates a {@code CloseShieldFilterInputStream} by assigning the
argument {@code in} to the field {@code this.in} so as to remember it for later
use.
+ * Creates a {@code CloseShieldFilterInputStream} by assigning the
argument {@code in} to the field {@code this.in} to remember it for later use.
*
* @param in the underlying input stream, or {@code null} if this instance
is to be created without an underlying stream.
*/
diff --git
a/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
b/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
index af82be16d..8bd735fc3 100644
--- a/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
+++ b/src/main/java/org/apache/commons/compress/utils/CountingInputStream.java
@@ -34,7 +34,7 @@ public class CountingInputStream extends FilterInputStream {
private long bytesRead;
/**
- * Creates a {@code CountingInputStream} by assigning the argument {@code
in} to the field {@code this.in} so as to remember it for later use.
+ * Creates a {@code CountingInputStream} by assigning the argument {@code
in} to the field {@code this.in} to remember it for later use.
*
* @param in the underlying input stream, or {@code null} if this instance
is to be created without an underlying stream.
*/
diff --git a/src/main/java/org/apache/commons/compress/utils/FileNameUtils.java
b/src/main/java/org/apache/commons/compress/utils/FileNameUtils.java
index bd083a82f..0e17271e7 100644
--- a/src/main/java/org/apache/commons/compress/utils/FileNameUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/FileNameUtils.java
@@ -71,7 +71,7 @@ public static String getBaseName(final String fileName) {
/**
* Gets the extension (i.e. the part after the last ".") of a file.
* <p>
- * Will return an empty string if the file name doesn't contain any dots.
Only the last segment of a the file name is consulted - i.e. all leading
+ * Will return an empty string if the file name doesn't contain any dots.
Only the last segment of the file name is consulted - i.e. all leading
* directories of the {@code file name} parameter are skipped.
* </p>
*
@@ -88,7 +88,7 @@ public static String getExtension(final Path path) {
/**
* Gets the extension (i.e. the part after the last ".") of a file.
* <p>
- * Will return an empty string if the file name doesn't contain any dots.
Only the last segment of a the file name is consulted - i.e. all leading
+ * Will return an empty string if the file name doesn't contain any dots.
Only the last segment of the file name is consulted - i.e. all leading
* directories of the {@code fileName} parameter are skipped.
* </p>
*
diff --git
a/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
b/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
index 1e2589061..805b61413 100644
---
a/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
@@ -32,7 +32,7 @@
/**
* This class supports writing to an OutputStream or WritableByteChannel in
fixed length blocks.
* <p>
- * It can be be used to support output to devices such as tape drives that
require output in this format. If the final block does not have enough content
to
+ * It can be used to support output to devices such as tape drives that
require output in this format. If the final block does not have enough content
to
* fill an entire block, the output will be padded to a full block size.
* </p>
*
diff --git
a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
index 2b7902e7f..1046021a4 100644
---
a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
+++
b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
@@ -37,7 +37,7 @@
/**
* Implements a read-only {@link SeekableByteChannel} that concatenates a
collection of other {@link SeekableByteChannel}s.
* <p>
- * This is a lose port of <a href=
+ * This is a loose port of <a href=
*
"https://github.com/frugalmechanic/fm-common/blob/master/jvm/src/main/scala/fm/common/MultiReadOnlySeekableByteChannel.scala";>
* MultiReadOnlySeekableByteChannel</a>
* by Tim Underwood.
@@ -142,8 +142,8 @@ public boolean isOpen() {
/**
* Gets this channel's position.
* <p>
- * This method violates the contract of {@link
SeekableByteChannel#position()} as it will not throw any exception when invoked
on a closed channel. Instead
- * it will return the position the channel had when close has been called.
+ * This method violates the contract of {@link
SeekableByteChannel#position()} as it will not throw any exception when invoked
on a closed channel.
+ * Instead, it will return the position the channel had when close has
been called.
* </p>
*/
@Override
diff --git
a/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java
b/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java
index 286a11d76..9119d1850 100644
---
a/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java
+++
b/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java
@@ -111,8 +111,8 @@ public boolean isOpen() {
/**
* Returns this channel's position.
* <p>
- * This method violates the contract of {@link
SeekableByteChannel#position()} as it will not throw any exception when invoked
on a closed channel. Instead
- * it will return the position the channel had when close has been called.
+ * This method violates the contract of {@link
SeekableByteChannel#position()} as it will not throw any exception when invoked
on a closed channel.
+ * Instead, it will return the position the channel had when close has
been called.
* </p>
*/
@Override
@@ -164,8 +164,8 @@ private void resize(final int newLength) {
/**
* Returns the current size of entity to which this channel is connected.
* <p>
- * This method violates the contract of {@link SeekableByteChannel#size}
as it will not throw any exception when invoked on a closed channel. Instead it
- * will return the size the channel had when close has been called.
+ * This method violates the contract of {@link SeekableByteChannel#size}
as it will not throw any exception when invoked on a closed channel.
+ * Instead, it will return the size the channel had when close has been
called.
* </p>
*/
@Override
diff --git
a/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
b/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
index ebfaf0c4b..9b7f29a96 100644
---
a/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/SkipShieldingInputStream.java
@@ -27,7 +27,7 @@
*
* <p>
* Some implementations of {@link InputStream} implement {@link
InputStream#skip} in a way that throws an exception if the stream is not
seekable -
- * {@link System#in System.in} is known to behave that way. For such a stream
it is impossible to invoke skip at all and you have to read from the stream (and
+ * {@link System#in System.in} is known to behave that way. For such a stream
it is impossible to invoke skip at all, and you have to read from the stream
(and
* discard the data read) instead. Skipping is potentially much faster than
reading so we do want to invoke {@code skip} when possible. We provide this
class so
* you can wrap your own {@link InputStream} in it if you encounter problems
with {@code skip} throwing an exception.
* </p>
diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml
index 2505d3301..4b781074c 100644
--- a/src/site/xdoc/examples.xml
+++ b/src/site/xdoc/examples.xml
@@ -608,7 +608,7 @@ jarOutput.write(contentOfEntry);
jarOutput.closeArchiveEntry();
]]></source>
- <p>Reading entries from an jar archive:</p>
+ <p>Reading entries from a jar archive:</p>
<source><![CDATA[
JarArchiveEntry entry = jarInput.getNextJarEntry();
byte[] content = new byte[entry.getSize()];
@@ -631,7 +631,7 @@ LOOP UNTIL entry.getSize() HAS BEEN READ {
ZLIB compressed archives and can not write archives at
all.</p>
- <p>Reading entries from an dump archive:</p>
+ <p>Reading entries from a dump archive:</p>
<source><![CDATA[
DumpArchiveEntry entry = dumpInput.getNextDumpEntry();
byte[] content = new byte[entry.getSize()];
@@ -661,7 +661,7 @@ tarOutput.write(contentOfEntry);
tarOutput.closeArchiveEntry();
]]></source>
- <p>Reading entries from an tar archive:</p>
+ <p>Reading entries from a tar archive:</p>
<source><![CDATA[
TarArchiveEntry entry = tarInput.getNextTarEntry();
byte[] content = new byte[entry.getSize()];
@@ -693,7 +693,7 @@ zipOutput.closeArchiveEntry();
than the one using an <code>OutputStream</code> or the
factory method in <code>ArchiveStreamFactory</code>.</p>
- <p>Reading entries from an zip archive:</p>
+ <p>Reading entries from a zip archive:</p>
<source><![CDATA[
ZipArchiveEntry entry = zipInput.getNextZipEntry();
byte[] content = new byte[entry.getSize()];
@@ -702,7 +702,7 @@ LOOP UNTIL entry.getSize() HAS BEEN READ {
}
]]></source>
- <p>Reading entries from an zip archive using the
+ <p>Reading entries from a zip archive using the
recommended <code>ZipFile</code> class:</p>
<source><