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 32f849824 Javadoc
32f849824 is described below
commit 32f8498244e8be1d8ba29057be3d632b62ad7066
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Dec 14 13:48:34 2023 -0500
Javadoc
---
.../apache/commons/compress/MemoryLimitException.java | 2 +-
.../commons/compress/archivers/ArchiveOutputStream.java | 2 +-
.../compress/archivers/ar/ArArchiveInputStream.java | 2 +-
.../compress/archivers/ar/ArArchiveOutputStream.java | 2 +-
.../compress/archivers/cpio/CpioArchiveOutputStream.java | 2 +-
.../commons/compress/archivers/cpio/CpioConstants.java | 16 ++++++++--------
.../commons/compress/archivers/sevenz/SevenZMethod.java | 2 +-
.../commons/compress/archivers/tar/TarArchiveEntry.java | 4 ++--
.../compress/archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../commons/compress/archivers/zip/ZipConstants.java | 6 +++---
.../lz77support/AbstractLZ77CompressorInputStream.java | 2 +-
11 files changed, 21 insertions(+), 21 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/MemoryLimitException.java
b/src/main/java/org/apache/commons/compress/MemoryLimitException.java
index ca9135180..f20e31e34 100644
--- a/src/main/java/org/apache/commons/compress/MemoryLimitException.java
+++ b/src/main/java/org/apache/commons/compress/MemoryLimitException.java
@@ -35,7 +35,7 @@ public class MemoryLimitException extends IOException {
+ "If the file is not corrupt, consider increasing the memory
limit.";
}
- /** long instead of int to account for overflow for corrupt files. */
+ /** A long instead of int to account for overflow for corrupt files. */
private final long memoryNeededInKb;
private final int memoryLimitInKb;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
index 76cc102a1..b53864e57 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
@@ -55,7 +55,7 @@ public abstract class ArchiveOutputStream<E extends
ArchiveEntry> extends Output
/** Temporary buffer used for the {@link #write(int)} method. */
private final byte[] oneByte = new byte[1];
- /** holds the number of bytes written to this stream. */
+ /** Holds the number of bytes written to this stream. */
private long bytesWritten;
/**
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
index d0f32954d..e2f55aa28 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStream.java
@@ -141,7 +141,7 @@ public class ArArchiveInputStream extends
ArchiveInputStream<ArArchiveEntry> {
*/
private long entryOffset = -1;
- /** cached buffer for meta data - must only be used locally in the class
(COMPRESS-172 - reduce garbage collection). */
+ /** Cached buffer for meta data - must only be used locally in the class
(COMPRESS-172 - reduce garbage collection). */
private final byte[] metaData = new byte[NAME_LEN + LAST_MODIFIED_LEN +
USER_ID_LEN + GROUP_ID_LEN + FILE_MODE_LEN + LENGTH_LEN];
/**
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
index 853cbf847..fae27a386 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
@@ -47,7 +47,7 @@ public class ArArchiveOutputStream extends
ArchiveOutputStream<ArArchiveEntry> {
private boolean haveUnclosedEntry;
private int longFileMode = LONGFILE_ERROR;
- /** indicates if this archive is finished */
+ /** Indicates if this archive is finished */
private boolean finished;
public ArArchiveOutputStream(final OutputStream out) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
index 80417c23e..95b549474 100644
---
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
@@ -74,7 +74,7 @@ public class CpioArchiveOutputStream extends
ArchiveOutputStream<CpioArchiveEntr
private boolean closed;
- /** indicates if this archive is finished */
+ /** Indicates if this archive is finished */
private boolean finished;
/**
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 50cb72ff6..d66a3e223 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
@@ -26,28 +26,28 @@ package org.apache.commons.compress.archivers.cpio;
* http://www.opengroup.org/onlinepubs/9699919799/basedefs/cpio.h.html has a
list of the C_xxx constants.
*/
public interface CpioConstants {
- /** magic number of a cpio entry in the new format */
+ /** Magic number of a cpio entry in the new format */
String MAGIC_NEW = "070701";
- /** magic number of a cpio entry in the new format with crc */
+ /** Magic number of a cpio entry in the new format with crc */
String MAGIC_NEW_CRC = "070702";
- /** magic number of a cpio entry in the old ascii format */
+ /** Magic number of a cpio entry in the old ascii format */
String MAGIC_OLD_ASCII = "070707";
- /** magic number of a cpio entry in the old binary format */
+ /** Magic number of a cpio entry in the old binary format */
int MAGIC_OLD_BINARY = 070707;
- /** write/read a CpioArchiveEntry in the new format. FORMAT_ constants are
internal. */
+ /** Write/read a CpioArchiveEntry in the new format. FORMAT_ constants are
internal. */
short FORMAT_NEW = 1;
- /** write/read a CpioArchiveEntry in the new format with crc. FORMAT_
constants are internal. */
+ /** Write/read a CpioArchiveEntry in the new format with crc. FORMAT_
constants are internal. */
short FORMAT_NEW_CRC = 2;
- /** write/read a CpioArchiveEntry in the old ascii format. FORMAT_
constants are internal. */
+ /** Write/read a CpioArchiveEntry in the old ascii format. FORMAT_
constants are internal. */
short FORMAT_OLD_ASCII = 4;
- /** write/read a CpioArchiveEntry in the old binary format. FORMAT_
constants are internal. */
+ /** Write/read a CpioArchiveEntry in the old binary format. FORMAT_
constants are internal. */
short FORMAT_OLD_BINARY = 8;
/** Mask for both new formats. FORMAT_ constants are internal. */
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethod.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethod.java
index 706a05b3f..29cc56b96 100644
---
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethod.java
+++
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethod.java
@@ -32,7 +32,7 @@ import java.util.Arrays;
* </p>
*/
public enum SevenZMethod {
- /** no compression at all */
+ /** No compression at all */
COPY(new byte[] { (byte) 0x00 }),
/** LZMA - only supported when reading */
LZMA(new byte[] { (byte) 0x03, (byte) 0x01, (byte) 0x01 }),
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 02b4ed449..2884eb2c3 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
@@ -367,7 +367,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
/** The entry's real size in case of a sparse file. */
private long realSize;
- /** is this entry a GNU sparse entry using one of the PAX formats? */
+ /** Is this entry a GNU sparse entry using one of the PAX formats? */
private boolean paxGNUSparse;
/**
@@ -375,7 +375,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
*/
private boolean paxGNU1XSparse;
- /** is this entry a star sparse entry using the PAX header? */
+ /** Is this entry a star sparse entry using the PAX header? */
private boolean starSparse;
/** The entry's file reference */
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 084027682..090cc99a5 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
@@ -260,7 +260,7 @@ public class ZipArchiveOutputStream extends
ArchiveOutputStream<ZipArchiveEntry>
*/
static final byte[] ZIP64_EOCD_LOC_SIG = ZipLong.getBytes(0X07064B50L); //
NOSONAR
- /** indicates if this archive is finished. protected for use in Jar
implementation */
+ /** Indicates if this archive is finished. protected for use in Jar
implementation */
protected boolean finished;
/**
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 6d4278af0..658e2e576 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
@@ -25,13 +25,13 @@ final class ZipConstants {
/** Masks last eight bits */
static final int BYTE_MASK = 0xFF;
- /** length of a ZipShort in bytes */
+ /** Length of a ZipShort in bytes */
static final int SHORT = 2;
- /** length of a ZipLong in bytes */
+ /** Length of a ZipLong in bytes */
static final int WORD = 4;
- /** length of a ZipEightByteInteger in bytes */
+ /** Length of a ZipEightByteInteger in bytes */
static final int DWORD = 8;
/** Initial ZIP specification version */
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
index a69ffbf30..d137663e6 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
@@ -98,7 +98,7 @@ public abstract class AbstractLZ77CompressorInputStream
extends CompressorInputS
/** Offset of the current back-reference. */
private int backReferenceOffset;
- /** uncompressed size */
+ /** Uncompressed size */
private int size;
// used in no-arg read method
