You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/01/04 17:27:12 UTC
(commons-compress) branch master updated (4f711e375 -> 0d5aa1bfd)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
from 4f711e375 Javadoc
new df7d41766 Javadoc
new 0d5aa1bfd Javadoc
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../commons/compress/CompressFilterOutputStream.java | 1 +
.../apache/commons/compress/MemoryLimitException.java | 1 +
.../commons/compress/archivers/cpio/CpioConstants.java | 1 +
.../compress/archivers/sevenz/SubStreamsInfo.java | 2 ++
.../compress/archivers/tar/TarArchiveSparseEntry.java | 1 +
.../apache/commons/compress/archivers/tar/TarFile.java | 1 +
.../commons/compress/archivers/zip/AsiExtraField.java | 4 ++++
.../compress/archivers/zip/ExtraFieldUtils.java | 2 ++
.../archivers/zip/UnparseableExtraFieldBehavior.java | 1 +
.../archivers/zip/UnsupportedZipFeatureException.java | 5 +++++
.../commons/compress/archivers/zip/X7875_NewUnix.java | 9 ++++-----
.../archivers/zip/ZipArchiveEntryPredicate.java | 1 +
.../compress/archivers/zip/ZipArchiveInputStream.java | 18 ++++++++++++++++++
.../compress/archivers/zip/ZipArchiveOutputStream.java | 1 +
.../commons/compress/archivers/zip/ZipConstants.java | 1 +
.../commons/compress/archivers/zip/ZipEncoding.java | 1 +
.../commons/compress/archivers/zip/ZipExtraField.java | 1 +
.../compressors/bzip2/BZip2CompressorInputStream.java | 2 ++
.../compressors/bzip2/BZip2CompressorOutputStream.java | 2 ++
.../compress/compressors/deflate64/HuffmanDecoder.java | 3 +++
.../compress/compressors/gzip/GzipParameters.java | 3 +--
.../commons/compress/compressors/gzip/GzipUtils.java | 1 +
.../compress/compressors/pack200/Pack200Utils.java | 1 +
.../harmony/archive/internal/nls/package-info.java | 1 +
.../harmony/internal/AttributeLayoutParser.java | 2 ++
.../compress/harmony/internal/package-info.java | 1 +
.../commons/compress/harmony/pack200/NewAttribute.java | 2 ++
.../parallel/ScatterGatherBackingStoreSupplier.java | 1 +
.../org/apache/commons/compress/utils/ByteUtils.java | 2 ++
.../compress/utils/CRC32VerifyingInputStream.java | 1 +
.../apache/commons/compress/utils/CharsetNames.java | 1 +
.../apache/commons/compress/utils/ParsingUtils.java | 1 +
32 files changed, 68 insertions(+), 7 deletions(-)
(commons-compress) 01/02: Javadoc
Posted by gg...@apache.org.
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 df7d417669001bc50d29a833d122a77b1c054f06
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jan 4 12:26:59 2026 -0500
Javadoc
---
.../org/apache/commons/compress/archivers/zip/X7875_NewUnix.java | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
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 90a995798..1c8f457bf 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
@@ -119,13 +119,12 @@ static byte[] trimLeadingZeroesForceMinLength(final byte[] array) {
private int version = 1;
- // BigInteger helps us with little-endian / big-endian conversions.
- // (thanks to BigInteger.toByteArray() and a reverse() method we created).
- // Also, the spec theoretically allows UID/GID up to 255 bytes long!
- //
- // NOTE: equals() and hashCode() currently assume these can never be null.
/**
* The user ID.
+ * <p>
+ * BigInteger helps us with little-endian / big-endian conversions. (thanks to BigInteger.toByteArray() and a reverse() method we created). Also, the spec
+ * theoretically allows UID/GID up to 255 bytes long! NOTE: equals() and hashCode() currently assume these can never be null.
+ * </p>
*/
private BigInteger uid;
(commons-compress) 02/02: Javadoc
Posted by gg...@apache.org.
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 0d5aa1bfda15546447f4c75dbc9a2f7c053c2a45
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jan 4 12:27:05 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
.../commons/compress/CompressFilterOutputStream.java | 1 +
.../apache/commons/compress/MemoryLimitException.java | 1 +
.../commons/compress/archivers/cpio/CpioConstants.java | 1 +
.../compress/archivers/sevenz/SubStreamsInfo.java | 2 ++
.../compress/archivers/tar/TarArchiveSparseEntry.java | 1 +
.../apache/commons/compress/archivers/tar/TarFile.java | 1 +
.../commons/compress/archivers/zip/AsiExtraField.java | 4 ++++
.../compress/archivers/zip/ExtraFieldUtils.java | 2 ++
.../archivers/zip/UnparseableExtraFieldBehavior.java | 1 +
.../archivers/zip/UnsupportedZipFeatureException.java | 5 +++++
.../archivers/zip/ZipArchiveEntryPredicate.java | 1 +
.../compress/archivers/zip/ZipArchiveInputStream.java | 18 ++++++++++++++++++
.../compress/archivers/zip/ZipArchiveOutputStream.java | 1 +
.../commons/compress/archivers/zip/ZipConstants.java | 1 +
.../commons/compress/archivers/zip/ZipEncoding.java | 1 +
.../commons/compress/archivers/zip/ZipExtraField.java | 1 +
.../compressors/bzip2/BZip2CompressorInputStream.java | 2 ++
.../compressors/bzip2/BZip2CompressorOutputStream.java | 2 ++
.../compress/compressors/deflate64/HuffmanDecoder.java | 3 +++
.../compress/compressors/gzip/GzipParameters.java | 3 +--
.../commons/compress/compressors/gzip/GzipUtils.java | 1 +
.../compress/compressors/pack200/Pack200Utils.java | 1 +
.../harmony/archive/internal/nls/package-info.java | 1 +
.../harmony/internal/AttributeLayoutParser.java | 2 ++
.../compress/harmony/internal/package-info.java | 1 +
.../commons/compress/harmony/pack200/NewAttribute.java | 2 ++
.../parallel/ScatterGatherBackingStoreSupplier.java | 1 +
.../org/apache/commons/compress/utils/ByteUtils.java | 2 ++
.../compress/utils/CRC32VerifyingInputStream.java | 1 +
.../apache/commons/compress/utils/CharsetNames.java | 1 +
.../apache/commons/compress/utils/ParsingUtils.java | 1 +
31 files changed, 64 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/compress/CompressFilterOutputStream.java b/src/main/java/org/apache/commons/compress/CompressFilterOutputStream.java
index 7530a1149..57125b161 100644
--- a/src/main/java/org/apache/commons/compress/CompressFilterOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/CompressFilterOutputStream.java
@@ -56,6 +56,7 @@ private static byte[] write(final OutputStream os, final String data, final Char
* Whether this instance was successfully closed.
*/
private final AtomicBoolean closed = new AtomicBoolean();
+
/**
* Whether this instance was successfully finished.
* <p>
diff --git a/src/main/java/org/apache/commons/compress/MemoryLimitException.java b/src/main/java/org/apache/commons/compress/MemoryLimitException.java
index da366d242..a6abc9548 100644
--- a/src/main/java/org/apache/commons/compress/MemoryLimitException.java
+++ b/src/main/java/org/apache/commons/compress/MemoryLimitException.java
@@ -98,6 +98,7 @@ public static long checkKiB(final long request, final long max) throws MemoryLim
/** A long instead of int to account for overflow in corrupt files. */
private final long memoryRequestKiB;
+
/** A long instead of int to account for overflow in corrupt files. */
private final long memoryLimitKiB;
diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
index f9c37d815..03b7a2a8b 100644
--- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
+++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
@@ -31,6 +31,7 @@
* </p>
*/
public interface CpioConstants {
+
/** Magic number of a cpio entry in the new format */
String MAGIC_NEW = "070701";
diff --git a/src/main/java/org/apache/commons/compress/archivers/sevenz/SubStreamsInfo.java b/src/main/java/org/apache/commons/compress/archivers/sevenz/SubStreamsInfo.java
index f15cba1ee..6666598e9 100644
--- a/src/main/java/org/apache/commons/compress/archivers/sevenz/SubStreamsInfo.java
+++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/SubStreamsInfo.java
@@ -32,10 +32,12 @@ final class SubStreamsInfo {
* Unpacked size of each unpacked stream.
*/
final long[] unpackSizes;
+
/**
* Whether CRC is present for each unpacked stream.
*/
final BitSet hasCrc;
+
/**
* CRCs of unpacked streams, if present.
*/
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
index f4cff02f6..e819a4dc6 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
@@ -52,6 +52,7 @@
*/
public class TarArchiveSparseEntry implements TarConstants {
+
/** If an extension sparse header follows. */
private final boolean isExtended;
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 7dd97a91d..1973ac07b 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
@@ -114,6 +114,7 @@ protected int read(final long pos, final ByteBuffer buf) throws IOException {
*/
// @formatter:on
public static final class Builder extends AbstractTarBuilder<TarFile, Builder> {
+
/**
* Constructs a new instance.
*/
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
index 40e59e776..4e90504f5 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/AsiExtraField.java
@@ -68,14 +68,17 @@ public class AsiExtraField implements ZipExtraField, UnixStat, Cloneable {
* Standard Unix stat(2) file mode.
*/
private int mode;
+
/**
* User ID.
*/
private int uid;
+
/**
* Group ID.
*/
private int gid;
+
/**
* File this entry points to, if it is a symbolic link.
*
@@ -84,6 +87,7 @@ public class AsiExtraField implements ZipExtraField, UnixStat, Cloneable {
* </p>
*/
private String link = "";
+
/**
* Is this an entry for a directory?
*/
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 f48e748d7..412a18186 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
@@ -47,10 +47,12 @@ public static final class UnparseableExtraField implements UnparseableExtraField
* Key for "throw an exception" action.
*/
public static final int THROW_KEY = 0;
+
/**
* Key for "skip" action.
*/
public static final int SKIP_KEY = 1;
+
/**
* Key for "read" action.
*/
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java
index 94451733b..2357ec64d 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java
@@ -26,6 +26,7 @@
* @since 1.19
*/
public interface UnparseableExtraFieldBehavior {
+
/**
* Decides what to do with extra field data that doesn't follow the recommended pattern.
*
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
index 0b1af97f0..6ceaee39e 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
@@ -37,24 +37,29 @@ public class UnsupportedZipFeatureException extends ZipException {
public static class Feature implements Serializable {
private static final long serialVersionUID = 4112582948775420359L;
+
/**
* The entry is encrypted.
*/
public static final Feature ENCRYPTION = new Feature("encryption");
+
/**
* The entry used an unsupported compression method.
*/
public static final Feature METHOD = new Feature("compression method");
+
/**
* The entry uses a data descriptor.
*/
public static final Feature DATA_DESCRIPTOR = new Feature("data descriptor");
+
/**
* The archive uses splitting or spanning.
*
* @since 1.5
*/
public static final Feature SPLITTING = new Feature("splitting");
+
/**
* The archive contains entries with unknown compressed size for a compression method that doesn't support detection of the end of the compressed
* stream.
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryPredicate.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryPredicate.java
index 1689a7eeb..9257dabd4 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryPredicate.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryPredicate.java
@@ -25,6 +25,7 @@
* @since 1.10
*/
public interface ZipArchiveEntryPredicate {
+
/**
* Indicate if the given entry should be included in the operation
*
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 a436bc533..bceaed7db 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
@@ -266,18 +266,22 @@ private static final class CurrentEntry {
* Current ZIP entry.
*/
private final ZipArchiveEntry entry = new ZipArchiveEntry();
+
/**
* Does the entry use a data descriptor?
*/
private boolean hasDataDescriptor;
+
/**
* Does the entry have a ZIP64 extended information extra field.
*/
private boolean usesZip64;
+
/**
* Number of bytes of entry content read by the client if the entry is STORED.
*/
private long bytesRead;
+
/**
* Number of bytes of entry content read from the stream.
* <p>
@@ -286,10 +290,12 @@ private static final class CurrentEntry {
* </p>
*/
private long bytesReadFromStream;
+
/**
* The checksum calculated as the current entry is read.
*/
private final CRC32 crc = new CRC32();
+
/**
* The input stream decompressing the data for shrunk and imploded entries.
*/
@@ -359,22 +365,30 @@ public static boolean matches(final byte[] buffer, final int length) {
/** The ZIP encoding to use for file names and the file comment. */
private final ZipEncoding zipEncoding;
+
/** Whether to look for and use Unicode extra fields. */
private final boolean useUnicodeExtraFields;
+
/** Inflater used for all deflated entries. */
private final Inflater inf = new Inflater(true);
+
/** Buffer used to read from the wrapped stream. */
private final ByteBuffer buf = ByteBuffer.allocate(ZipArchiveOutputStream.BUFFER_SIZE);
+
/** The entry that is currently being read. */
private CurrentEntry current;
+
/** Whether the stream has been closed. */
private boolean closed;
+
/** Whether the stream has reached the central directory - and thus found all entries. */
private boolean hitCentralDirectory;
+
/**
* When reading a stored entry that uses the data descriptor this stream has to read the full entry and caches it. This is the cache.
*/
private ByteArrayInputStream lastStoredEntry;
+
/**
* Whether the stream will try to read STORED entries that use a data descriptor. Setting it to true means we will not stop reading an entry with the
* compressed size, instead we will stop reading an entry when a data descriptor is met (by finding the Data Descriptor Signature). This will completely
@@ -385,10 +399,13 @@ public static boolean matches(final byte[] buffer, final int length) {
* </p>
*/
private final boolean supportStoredEntryDataDescriptor;
+
/** Count decompressed bytes for current entry */
private long uncompressedCount;
+
/** Whether the stream will try to skip the ZIP split signature(08074B50) at the beginning. **/
private final boolean skipSplitSignature;
+
/** Cached buffers - must only be used locally in the class (COMPRESS-172 - reduce garbage collection). */
private final byte[] lfhBuf = new byte[LFH_LEN];
private final byte[] skipBuf = new byte[1024];
@@ -396,6 +413,7 @@ public static boolean matches(final byte[] buffer, final int length) {
private final byte[] wordBuf = new byte[WORD];
private final byte[] twoDwordBuf = new byte[2 * DWORD];
private int entriesRead;
+
/**
* The factory for extra fields or null.
*/
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 4d8e50969..e5add710e 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
@@ -229,6 +229,7 @@ public String toString() {
/*
* Various ZIP constants shared between this class, ZipArchiveInputStream and ZipFile
*/
+
/**
* local file header signature
*/
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipConstants.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipConstants.java
index 637742863..911e8f4fb 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipConstants.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipConstants.java
@@ -24,6 +24,7 @@
* @since 1.3
*/
final class ZipConstants {
+
/** Masks last eight bits */
static final int BYTE_MASK = 0xFF;
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
index d6c23ce09..7c211a0a3 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
@@ -41,6 +41,7 @@
* </p>
*/
public interface ZipEncoding {
+
/**
* Check, whether the given string may be losslessly encoded using this encoding.
*
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipExtraField.java
index c8a135bda..bfda2c6af 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipExtraField.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipExtraField.java
@@ -29,6 +29,7 @@
* </p>
*/
public interface ZipExtraField {
+
/**
* Size of an extra field header (id + length).
*
diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
index d00ad33e3..30107cbfb 100644
--- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
@@ -364,10 +364,12 @@ static void recvDecodingTables(final BitInputStream bin, final Data dataShadow)
* Index of the last char in the block, so the block size == last + 1.
*/
private int last;
+
/**
* Index in zptr[] of original string after sorting.
*/
private int origPtr;
+
/**
* always: in the range 0 .. 9. The current block size is 100000 * this number.
*/
diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
index 8e6c80e98..72cb8e205 100644
--- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
@@ -372,6 +372,7 @@ private static void hbMakeCodeLengths(final byte[] len, final int[] freq, final
* Index of the last char in the block, so the block size == last + 1.
*/
private int last;
+
/**
* Always: in the range 0 .. 9. The current block size is 100000 * this number.
*/
@@ -391,6 +392,7 @@ private static void hbMakeCodeLengths(final byte[] len, final int[] freq, final
private int combinedCRC;
private final int allowableBlockSize;
+
/**
* All memory intensive stuff.
*/
diff --git a/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java b/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
index e9821f7ab..f28c7cac7 100644
--- a/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
+++ b/src/main/java/org/apache/commons/compress/compressors/deflate64/HuffmanDecoder.java
@@ -319,6 +319,7 @@ HuffmanState state() {
*/
private static final short[] RUN_LENGTH_TABLE = { 96, 128, 160, 192, 224, 256, 288, 320, 353, 417, 481, 545, 610, 738, 866, 994, 1123, 1379, 1635, 1891,
2148, 2660, 3172, 3684, 4197, 5221, 6245, 7269, 112 };
+
/**
* <pre>
* --------------------------------------------------------------------
@@ -346,10 +347,12 @@ HuffmanState state() {
16409, 24601, 32794, 49178, 65563, 98331, 131100, 196636, 262173, 393245, // 20-29
524318, 786462 // 30-31
};
+
/**
* When using dynamic huffman codes the order in which the values are stored follows the positioning below
*/
private static final int[] CODE_LENGTHS_ORDER = { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
+
/**
* Huffman Fixed Literal / Distance tables for mode 1
*/
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 2925703bf..da988e250 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
@@ -85,7 +85,6 @@ public enum OS {
*/
CPM(OS_CPM),
- // @formatter:off
/**
* 0: FAT filesystem (MS-DOS, OS/2, NT/Win32).
*/
@@ -140,7 +139,6 @@ public enum OS {
* 8: Z-System.
*/
Z_SYSTEM(OS_Z_SYSTEM);
- // @formatter:on
/**
* Gets the {@link OS} matching the given code.
@@ -302,6 +300,7 @@ public int type() {
private String fileName;
private Charset fileNameCharset = GzipUtils.GZIP_ENCODING;
private boolean headerCrc;
+
/**
* The most recent modification time (MTIME) of the original file being compressed.
* <p>
diff --git a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
index f37f84f8d..51120cc92 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipUtils.java
@@ -71,6 +71,7 @@ public class GzipUtils {
public static String getCompressedFilename(final String fileName) {
return FNU_INSTANCE.getCompressedFileName(fileName);
}
+
/**
* Maps the given file name to the name that the file should have after compression with gzip. Common file types with custom suffixes for compressed
* versions are automatically detected and correctly mapped. For example the name "package.tar" is mapped to "package.tgz". If no custom mapping is
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 94910ed05..6bade9e00 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
@@ -38,6 +38,7 @@
* @since 1.3
*/
public class Pack200Utils {
+
/**
* Normalizes a JAR archive in-place, so it can be safely signed and packed.
*
diff --git a/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/package-info.java b/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/package-info.java
index 23807b8cb..763c33c83 100644
--- a/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/package-info.java
+++ b/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/package-info.java
@@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
* Internal implementation package, <strong>not for public use</strong>.
*
diff --git a/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutParser.java b/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutParser.java
index f0415244c..ff98d4f32 100644
--- a/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutParser.java
+++ b/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutParser.java
@@ -42,6 +42,7 @@ public final class AttributeLayoutParser<T> {
* @param <T> The list body element type.
*/
public interface Factory<T> {
+
/**
* Creates a {@code call} layout element.
*
@@ -103,6 +104,7 @@ public interface Factory<T> {
* @param <T> The list body element type.
*/
public static final class UnionCaseData<T> {
+
/**
* Body of the union case.
*/
diff --git a/src/main/java/org/apache/commons/compress/harmony/internal/package-info.java b/src/main/java/org/apache/commons/compress/harmony/internal/package-info.java
index f50c6e47b..ea2b3b372 100644
--- a/src/main/java/org/apache/commons/compress/harmony/internal/package-info.java
+++ b/src/main/java/org/apache/commons/compress/harmony/internal/package-info.java
@@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
* Internal implementation package, <strong>not for public use</strong>.
*
diff --git a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
index 816444883..a08d1b9fd 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
@@ -29,11 +29,13 @@
* @see <a href="https://docs.oracle.com/en/java/javase/13/docs/specs/pack-spec.html">Pack200: A Packed Class Deployment Format For Java Applications</a>
*/
public class NewAttribute extends Attribute {
+
/**
* ErrorAttribute extends {@code NewAttribute} and manages attributes encountered by ASM that have had an error action specified to pack200 (for example via
* one of the -C, -M, -F or -D command line options such as -Cattribute-name=error)
*/
public static class ErrorAttribute extends NewAttribute {
+
/**
* Constructs a new ErrorAttribute.
*
diff --git a/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java b/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
index 63ffc05c5..8139449d8 100644
--- a/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
+++ b/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
@@ -26,6 +26,7 @@
* @since 1.10
*/
public interface ScatterGatherBackingStoreSupplier {
+
/**
* Constructs a ScatterGatherBackingStore.
*
diff --git a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
index 734834869..50ea804f5 100644
--- a/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/ByteUtils.java
@@ -40,6 +40,7 @@ public final class ByteUtils {
* @since 1.14
*/
public interface ByteConsumer {
+
/**
* The contract is similar to {@link OutputStream#write(int)}, consume the lower eight bytes of the int as a byte.
*
@@ -55,6 +56,7 @@ public interface ByteConsumer {
* @since 1.14
*/
public interface ByteSupplier {
+
/**
* The contract is similar to {@link InputStream#read()}, return the byte as an unsigned int, -1 if there are no more bytes.
*
diff --git a/src/main/java/org/apache/commons/compress/utils/CRC32VerifyingInputStream.java b/src/main/java/org/apache/commons/compress/utils/CRC32VerifyingInputStream.java
index d39c0af20..c17c87dcb 100644
--- a/src/main/java/org/apache/commons/compress/utils/CRC32VerifyingInputStream.java
+++ b/src/main/java/org/apache/commons/compress/utils/CRC32VerifyingInputStream.java
@@ -30,6 +30,7 @@
*/
@Deprecated
public class CRC32VerifyingInputStream extends ChecksumVerifyingInputStream {
+
/**
* Constructs a new instance.
*
diff --git a/src/main/java/org/apache/commons/compress/utils/CharsetNames.java b/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
index 2498f2c80..e54fc1af6 100644
--- a/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
+++ b/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
@@ -58,6 +58,7 @@
*/
@Deprecated
public class CharsetNames {
+
/**
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* <p>
diff --git a/src/main/java/org/apache/commons/compress/utils/ParsingUtils.java b/src/main/java/org/apache/commons/compress/utils/ParsingUtils.java
index 2b58611f6..7550edf3c 100644
--- a/src/main/java/org/apache/commons/compress/utils/ParsingUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/ParsingUtils.java
@@ -26,6 +26,7 @@
* @since 1.26.0
*/
public final class ParsingUtils {
+
/**
* Parses the provided string value to an Integer, assuming a base-10 radix
*