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 cbdf013a2 Fix typos in Javadoc and comments (#761)
cbdf013a2 is described below
commit cbdf013a240ef5ce3306d25a364ca835fc1738ee
Author: Martin Wiesner <[email protected]>
AuthorDate: Sat Mar 7 22:30:35 2026 +0100
Fix typos in Javadoc and comments (#761)
---
.../org/apache/commons/compress/archivers/sevenz/SevenZFile.java | 2 +-
.../apache/commons/compress/archivers/sevenz/SevenZFileOptions.java | 2 +-
.../org/apache/commons/compress/archivers/zip/StreamCompressor.java | 2 +-
.../commons/compress/archivers/zip/X5455_ExtendedTimestamp.java | 2 +-
.../compress/compressors/snappy/SnappyCompressorOutputStream.java | 6 +++---
.../commons/compress/compressors/xz/XZCompressorInputStream.java | 6 +++---
.../commons/compress/archivers/sevenz/SevenZHugeNextHeaderTest.java | 2 +-
7 files changed, 11 insertions(+), 11 deletions(-)
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 e4c2e8099..47c3162fb 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
@@ -311,7 +311,7 @@ public Builder setSeekableByteChannel(final
SeekableByteChannel seekableByteChan
/**
* Sets whether {@link SevenZFile} will try to recover broken archives
where the CRC of the file's metadata is 0.
* <p>
- * This special kind of broken archive is encountered when mutli
volume archives are closed prematurely. If you enable this option SevenZFile
will trust
+ * This special kind of broken archive is encountered when multi
volume archives are closed prematurely. If you enable this option SevenZFile
will trust
* data that looks as if it could contain metadata of an archive and
allocate big amounts of memory. It is strongly recommended to not enable this
* option without setting {@link #setMaxMemoryLimitKb(int)} at the
same time.
* </p>
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
index c59e29561..7737c39b1 100644
---
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
+++
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
@@ -72,7 +72,7 @@ public Builder withMaxMemoryLimitInKb(final int
maxMemoryLimitKiB) {
/**
* Sets whether {@link SevenZFile} will try to recover broken archives
where the CRC of the file's metadata is 0.
* <p>
- * This special kind of broken archive is encountered when mutli
volume archives are closed prematurely. If you enable this option SevenZFile
will trust
+ * This special kind of broken archive is encountered when multi
volume archives are closed prematurely. If you enable this option SevenZFile
will trust
* data that looks as if it could contain metadata of an archive and
allocate big amounts of memory. It is strongly recommended to not enable this
* option without setting {@link #withMaxMemoryLimitInKb} at the same
time.
* </p>
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
b/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
index 4a497106b..0b8c609dc 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
@@ -279,7 +279,7 @@ void reset() {
* @param b the byte array to write.
* @param offset the start position to write from.
* @param length the number of bytes to write.
- * @param method the comrpession method to use.
+ * @param method the compression method to use.
* @return the number of bytes written to the stream this time.
* @throws IOException on error.
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
index 6971d5d76..0f77ce5d5 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
@@ -500,7 +500,7 @@ private void reset() {
/**
* <p>
- * Sets the acccess time as a {@link FileTime} of this ZIP entry. Supplied
value is truncated to per-second precision (milliseconds zeroed-out).
+ * Sets the access time as a {@link FileTime} of this ZIP entry. Supplied
value is truncated to per-second precision (milliseconds zeroed-out).
* </p>
* <p>
* Note: the setters for flags and timestamps are decoupled. Even if the
timestamp is not-null, it will only be written out if the corresponding bit in
the
diff --git
a/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorOutputStream.java
index ea03b7b17..163970e54 100644
---
a/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorOutputStream.java
@@ -39,7 +39,7 @@
* The raw Snappy format requires the uncompressed size to be written at the
beginning of the stream using a varint representation, i.e. the number of bytes
* needed to write the information is not known before the uncompressed size
is known. We've chosen to make the uncompressedSize a parameter of the
constructor
* in favor of buffering the whole output until the size is known. When using
the {@link FramedSnappyCompressorOutputStream} this limitation is taken care of
by
- * the warpping framing format.
+ * the wrapping framing format.
* </p>
*
* @see <a
href="https://github.com/google/snappy/blob/master/format_description.txt";>Snappy
compressed format description</a>
@@ -85,10 +85,10 @@ public class SnappyCompressorOutputStream extends
CompressorOutputStream<OutputS
private static final int MAX_MATCH_LENGTH = 64;
/**
- * Returns a builder correctly configured for the Snappy algorithm using
the gven block size.
+ * Returns a builder correctly configured for the Snappy algorithm using
the given block size.
*
* @param blockSize the block size.
- * @return a builder correctly configured for the Snappy algorithm using
the gven block size.
+ * @return a builder correctly configured for the Snappy algorithm using
the given block size.
*/
public static Parameters.Builder createParameterBuilder(final int
blockSize) {
// the max offset and max literal length defined by the format
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
index c419d98de..6d5500113 100644
---
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
@@ -241,7 +241,7 @@ public int read() throws IOException {
count(ret == -1 ? -1 : 1);
return ret;
} catch (final org.tukaani.xz.MemoryLimitException e) {
- // Convert to Commons Compress MemoryLimtException
+ // Convert to Commons Compress MemoryLimitException
throw newMemoryLimitException(e);
}
}
@@ -253,7 +253,7 @@ public int read(final byte[] buf, final int off, final int
len) throws IOExcepti
count(ret);
return ret;
} catch (final org.tukaani.xz.MemoryLimitException e) {
- // Convert to Commons Compress MemoryLimtException
+ // Convert to Commons Compress MemoryLimitException
throw newMemoryLimitException(e);
}
}
@@ -263,7 +263,7 @@ public long skip(final long n) throws IOException {
try {
return IOUtils.skip(in, n);
} catch (final org.tukaani.xz.MemoryLimitException e) {
- // Convert to Commons Compress MemoryLimtException
+ // Convert to Commons Compress MemoryLimitException
throw newMemoryLimitException(e);
}
}
diff --git
a/src/test/java/org/apache/commons/compress/archivers/sevenz/SevenZHugeNextHeaderTest.java
b/src/test/java/org/apache/commons/compress/archivers/sevenz/SevenZHugeNextHeaderTest.java
index cca4218cc..3028c94d8 100644
---
a/src/test/java/org/apache/commons/compress/archivers/sevenz/SevenZHugeNextHeaderTest.java
+++
b/src/test/java/org/apache/commons/compress/archivers/sevenz/SevenZHugeNextHeaderTest.java
@@ -105,7 +105,7 @@ void test() throws IOException {
// For example: -Xmx128m
ignore.printStackTrace();
} catch (final ArchiveException ignore) {
- // If a MemoryLimitException isn't thrown beause a lot of memory
is available, then we get this failure:
+ // If a MemoryLimitException isn't thrown because a lot of memory
is available, then we get this failure:
// org.apache.commons.compress.archivers.ArchiveException: Broken
or unsupported archive: no Header
}
}
