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 2b3f01fc68d9ac0655a2322a5e9559bae3bc320d Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Wed Apr 9 17:51:12 2025 -0400 Javadoc --- .../commons/compress/archivers/zip/UnicodePathExtraField.java | 6 ++++++ .../commons/compress/archivers/zip/X0014_X509Certificates.java | 3 +++ .../compress/archivers/zip/X0015_CertificateIdForFile.java | 3 +++ .../archivers/zip/X0016_CertificateIdForCentralDirectory.java | 3 +++ .../compress/archivers/zip/X0017_StrongEncryptionHeader.java | 3 +++ .../archivers/zip/X0019_EncryptionRecipientCertificateList.java | 3 +++ .../commons/compress/archivers/zip/Zip64RequiredException.java | 9 +++++++-- .../java/org/apache/commons/compress/archivers/zip/ZipLong.java | 9 +++++++-- 8 files changed, 35 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java index 5cd071163..23f6da937 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java @@ -31,8 +31,14 @@ */ public class UnicodePathExtraField extends AbstractUnicodeExtraField { + /** + * Field ID. + */ public static final ZipShort UPATH_ID = new ZipShort(0x7075); + /** + * Constructs a new instance. + */ public UnicodePathExtraField() { } diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X0014_X509Certificates.java b/src/main/java/org/apache/commons/compress/archivers/zip/X0014_X509Certificates.java index 75c78e541..3af89d5e8 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/X0014_X509Certificates.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/X0014_X509Certificates.java @@ -46,6 +46,9 @@ public class X0014_X509Certificates extends PKWareExtraHeader { static final ZipShort HEADER_ID = new ZipShort(0x0014); + /** + * Constructs a new instance. + */ public X0014_X509Certificates() { super(HEADER_ID); } diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java b/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java index 6ab675753..286a1f3d6 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java @@ -53,6 +53,9 @@ public class X0015_CertificateIdForFile extends PKWareExtraHeader { private HashAlgorithm hashAlg; + /** + * Constructs a new instance. + */ public X0015_CertificateIdForFile() { super(HEADER_ID); } diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java b/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java index 24adee7b4..8fe11f67e 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java @@ -54,6 +54,9 @@ public class X0016_CertificateIdForCentralDirectory extends PKWareExtraHeader { private HashAlgorithm hashAlg; + /** + * Constructs a new instance. + */ public X0016_CertificateIdForCentralDirectory() { super(HEADER_ID); } 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 c792aa43a..089ba517b 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 @@ -283,6 +283,9 @@ public class X0017_StrongEncryptionHeader extends PKWareExtraHeader { private byte[] vCRC32; + /** + * Constructs a new instance. + */ public X0017_StrongEncryptionHeader() { super(HEADER_ID); } 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 d5b6743cd..e91f5ee3f 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 @@ -52,6 +52,9 @@ public class X0019_EncryptionRecipientCertificateList extends PKWareExtraHeader static final ZipShort HEADER_ID = new ZipShort(0x0019); + /** + * Constructs a new instance. + */ public X0019_EncryptionRecipientCertificateList() { super(HEADER_ID); } diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64RequiredException.java b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64RequiredException.java index e6f08deec..7ae2b858f 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64RequiredException.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64RequiredException.java @@ -50,7 +50,12 @@ static String getEntryTooBigMessage(final ZipArchiveEntry ze) { return ze.getName() + "'s size exceeds the limit of 4GByte."; } - public Zip64RequiredException(final String reason) { - super(reason); + /** + * Constructs a {@link Zip64RequiredException} with the specified detail message. + * + * @param message the detail message. + */ + public Zip64RequiredException(final String message) { + super(message); } } diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java index 1d2dd1dae..957beea06 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java @@ -109,13 +109,12 @@ public static long getValue(final byte[] bytes, final int offset) { } /** - * put the value as four bytes in big-endian byte order. + * Puts a long value in a buffer as four bytes in little-endian byte order. * * @param value the Java long to convert to bytes * @param buf the output buffer * @param offset The offset within the output buffer of the first byte to be written. must be non-negative and no larger than {@code buf.length-4} */ - public static void putLong(final long value, final byte[] buf, final int offset) { ByteUtils.toLittleEndian(buf, value, offset, 4); } @@ -222,6 +221,12 @@ public int hashCode() { return (int) value; } + /** + * Puts this long value in a buffer as four bytes in little-endian byte order. + * + * @param buf the output buffer + * @param offset The offset within the output buffer of the first byte to be written. must be non-negative and no larger than {@code buf.length-4} + */ public void putLong(final byte[] buf, final int offset) { putLong(value, buf, offset); }