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 d9166a57d Javadoc
d9166a57d is described below
commit d9166a57da9f412657482161fd2758538c11e8d9
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Mar 23 10:33:30 2025 -0400
Javadoc
---
.../compress/archivers/sevenz/SevenZFileOptions.java | 2 +-
.../compress/archivers/zip/ZipArchiveOutputStream.java | 15 +++++++++------
.../commons/compress/compressors/brotli/BrotliUtils.java | 2 +-
.../compress/compressors/deflate/DeflateParameters.java | 2 +-
.../commons/compress/compressors/lzma/LZMAUtils.java | 2 +-
.../apache/commons/compress/compressors/xz/XZUtils.java | 2 +-
.../commons/compress/compressors/zstandard/ZstdUtils.java | 2 +-
7 files changed, 15 insertions(+), 12 deletions(-)
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 66578622e..a1f6ec127 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
@@ -133,7 +133,7 @@ public int getMaxMemoryLimitInKb() {
}
/**
- * Whether {@link SevenZFile} shall try to recover from a certain type of
broken archive.
+ * Gets whether {@link SevenZFile} shall try to recover from a certain
type of broken archive.
*
* @return whether SevenZFile shall try to recover from a certain type of
broken archive.
* @since 1.21
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 90f6f1b85..8c46eb913 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
@@ -1301,7 +1301,7 @@ public void setComment(final String comment) {
}
/**
- * Whether to create Unicode Extra Fields.
+ * Sets whether to create Unicode Extra Fields.
* <p>
* Defaults to NEVER.
* </p>
@@ -1347,7 +1347,7 @@ public void setEncoding(final String encoding) {
}
/**
- * Whether to fall back to UTF and the language encoding flag if the file
name cannot be encoded using the specified encoding.
+ * Sets whether to fall back to UTF and the language encoding flag if the
file name cannot be encoded using the specified encoding.
* <p>
* Defaults to false.
* </p>
@@ -1391,7 +1391,7 @@ public void setMethod(final int method) {
}
/**
- * Whether to set the language encoding flag if the file name encoding is
UTF-8.
+ * Sets whether to set the language encoding flag if the file name
encoding is UTF-8.
* <p>
* Defaults to true.
* </p>
@@ -1403,7 +1403,7 @@ public void setUseLanguageEncodingFlag(final boolean b) {
}
/**
- * Whether Zip64 extensions will be used.
+ * Sets whether Zip64 extensions will be used.
* <p>
* When setting the mode to {@link Zip64Mode#Never Never}, {@link
#putArchiveEntry}, {@link #closeArchiveEntry}, {@link #finish} or {@link
#close} may throw
* a {@link Zip64RequiredException} if the entry's size or the total size
of the archive exceeds 4GB or there are more than 65,536 entries inside the
@@ -1438,7 +1438,7 @@ public void setUseZip64(final Zip64Mode mode) {
}
/**
- * Whether to add a Zip64 extended information extra field to the local
file header.
+ * Tests whether to add a Zip64 extended information extra field to the
local file header.
* <p>
* Returns true if
* </p>
@@ -1455,10 +1455,13 @@ private boolean shouldAddZip64Extra(final
ZipArchiveEntry entry, final Zip64Mode
}
/**
+ * Tests if zip64 End Of Central Directory is needed.
+ * <p>
* 4.4.1.4 If one of the fields in the end of central directory record is
too small to hold required data, the field SHOULD be set to -1 (0xFFFF or
* 0xFFFFFFFF) and the ZIP64 format record SHOULD be created.
+ * </p>
*
- * @return true if zip64 End Of Central Directory is needed
+ * @return true if zip64 End Of Central Directory is needed.
*/
private boolean shouldUseZip64EOCD() {
int numberOfThisDisk = 0;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
b/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
index 33b1652cc..4c734c81f 100644
---
a/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
+++
b/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
@@ -67,7 +67,7 @@ public static boolean isBrotliCompressionAvailable() {
}
/**
- * Whether to cache the result of the Brotli for Java check.
+ * Sets whether to cache the result of the Brotli for Java check.
*
* <p>
* This defaults to {@code false} in an OSGi environment and {@code true}
otherwise.
diff --git
a/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateParameters.java
b/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateParameters.java
index d3a6341d1..9c5b14154 100644
---
a/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateParameters.java
+++
b/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateParameters.java
@@ -74,7 +74,7 @@ public void setWithZlibHeader(final boolean zlibHeader) {
}
/**
- * Whether or not the zlib header shall be written (when compressing) or
expected (when decompressing).
+ * Tests whether or not the zlib header shall be written (when
compressing) or expected (when decompressing).
*
* @return true if zlib header shall be written
*/
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMAUtils.java
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMAUtils.java
index 54b8768d4..f502e75d9 100644
--- a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMAUtils.java
+++ b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMAUtils.java
@@ -174,7 +174,7 @@ public static boolean matches(final byte[] signature, final
int length) {
}
/**
- * Whether to cache the result of the LZMA check.
+ * Sets whether to cache the result of the LZMA check.
*
* <p>
* This defaults to {@code false} in an OSGi environment and {@code true}
otherwise.
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
index 975223d54..e3585559c 100644
--- a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
+++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
@@ -193,7 +193,7 @@ public static boolean matches(final byte[] signature, final
int length) {
}
/**
- * Whether to cache the result of the XZ for Java check.
+ * Sets whether to cache the result of the XZ for Java check.
*
* <p>
* This defaults to {@code false} in an OSGi environment and {@code true}
otherwise.
diff --git
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdUtils.java
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdUtils.java
index 2540f4303..3106fc189 100644
---
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdUtils.java
+++
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdUtils.java
@@ -114,7 +114,7 @@ public static boolean matches(final byte[] signature, final
int length) {
}
/**
- * Whether to cache the result of the Zstandard for Java check.
+ * Sets whether to cache the result of the Zstandard for Java check.
*
* <p>
* This defaults to {@code false} in an OSGi environment and {@code true}
otherwise.
