This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 225811e10 Javadoc
225811e10 is described below
commit 225811e1085844eca54f1ec7f7151c1e4a23c1de
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:21 2026 -0400
Javadoc
---
.../commons/compress/archivers/ArchiveEntry.java | 2 +-
.../compress/archivers/ArchiveInputStream.java | 2 +-
.../compress/archivers/ArchiveStreamFactory.java | 4 +-
.../archivers/ar/ArArchiveInputStream.java | 2 +-
.../archivers/dump/DumpArchiveConstants.java | 4 +-
.../compress/archivers/dump/DumpArchiveEntry.java | 4 +-
.../compress/archivers/sevenz/AbstractCoder.java | 4 +-
.../compress/archivers/sevenz/SevenZFile.java | 22 +++++------
.../archivers/sevenz/SevenZFileOptions.java | 2 +-
.../archivers/tar/TarArchiveInputStream.java | 2 +-
.../commons/compress/archivers/tar/TarFile.java | 2 +-
.../commons/compress/archivers/tar/TarUtils.java | 2 +-
.../compress/archivers/zip/AsiExtraField.java | 2 +-
.../compress/archivers/zip/CircularBuffer.java | 2 +-
.../archivers/zip/ExtraFieldParsingBehavior.java | 2 +-
.../compress/archivers/zip/ExtraFieldUtils.java | 16 ++++----
.../archivers/zip/UnparseableExtraFieldData.java | 2 +-
.../commons/compress/archivers/zip/X000A_NTFS.java | 4 +-
.../archivers/zip/X5455_ExtendedTimestamp.java | 4 +-
.../compress/archivers/zip/X7875_NewUnix.java | 4 +-
.../compress/archivers/zip/ZipArchiveEntry.java | 10 ++---
.../archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../compress/archivers/zip/ZipEncodingHelper.java | 2 +-
.../commons/compress/archivers/zip/ZipFile.java | 10 ++---
.../commons/compress/archivers/zip/ZipMethod.java | 2 +-
.../archivers/zip/ZipSplitOutputStream.java | 2 +-
.../commons/compress/archivers/zip/ZipUtil.java | 4 +-
.../compressors/CompressorStreamFactory.java | 4 +-
.../compress/compressors/gzip/ExtraField.java | 4 +-
.../gzip/GzipCompressorInputStream.java | 4 +-
.../compress/compressors/gzip/GzipParameters.java | 4 +-
.../lz4/BlockLZ4CompressorOutputStream.java | 2 +-
.../compressors/lz77support/Parameters.java | 2 +-
.../lzma/LZMACompressorInputStream.java | 2 +-
.../lzma/LZMACompressorOutputStream.java | 2 +-
.../snappy/SnappyCompressorOutputStream.java | 2 +-
.../compressors/xz/XZCompressorInputStream.java | 2 +-
.../compressors/xz/XZCompressorOutputStream.java | 2 +-
.../zstandard/ZstdCompressorOutputStream.java | 2 +-
.../harmony/internal/AttributeLayoutParser.java | 2 +-
.../harmony/internal/AttributeLayoutUtils.java | 2 +-
.../commons/compress/harmony/pack200/Codec.java | 4 +-
.../commons/compress/harmony/pack200/CpBands.java | 4 +-
.../commons/compress/harmony/pack200/IntList.java | 2 +-
.../compress/harmony/unpack200/BandSet.java | 44 +++++++++++-----------
.../harmony/unpack200/Pack200UnpackerAdapter.java | 8 ++--
.../harmony/unpack200/SegmentConstantPool.java | 2 +-
.../compress/harmony/unpack200/SegmentHeader.java | 2 +-
.../unpack200/bytecode/AnnotationsAttribute.java | 4 +-
.../harmony/unpack200/bytecode/ClassFileEntry.java | 2 +-
.../unpack200/bytecode/forms/ByteCodeForm.java | 2 +-
.../commons/compress/java/util/jar/Pack200.java | 4 +-
.../ScatterGatherBackingStoreSupplier.java | 2 +-
.../commons/compress/utils/ArchiveUtils.java | 2 +-
.../apache/commons/compress/utils/Charsets.java | 2 +-
.../org/apache/commons/compress/utils/Lists.java | 4 +-
.../apache/commons/compress/utils/TimeUtils.java | 4 +-
.../commons/compress/archivers/ListerTest.java | 2 +-
58 files changed, 125 insertions(+), 125 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
index e50f42dcb..8e1ad59bc 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
@@ -68,7 +68,7 @@ public interface ArchiveEntry {
* Resolves this entry in the given parent Path.
*
* @param parentPath the {@link Path#resolve(Path)} receiver.
- * @return a resolved and normalized Path.
+ * @return A resolved and normalized Path.
* @throws IOException if this method detects a Zip slip.
* @since 1.26.0
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
index 1e5819027..7f7e152bb 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ArchiveInputStream.java
@@ -241,7 +241,7 @@ protected int getMaxEntryNameLength() {
/**
* Returns an iterator over the SubField elements in this extra field in
proper sequence.
*
- * @return an iterator over the SubField elements in this extra field in
proper sequence.
+ * @return An iterator over the SubField elements in this extra field in
proper sequence.
* @since 1.27.0
*/
public IOIterator<E> iterator() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
index bf7336310..721c15b0a 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
@@ -558,7 +558,7 @@ public <O extends ArchiveOutputStream<? extends
ArchiveEntry>> O createArchiveOu
/**
* Gets an unmodifiable sorted map from input stream provider names to
provider objects.
*
- * @return an unmodifiable sorted map of from input stream provider names
to provider objects.
+ * @return An unmodifiable sorted map of from input stream provider names
to provider objects.
* @see #findAvailableArchiveInputStreamProviders()
*/
public SortedMap<String, ArchiveStreamProvider>
getArchiveInputStreamProviders() {
@@ -571,7 +571,7 @@ public SortedMap<String, ArchiveStreamProvider>
getArchiveInputStreamProviders()
/**
* Gets an unmodifiable sorted map from output stream provider names to
provider objects.
*
- * @return an unmodifiable sorted map of from input stream provider names
to provider objects.
+ * @return An unmodifiable sorted map of from input stream provider names
to provider objects.
* @see #findAvailableArchiveInputStreamProviders()
*/
public SortedMap<String, ArchiveStreamProvider>
getArchiveOutputStreamProviders() {
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 dc31018ce..354a07945 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
@@ -416,7 +416,7 @@ private boolean isGNULongName(final String name) {
* Parses the entry metadata from the provided raw record.
*
* @param headerBuf the buffer containing the entry metadata.
- * @return an {@link ArArchiveEntry} object containing the parsed metadata.
+ * @return An {@link ArArchiveEntry} object containing the parsed metadata.
* @throws IOException if the metadata cannot be parsed correctly.
*/
private ArArchiveEntry parseEntry(final byte[] headerBuf) throws
IOException {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveConstants.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveConstants.java
index 8ffd11597..7224622a1 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveConstants.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveConstants.java
@@ -54,7 +54,7 @@ public enum COMPRESSION_TYPE {
* Finds the matching enumeration value for the given code.
*
* @param code a code.
- * @return a value, never null.
+ * @return A value, never null.
*/
public static COMPRESSION_TYPE find(final int code) {
for (final COMPRESSION_TYPE e : values()) {
@@ -111,7 +111,7 @@ public enum SEGMENT_TYPE {
* Finds the matching enumeration value for the given code.
*
* @param code a code.
- * @return a value, or null if not found.
+ * @return A value, or null if not found.
*/
public static SEGMENT_TYPE find(final int code) {
for (final SEGMENT_TYPE e : values()) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
index 857c986e0..68b968954 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
@@ -248,7 +248,7 @@ public enum PERMISSION {
* Finds a matching set of enumeration values for the given code.
*
* @param code a code.
- * @return a Set of values, never null.
+ * @return A Set of values, never null.
*/
public static Set<PERMISSION> find(final int code) {
final Set<PERMISSION> set = new HashSet<>();
@@ -362,7 +362,7 @@ public enum TYPE {
* Finds a matching enumeration value for the given code.
*
* @param code a code.
- * @return a value, never null.
+ * @return A value, never null.
*/
public static TYPE find(final int code) {
TYPE type = UNKNOWN;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/AbstractCoder.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/AbstractCoder.java
index ab1e1b544..3c21bbe26 100644
---
a/src/main/java/org/apache/commons/compress/archivers/sevenz/AbstractCoder.java
+++
b/src/main/java/org/apache/commons/compress/archivers/sevenz/AbstractCoder.java
@@ -56,7 +56,7 @@ protected AbstractCoder(final Class<?>... optionClasses) {
/**
* Decodes using stream that reads from in using the configured coder and
password.
*
- * @return a stream that reads from in using the configured coder and
password.
+ * @return A stream that reads from in using the configured coder and
password.
*/
abstract InputStream decode(String archiveName, InputStream in, long
uncompressedLength, Coder coder, byte[] password, int maxMemoryLimitKiB)
throws IOException;
@@ -64,7 +64,7 @@ abstract InputStream decode(String archiveName, InputStream
in, long uncompresse
/**
* Encodes using a stream that writes to out using the given configuration.
*
- * @return a stream that writes to out using the given configuration.
+ * @return A stream that writes to out using the given configuration.
* @throws IOException Optionally thrown by subclassses.
*/
OutputStream encode(final OutputStream out, final Object options) throws
IOException {
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 2a7876963..f2ca82228 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
@@ -110,7 +110,7 @@ private long bindPairSize() {
/**
* Gets a size estimate in bytes.
*
- * @return a size estimate in bytes.
+ * @return A size estimate in bytes.
*/
private long coderSize() {
return 2 /* methodId is between 1 and four bytes currently, COPY
and LZMA2 are the most common with 1 */
@@ -121,7 +121,7 @@ private long coderSize() {
/**
* Gets a size estimate in bytes.
*
- * @return a size estimate in bytes.
+ * @return A size estimate in bytes.
*/
private long entrySize() {
return 100; /* real size depends on name length, everything
without name is about 70 bytes */
@@ -130,7 +130,7 @@ private long entrySize() {
/**
* Gets a size estimate in bytes.
*
- * @return a size estimate in bytes.
+ * @return A size estimate in bytes.
*/
long estimateSizeBytes() {
final long lowerBound = 16L * numberOfPackedStreams /* packSizes,
packCrcs in Archive */
@@ -416,7 +416,7 @@ private static long accumulate(final long sum, final long
y, final String descri
/**
* Creates a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
* @since 1.26.0
*/
public static Builder builder() {
@@ -494,7 +494,7 @@ public static boolean matches(final byte[] buffer, final
int ignored) {
* Reads the size of a header field and validates that it is not larger
than the remaining bytes in the header buffer.
*
* @param header the buffer containing the 7z header.
- * @return a non-negative int.
+ * @return A non-negative int.
* @throws ArchiveException if the value is truncated, too large, or
exceeds the remaining bytes in the header buffer.
*/
static int readFieldSize(final ByteBuffer header) throws ArchiveException {
@@ -508,7 +508,7 @@ static int readFieldSize(final ByteBuffer header) throws
ArchiveException {
* Reads a 7z REAL_UINT64 from the header.
*
* @param header the buffer containing the 7z header.
- * @return a non-negative long.
+ * @return A non-negative long.
* @throws ArchiveException if the value is truncated or too large.
*/
static long readRealUint64(final ByteBuffer header) throws IOException {
@@ -524,7 +524,7 @@ static long readRealUint64(final ByteBuffer header) throws
IOException {
* Reads a 7z UINT32 from the header.
*
* @param header the buffer containing the 7z header.
- * @return a non-negative long.
+ * @return A non-negative long.
* @throws ArchiveException if the value is truncated.
*/
static long readUint32(final ByteBuffer header) throws ArchiveException {
@@ -535,7 +535,7 @@ static long readUint32(final ByteBuffer header) throws
ArchiveException {
* Reads a 7z UINT64 from the header.
*
* @param header the buffer containing the 7z header.
- * @return a non-negative long.
+ * @return A non-negative long.
* @throws ArchiveException if the value is truncated or too large.
*/
static long readUint64(final ByteBuffer header) throws ArchiveException {
@@ -565,7 +565,7 @@ static long readUint64(final ByteBuffer header) throws
ArchiveException {
* bytes in the header.</p>
*
* @param header the buffer containing the 7z header.
- * @return a non-negative int.
+ * @return A non-negative int.
* @throws ArchiveException if the value is truncated or too large.
* @see #readFieldSize(ByteBuffer)
*/
@@ -1145,7 +1145,7 @@ public String getDefaultName() {
* The content methods are only available for entries that have already
been reached via {@link #getNextEntry}.
* </p>
*
- * @return a copy of meta-data of all archive entries.
+ * @return A copy of meta-data of all archive entries.
* @since 1.11
* @deprecated Since 1.29.0, use {@link #entries()} or {@link #stream()}.
*/
@@ -1161,7 +1161,7 @@ public Iterable<SevenZArchiveEntry> getEntries() {
* </p>
*
* @param entry the entry to get the stream for.
- * @return a stream to read the entry from.
+ * @return A stream to read the entry from.
* @throws IOException if unable to create an input stream from the entry.
* @since 1.20
*/
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 39fcfb788..05f9044cc 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
@@ -111,7 +111,7 @@ public Builder withUseDefaultNameForUnnamedEntries(final
boolean useDefaultNameF
/**
* Obtains a builder for SevenZFileOptions.
*
- * @return a builder for SevenZFileOptions.
+ * @return A builder for SevenZFileOptions.
*/
public static Builder builder() {
return new Builder();
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
index 75d607d5f..956ab34d1 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
@@ -99,7 +99,7 @@ public TarArchiveInputStream get() throws IOException {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.29.0
*/
public static Builder builder() {
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 7e250e497..8780eb176 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
@@ -132,7 +132,7 @@ public TarFile get() throws IOException {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.29.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
index 43b3d2f4d..64f53da5d 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
@@ -799,7 +799,7 @@ static Map<String, String> parsePaxHeaders(final
InputStream inputStream, final
*
* @param buffer The buffer from which to parse.
* @param offset The offset into the buffer from which to parse.
- * @return a parsed sparse struct.
+ * @return A parsed sparse struct.
* @since 1.20
*/
public static TarArchiveStructSparse parseSparse(final byte[] buffer,
final int offset) {
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 09b32544e..af33c96e0 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
@@ -196,7 +196,7 @@ public byte[] getLocalFileDataData() {
/**
* Gets the length of the extra field in the local file data - without
Header-ID or length specifier.
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getLocalFileDataLength() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/CircularBuffer.java
b/src/main/java/org/apache/commons/compress/archivers/zip/CircularBuffer.java
index 21f8579a7..c9d404167 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/CircularBuffer.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/CircularBuffer.java
@@ -70,7 +70,7 @@ public void copy(final int distance, final int length) {
/**
* Reads a byte from the buffer.
*
- * @return a byte from the buffer.
+ * @return A byte from the buffer.
*/
public int get() {
if (available()) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
index 2e9a21f91..04eace3a7 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldParsingBehavior.java
@@ -34,7 +34,7 @@ public interface ExtraFieldParsingBehavior extends
UnparseableExtraFieldBehavior
* </p>
*
* @param headerId the id for the extra field.
- * @return an instance of ZipExtraField, must not be {@code null}.
+ * @return An instance of ZipExtraField, must not be {@code null}.
* @throws ZipException if an error occurs.
* @throws InstantiationException if unable to instantiate the class, not
thrown by Commons Compress.
* @throws IllegalAccessException if not allowed to instantiate the class,
not thrown by Commons Compress.
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 2bbc5a567..297aa9d19 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
@@ -143,7 +143,7 @@ public ZipExtraField onUnparseableExtraField(final byte[]
data, final int off, f
* Creates an instance of the appropriate ExtraField, falls back to {@link
UnrecognizedExtraField UnrecognizedExtraField}.
*
* @param headerId the header identifier.
- * @return an instance of the appropriate ExtraField.
+ * @return An instance of the appropriate ExtraField.
*/
public static ZipExtraField createExtraField(final ZipShort headerId) {
final ZipExtraField field = createExtraFieldNoDefault(headerId);
@@ -159,7 +159,7 @@ public static ZipExtraField createExtraField(final ZipShort
headerId) {
* Creates an instance of the appropriate {@link ZipExtraField}.
*
* @param headerId the header identifier.
- * @return an instance of the appropriate {@link ZipExtraField} or null if
the id is not supported.
+ * @return An instance of the appropriate {@link ZipExtraField} or null if
the id is not supported.
* @since 1.19
*/
public static ZipExtraField createExtraFieldNoDefault(final ZipShort
headerId) {
@@ -203,7 +203,7 @@ public static ZipExtraField fillExtraField(final
ZipExtraField ze, final byte[]
* Merges the central directory fields of the given ZipExtraFields.
*
* @param data an array of ExtraFields.
- * @return an array of bytes.
+ * @return An array of bytes.
*/
public static byte[] mergeCentralDirectoryData(final ZipExtraField[] data)
{
final int dataLength = data.length;
@@ -239,7 +239,7 @@ public static byte[] mergeCentralDirectoryData(final
ZipExtraField[] data) {
* Merges the local file data fields of the given ZipExtraFields.
*
* @param data an array of ExtraFiles.
- * @return an array of bytes.
+ * @return An array of bytes.
*/
public static byte[] mergeLocalFileDataData(final ZipExtraField[] data) {
final int dataLength = data.length;
@@ -276,7 +276,7 @@ public static byte[] mergeLocalFileDataData(final
ZipExtraField[] data) {
* Parses the array into ExtraFields and populate them with the given data
as local file data, throwing an exception if the data cannot be parsed.
*
* @param data an array of bytes as it appears in local file data.
- * @return an array of ExtraFields.
+ * @return An array of ExtraFields.
* @throws ZipException on error.
*/
public static ZipExtraField[] parse(final byte[] data) throws ZipException
{
@@ -288,7 +288,7 @@ public static ZipExtraField[] parse(final byte[] data)
throws ZipException {
*
* @param data an array of bytes.
* @param local whether data originates from the local file data or the
central directory.
- * @return an array of ExtraFields.
+ * @return An array of ExtraFields.
* @throws ZipException on error.
*/
public static ZipExtraField[] parse(final byte[] data, final boolean
local) throws ZipException {
@@ -301,7 +301,7 @@ public static ZipExtraField[] parse(final byte[] data,
final boolean local) thro
* @param data an array of bytes.
* @param parsingBehavior controls parsing of extra fields.
* @param local whether data originates from the local file data
or the central directory.
- * @return an array of ExtraFields.
+ * @return An array of ExtraFields.
* @throws ZipException on error.
* @since 1.19
*/
@@ -340,7 +340,7 @@ public static ZipExtraField[] parse(final byte[] data,
final boolean local, fina
* @param data an array of bytes.
* @param local whether data originates from the local file
data or the central directory.
* @param onUnparseableData what to do if the extra field data cannot be
parsed.
- * @return an array of ExtraFields.
+ * @return An array of ExtraFields.
* @throws ZipException on error.
* @since 1.1
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
index 24f0fec6f..eca74ba99 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
@@ -67,7 +67,7 @@ public ZipShort getCentralDirectoryLength() {
/**
* The Header-ID.
*
- * @return a completely arbitrary value that should be ignored.
+ * @return A completely arbitrary value that should be ignored.
*/
@Override
public ZipShort getHeaderId() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
index 023d66fde..68ccd0c97 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
@@ -176,7 +176,7 @@ public byte[] getCentralDirectoryData() {
* For X5455 the central length is often smaller than the local length,
because central cannot contain access or create timestamps.
* </p>
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getCentralDirectoryLength() {
@@ -246,7 +246,7 @@ public byte[] getLocalFileDataData() {
/**
* Gets the length of the extra field in the local file data - without
Header-ID or length specifier.
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getLocalFileDataLength() {
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 1c4305b65..b2d8c8811 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
@@ -253,7 +253,7 @@ public byte[] getCentralDirectoryData() {
* For X5455 the central length is often smaller than the local length,
because central cannot contain access or create timestamps.
* </p>
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getCentralDirectoryLength() {
@@ -359,7 +359,7 @@ public byte[] getLocalFileDataData() {
/**
* Gets the length of the extra field in the local file data - without
Header-ID or length specifier.
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getLocalFileDataLength() {
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 226814a81..51e9a61f6 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
@@ -168,7 +168,7 @@ public byte[] getCentralDirectoryData() {
/**
* Length of the extra field in the central directory data - without
Header-ID or length specifier.
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getCentralDirectoryLength() {
@@ -241,7 +241,7 @@ public byte[] getLocalFileDataData() {
/**
* Length of the extra field in the local file data - without Header-ID or
length specifier.
*
- * @return a {@code ZipShort} for the length of the data of this extra
field.
+ * @return A {@code ZipShort} for the length of the data of this extra
field.
*/
@Override
public ZipShort getLocalFileDataLength() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
index f56fb1811..db3b9d8bf 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
@@ -566,7 +566,7 @@ private void addNTFSTimestamp(final FileTime
lastModifiedTime, final FileTime la
/**
* Overwrite clone.
*
- * @return a cloned copy of this ZipArchiveEntry.
+ * @return A cloned copy of this ZipArchiveEntry.
*/
@Override
public Object clone() {
@@ -722,7 +722,7 @@ public ZipExtraField getExtraField(final ZipShort type) {
* directory to store additional information.
* </p>
*
- * @return an array of the extra fields.
+ * @return An array of the extra fields.
*/
public ZipExtraField[] getExtraFields() {
return getParseableExtraFields();
@@ -732,7 +732,7 @@ public ZipExtraField[] getExtraFields() {
* Gets extra fields.
*
* @param includeUnparseable whether to also return unparseable extra
fields as {@link UnparseableExtraFieldData} if such data exists.
- * @return an array of the extra fields.
+ * @return An array of the extra fields.
* @since 1.1
*/
public ZipExtraField[] getExtraFields(final boolean includeUnparseable) {
@@ -743,7 +743,7 @@ public ZipExtraField[] getExtraFields(final boolean
includeUnparseable) {
* Gets extra fields.
*
* @param parsingBehavior controls parsing of extra fields.
- * @return an array of the extra fields.
+ * @return An array of the extra fields.
* @throws ZipException if parsing fails, cannot happen if {@code
* parsingBehavior} is {@link ExtraFieldParsingMode#BEST_EFFORT}.
* @since 1.19
@@ -1011,7 +1011,7 @@ public int getVersionRequired() {
/**
* Gets the hash code of the entry. This uses the name as the hash code.
*
- * @return a hash code.
+ * @return A hash code.
*/
@Override
public int hashCode() {
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 d2f732f8f..75f0d0e11 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
@@ -672,7 +672,7 @@ public ZipArchiveEntry createArchiveEntry(final File
inputFile, final String ent
* @param inputPath path to create the entry from.
* @param entryName name of the entry.
* @param options options indicating how symbolic links are handled.
- * @return a new instance.
+ * @return A new instance.
* @throws IOException if an I/O error occurs.
* @since 1.21
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
index 748528994..fc06372fb 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncodingHelper.java
@@ -96,7 +96,7 @@ private static boolean isUTF8Alias(final String name) {
* Returns a Charset for the named charset. If the name cannot find a
charset, return {@link Charset#defaultCharset()}.
*
* @param name The name of the requested charset, may be null.
- * @return a Charset for the named charset.
+ * @return A Charset for the named charset.
* @see Charset#defaultCharset()
*/
private static Charset toSafeCharset(final String name) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index 26df81f9f..b0232782d 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -487,7 +487,7 @@ public long getUncompressedCount() {
/**
* Creates a new Builder.
*
- * @return a new Builder.
+ * @return A new Builder.
* @since 1.26.0
*/
public static Builder builder() {
@@ -613,7 +613,7 @@ private static boolean
positionAtEndOfCentralDirectoryRecord(final SeekableByteC
* </ul>
*
* @param versionMadeBy version/.
- * @return a platform code.
+ * @return A platform code.
*/
static int toPlatform(final int versionMadeBy) {
return versionMadeBy >> BYTE_SHIFT & NIBLET_MASK;
@@ -1205,7 +1205,7 @@ public long getFirstLocalFileHeaderOffset() {
* Gets an InputStream for reading the contents of the given entry.
*
* @param entry the entry to get the stream for.
- * @return a stream to read the entry from. The returned stream implements
{@link InputStreamStatistics}.
+ * @return A stream to read the entry from. The returned stream implements
{@link InputStreamStatistics}.
* @throws IOException if unable to create an input stream from the
zipEntry.
*/
@Override
@@ -1328,7 +1328,7 @@ public String getUnixSymlink(final ZipArchiveEntry entry)
throws IOException {
* additional data to be read.
* </p>
*
- * @return a map of zip entries that didn't have the language encoding
flag set when read.
+ * @return A map of zip entries that didn't have the language encoding
flag set when read.
*/
private Map<ZipArchiveEntry, NameAndComment>
populateFromCentralDirectory() throws IOException {
final HashMap<ZipArchiveEntry, NameAndComment> noUTF8Flag = new
HashMap<>();
@@ -1735,7 +1735,7 @@ private boolean startsWithLocalFileHeader() throws
IOException {
* Entries appear in the {@code Stream} in the order they appear in the
central directory of the ZIP file.
* </p>
*
- * @return an ordered {@code Stream} of entries in this ZIP file.
+ * @return An ordered {@code Stream} of entries in this ZIP file.
* @throws IllegalStateException if the ZIP file has been closed.
* @since 1.28.0
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
index 63a7e16bc..565e540a5 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
@@ -232,7 +232,7 @@ static boolean isZstd(final int method) {
* Gets the code of the compression method.
*
* @see ZipArchiveEntry#getMethod()
- * @return an integer code for the method.
+ * @return An integer code for the method.
*/
public int getCode() {
return code;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
index 43483166f..8f68c51ca 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipSplitOutputStream.java
@@ -133,7 +133,7 @@ public void close() throws IOException {
* </p>
*
* @param zipSplitSegmentSuffixIndex.
- * @return a new Path.
+ * @return A new Path.
* @throws IOException if an I/O error occurs.
*/
private Path createNewSplitSegmentFile(final Integer
zipSplitSegmentSuffixIndex) throws IOException {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
index e212e48e3..f7256ef51 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
@@ -182,7 +182,7 @@ public static long dosToJavaTime(final long dosTime) {
* Converts a DOS date/time field to a Date object.
*
* @param zipDosTime contains the stored DOS time.
- * @return a Date instance corresponding to the given time.
+ * @return A Date instance corresponding to the given time.
*/
public static Date fromDosTime(final ZipLong zipDosTime) {
final long dosTime = zipDosTime.getValue();
@@ -268,7 +268,7 @@ static BigInteger longToBig(long l) {
*
* @param message the detail message.
* @param cause throwable The cause of this Throwable.
- * @return a new ZipException.
+ * @return A new ZipException.
*/
static ZipException newZipException(final String message, final Throwable
cause) {
return (ZipException) new ZipException(message).initCause(cause);
diff --git
a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
index 0a6ff2e53..4bc707cda 100644
---
a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
+++
b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
@@ -727,7 +727,7 @@ public CompressorOutputStream<? extends OutputStream>
createCompressorOutputStre
/**
* Gets a sorted map of compression input stream providers.
*
- * @return a sorted map of compression input stream providers.
+ * @return A sorted map of compression input stream providers.
*/
public SortedMap<String, CompressorStreamProvider>
getCompressorInputStreamProviders() {
if (compressorInputStreamProviders == null) {
@@ -739,7 +739,7 @@ public SortedMap<String, CompressorStreamProvider>
getCompressorInputStreamProvi
/**
* Gets a sorted map of compression output stream providers.
*
- * @return a sorted map of compression output stream providers.
+ * @return A sorted map of compression output stream providers.
*/
public SortedMap<String, CompressorStreamProvider>
getCompressorOutputStreamProviders() {
if (compressorOutputStreamProviders == null) {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
index 17fec2f07..90bb39069 100644
--- a/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
+++ b/src/main/java/org/apache/commons/compress/compressors/gzip/ExtraField.java
@@ -178,7 +178,7 @@ public int hashCode() {
* </pre>
*
* @param bytes without the {@code XLEN} field.
- * @return a new instance.
+ * @return A new instance.
* @throws CompressorException Thrown for a formatting problem.
*/
static ExtraField fromBytes(final byte[] bytes) throws CompressorException
{
@@ -320,7 +320,7 @@ public boolean isEmpty() {
/**
* Returns an unmodifiable iterator over the elements in the SubField list
in proper sequence.
*
- * @return an unmodifiable naturally ordered iterator over the SubField
elements.
+ * @return An unmodifiable naturally ordered iterator over the SubField
elements.
*/
@Override
public Iterator<SubField> iterator() {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
index 06813ef94..07877ec1d 100644
---
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
@@ -117,7 +117,7 @@ public Builder() {
* You must set input that supports {@link InputStream}, otherwise,
this method throws an exception.
* </p>
*
- * @return a new instance.
+ * @return A new instance.
* @throws IllegalStateException if the {@code origin} is
{@code null}.
* @throws UnsupportedOperationException if the origin cannot be
converted to an {@link InputStream}.
* @see AbstractOrigin#getInputStream(java.nio.file.OpenOption...)
@@ -210,7 +210,7 @@ public Builder setOnMemberStart(final
IOConsumer<GzipCompressorInputStream> onMe
/**
* Constructs a new builder of {@link GzipCompressorInputStream}.
*
- * @return a new builder of {@link GzipCompressorInputStream}.
+ * @return A new builder of {@link GzipCompressorInputStream}.
* @since 1.28.0
*/
public static Builder builder() {
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 565e69629..8bb09c6e5 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
@@ -144,7 +144,7 @@ public enum OS {
* Gets the {@link OS} matching the given code.
*
* @param code an OS or {@link #UNKNOWN} for no match.
- * @return a {@link OS}.
+ * @return A {@link OS}.
* @throws CompressException Thrown when the {@code code} is
undefined, as opposed to {@code UNKNOWN}.
*/
public static OS from(final int code) throws CompressException {
@@ -351,7 +351,7 @@ public int getBufferSize() {
/**
* Gets an arbitrary user-defined comment.
*
- * @return a user-defined comment.
+ * @return A user-defined comment.
*/
public String getComment() {
return comment;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorOutputStream.java
index 7a4821e1a..eef9c579c 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorOutputStream.java
@@ -177,7 +177,7 @@ void writeTo(final OutputStream out) throws IOException {
/**
* Returns a builder correctly configured for the LZ4 algorithm.
*
- * @return a builder correctly configured for the LZ4 algorithm.
+ * @return A builder correctly configured for the LZ4 algorithm.
*/
public static Parameters.Builder createParameterBuilder() {
final int maxLen = BlockLZ4CompressorInputStream.WINDOW_SIZE - 1;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
index 809148b1f..b3eb217ac 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
@@ -253,7 +253,7 @@ public Builder withNiceBackReferenceLength(final int
niceLen) {
*
* @param windowSize the size of the sliding window - this determines the
maximum offset a back-reference can take. Must be a power of two.
* @throws IllegalArgumentException if windowSize is not a power of two.
- * @return a builder configured for the given window size.
+ * @return A builder configured for the given window size.
*/
public static Builder builder(final int windowSize) {
return new Builder(windowSize);
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
index df5d74df1..0384eafa3 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
@@ -88,7 +88,7 @@ public Builder setMemoryLimitKiB(final int memoryLimitKiB) {
/**
* Constructs a new builder of {@link LZMACompressorOutputStream}.
*
- * @return a new builder of {@link LZMACompressorOutputStream}.
+ * @return A new builder of {@link LZMACompressorOutputStream}.
* @since 1.28.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
index 0e18c5a20..45a5c1261 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorOutputStream.java
@@ -88,7 +88,7 @@ public Builder setLzma2Options(final LZMA2Options
lzma2Options) {
/**
* Constructs a new builder of {@link LZMACompressorOutputStream}.
*
- * @return a new builder of {@link LZMACompressorOutputStream}.
+ * @return A new builder of {@link LZMACompressorOutputStream}.
* @since 1.28.0
*/
public static Builder builder() {
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 163970e54..ea8457942 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
@@ -88,7 +88,7 @@ public class SnappyCompressorOutputStream extends
CompressorOutputStream<OutputS
* 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 given 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 6d5500113..605bc9047 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
@@ -120,7 +120,7 @@ public Builder setMemoryLimitKiB(final int memoryLimitKiB) {
/**
* Constructs a new builder of {@link LZMACompressorOutputStream}.
*
- * @return a new builder of {@link LZMACompressorOutputStream}.
+ * @return A new builder of {@link LZMACompressorOutputStream}.
* @since 1.28.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
index 6e01c0a5d..8ba3e6013 100644
---
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
@@ -105,7 +105,7 @@ public Builder setLzma2Options(final LZMA2Options
lzma2Options) {
/**
* Constructs a new builder of {@link XZCompressorOutputStream}.
*
- * @return a new builder of {@link XZCompressorOutputStream}.
+ * @return A new builder of {@link XZCompressorOutputStream}.
* @since 1.28.0
*/
public static Builder builder() {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
index bee04f2b8..4663561b0 100644
---
a/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/zstandard/ZstdCompressorOutputStream.java
@@ -453,7 +453,7 @@ public Builder setWorkers(final int workers) {
/**
* Constructs a new builder of {@link ZstdCompressorOutputStream}.
*
- * @return a new builder of {@link ZstdCompressorOutputStream}.
+ * @return A new builder of {@link ZstdCompressorOutputStream}.
* @since 1.28.0
*/
public static Builder builder() {
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 ff98d4f32..ef50f5e09 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
@@ -448,7 +448,7 @@ private UnionCaseData<T> readUnionCase() throws
Pack200Exception {
/**
* Reads an {@code unsigned_int} layout definition from the stream.
*
- * @return an {@code unsigned_int} layout definition from the stream.
+ * @return An {@code unsigned_int} layout definition from the stream.
* @throws Pack200Exception If the definition is invalid.
*/
private String readUnsignedInt() throws Pack200Exception {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutUtils.java
b/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutUtils.java
index f16b8e38f..014d7d0b1 100644
---
a/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutUtils.java
+++
b/src/main/java/org/apache/commons/compress/harmony/internal/AttributeLayoutUtils.java
@@ -224,7 +224,7 @@ public static <T> List<T> readBody(final String body, final
AttributeLayoutParse
* Converts a list of integers to a list of ranges where each range
represents a single integer.
*
* @param tags the list of integer tags
- * @return a list of ranges representing the tags
+ * @return A list of ranges representing the tags
*/
public static List<IntegerRange> toRanges(final List<Integer> tags) {
return tags.stream().map(n -> IntegerRange.of(n,
n)).collect(Collectors.toList());
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
index 769eb9d7b..e373a4aca 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
@@ -148,7 +148,7 @@ int check(final int n, final InputStream in) throws
Pack200Exception {
*
* @param n the number of values to decode
* @param in the input stream to read from
- * @return an array of {@code int} values corresponding to values decoded
+ * @return An array of {@code int} values corresponding to values decoded
* @throws IOException if there is a problem reading from the
underlying input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
@@ -168,7 +168,7 @@ public int[] decodeInts(final int n, final InputStream in)
throws IOException, P
* @param n the number of values to decode
* @param in the input stream to read from
* @param firstValue the first value in the band if it has already been
read
- * @return an array of {@code int} values corresponding to values decoded,
with firstValue as the first value in the array.
+ * @return An array of {@code int} values corresponding to values decoded,
with firstValue as the first value in the array.
* @throws IOException if there is a problem reading from the
underlying input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
index 55f9782e9..6c7766a97 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CpBands.java
@@ -218,7 +218,7 @@ public CPConstant<?> getConstant(final Object value) {
* Gets a constant pool class for the given class name.
*
* @param className a fully-qualified class name.
- * @return a constant pool class.
+ * @return A constant pool class.
*/
public CPClass getCPClass(String className) {
if (className == null) {
@@ -356,7 +356,7 @@ public CPNameAndType getCPNameAndType(final String name,
final String signature)
* Gets a constant pool signature.
*
* @param signature the signature string.
- * @return a constant pool signature.
+ * @return A constant pool signature.
*/
public CPSignature getCPSignature(final String signature) {
if (signature == null) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
index 7acad4c12..f789ee823 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
@@ -275,7 +275,7 @@ public int size() {
/**
* Converts this list to an array.
*
- * @return an array containing all integers in this list.
+ * @return An array containing all integers in this list.
*/
public int[] toArray() {
final int size = lastIndex - firstIndex;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
index 93c218e14..854049b14 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
@@ -87,7 +87,7 @@ public BandSet(final Segment segment) {
* @param in the InputStream to decode.
* @param codec the default Codec for this band.
* @param count the number of elements to read.
- * @return an array of decoded {@code int} values.
+ * @return An array of decoded {@code int} values.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -155,7 +155,7 @@ public int[] decodeBandInt(final String name, final
InputStream in, final BHSDCo
* @param in the InputStream to decode from
* @param defaultCodec the default codec for this band
* @param counts the numbers of elements to read for each int array
within the array to be returned
- * @return an array of decoded {@code int[]} values
+ * @return An array of decoded {@code int[]} values
* @throws IOException if there is a problem reading from the
underlying input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
@@ -183,7 +183,7 @@ public int[][] decodeBandInt(final String name, final
InputStream in, final BHSD
*
* @param ints The indices into the {@code reference} array.
* @param reference The source array.
- * @return a new array.
+ * @return A new array.
*/
protected String[] getReferences(final int[] ints, final String[]
reference) {
return ArrayUtils.setAll(new String[ints.length], i ->
reference[ints[i]]);
@@ -194,7 +194,7 @@ protected String[] getReferences(final int[] ints, final
String[] reference) {
*
* @param ints The indices into the {@code reference} array.
* @param reference The source array.
- * @return a new array.
+ * @return A new array.
*/
protected String[][] getReferences(final int[][] ints, final String[]
reference) {
final String[][] result = new String[ints.length][];
@@ -214,7 +214,7 @@ protected String[][] getReferences(final int[][] ints,
final String[] reference)
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPClass}.
+ * @return An array of decoded {@link CPClass}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -232,7 +232,7 @@ public CPClass[] parseCPClassReferences(final String name,
final InputStream in,
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPNameAndType}.
+ * @return An array of decoded {@link CPNameAndType}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -250,7 +250,7 @@ public CPNameAndType[] parseCPDescriptorReferences(final
String name, final Inpu
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPDouble}.
+ * @return An array of decoded {@link CPDouble}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -268,7 +268,7 @@ public CPDouble[] parseCPDoubleReferences(final String
name, final InputStream i
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPFieldRef}.
+ * @return An array of decoded {@link CPFieldRef}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -286,7 +286,7 @@ public CPFieldRef[] parseCPFieldRefReferences(final String
name, final InputStre
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPFloat}.
+ * @return An array of decoded {@link CPFloat}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -304,7 +304,7 @@ public CPFloat[] parseCPFloatReferences(final String name,
final InputStream in,
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPInterfaceMethodRef}.
+ * @return An array of decoded {@link CPInterfaceMethodRef}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -322,7 +322,7 @@ public CPInterfaceMethodRef[]
parseCPInterfaceMethodRefReferences(final String n
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPInteger}.
+ * @return An array of decoded {@link CPInteger}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -349,7 +349,7 @@ public CPInteger[] parseCPIntReferences(final String name,
final InputStream in,
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPLong}.
+ * @return An array of decoded {@link CPLong}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -376,7 +376,7 @@ public CPLong[] parseCPLongReferences(final String name,
final InputStream in, f
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPMethodRef}.
+ * @return An array of decoded {@link CPMethodRef}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -394,7 +394,7 @@ public CPMethodRef[] parseCPMethodRefReferences(final
String name, final InputSt
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPUTF8}.
+ * @return An array of decoded {@link CPUTF8}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -412,7 +412,7 @@ public CPUTF8[] parseCPSignatureReferences(final String
name, final InputStream
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param counts the number of elements to read.
- * @return an array of array of decoded {@link CPUTF8}.
+ * @return An array of array of decoded {@link CPUTF8}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -443,7 +443,7 @@ protected CPUTF8[][] parseCPSignatureReferences(final
String name, final InputSt
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPString}.
+ * @return An array of decoded {@link CPString}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -461,7 +461,7 @@ public CPString[] parseCPStringReferences(final String
name, final InputStream i
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param count the number of elements to read.
- * @return an array of decoded {@link CPUTF8}.
+ * @return An array of decoded {@link CPUTF8}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -479,7 +479,7 @@ public CPUTF8[] parseCPUTF8References(final String name,
final InputStream in, f
* @param in the input stream to parse.
* @param codec the default {@link BHSDCodec} for this band
* @param counts the number of elements to read.
- * @return an array of array of decoded {@link CPUTF8}.
+ * @return An array of array of decoded {@link CPUTF8}.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -512,7 +512,7 @@ public CPUTF8[][] parseCPUTF8References(final String name,
final InputStream in,
* @param count the number of elements to read.
* @param hiCodec an optional codec if the high flag is on.
* @param loCodec the codec.
- * @return an array of decoded {@code long} flags.
+ * @return An array of decoded {@code long} flags.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -529,7 +529,7 @@ public long[] parseFlags(final String name, final
InputStream in, final int coun
* @param count the number of elements to read.
* @param codec the codec.
* @param hasHi whether to the high flag is enabled.
- * @return an array of decoded {@code long} flags.
+ * @return An array of decoded {@code long} flags.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -546,7 +546,7 @@ public long[] parseFlags(final String name, final
InputStream in, final int coun
* @param counts the number of elements to read.
* @param hiCodec an optional codec if the high flag is on.
* @param loCodec the codec.
- * @return an array of decoded {@code long} flags.
+ * @return An array of decoded {@code long} flags.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
@@ -587,7 +587,7 @@ public long[][] parseFlags(final String name, final
InputStream in, final int[]
* @param counts the number of elements to read.
* @param codec the codec.
* @param hasHi whether the high flag is enabnled.
- * @return an array of decoded {@code long} flags.
+ * @return An array of decoded {@code long} flags.
* @throws IOException if there is a problem reading from the
underlying input stream.
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid.
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
index cbde81642..2dedd671b 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Pack200UnpackerAdapter.java
@@ -52,7 +52,7 @@ public class Pack200UnpackerAdapter extends Pack200Adapter
implements Unpacker {
* </p>
*
* @param file The file.
- * @return a new BoundedInputStream
+ * @return A new BoundedInputStream
* @throws IOException if an I/O error occurs
*/
static BoundedInputStream newBoundedInputStream(final File file) throws
IOException {
@@ -90,7 +90,7 @@ static BoundedInputStream newBoundedInputStream(final
InputStream inputStream) t
* </p>
*
* @param path The path.
- * @return a new BoundedInputStream
+ * @return A new BoundedInputStream
* @throws IOException if an I/O error occurs
*/
@SuppressWarnings("resource") // Caller closes.
@@ -112,7 +112,7 @@ static BoundedInputStream newBoundedInputStream(final Path
path) throws IOExcept
*
* @param first the path string or initial part of the path string.
* @param more additional strings to be joined to form the path string.
- * @return a new BoundedInputStream
+ * @return A new BoundedInputStream
* @throws IOException if an I/O error occurs
*/
static BoundedInputStream newBoundedInputStream(final String first, final
String... more) throws IOException {
@@ -126,7 +126,7 @@ static BoundedInputStream newBoundedInputStream(final
String first, final String
* </p>
*
* @param url The URL.
- * @return a new BoundedInputStream
+ * @return A new BoundedInputStream
* @throws IOException if an I/O error occurs.
* @throws URISyntaxException if the URL is not formatted strictly
according to RFC2396 and cannot be converted to a URI.
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
index 7a595fe3c..4527a5851 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
@@ -208,7 +208,7 @@ public ConstantPoolEntry getClassSpecificPoolEntry(final
int cp, final long desi
*
* @param type Constant pool type.
* @param index Index into a specific constant pool.
- * @return a constant pool entry.
+ * @return A constant pool entry.
* @throws Pack200Exception if a type is not supported or the index not in
the range [0, {@link Integer#MAX_VALUE}].
*/
public ConstantPoolEntry getConstantPoolEntry(final int type, final long
index) throws Pack200Exception {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
index f43cbf4a8..8b676e90f 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
@@ -127,7 +127,7 @@ private int decodeScalar(final String name, final
InputStream in, final BHSDCode
* @param name the name of the scalar (primarily for logging/debugging
purposes)
* @param in the input stream to read from
* @param codec the codec for this scalar
- * @return an array of decoded {@code long[]} values
+ * @return An array of decoded {@code long[]} values
* @throws IOException if there is a problem reading from the
underlying input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationsAttribute.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationsAttribute.java
index 2c0bfdc2d..3ad27835f 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationsAttribute.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/AnnotationsAttribute.java
@@ -64,7 +64,7 @@ public Annotation(final int numPairs, final CPUTF8 type,
final CPUTF8[] elementN
/**
* Gets a list of class file entries.
*
- * @return a list of class file entries.
+ * @return A list of class file entries.
*/
public List<Object> getClassFileEntries() {
final List<Object> entries = new ArrayList<>();
@@ -147,7 +147,7 @@ public ElementValue(final int tag, final Object value) {
/**
* Gets a list of class file entries.
*
- * @return a list of class file entries.
+ * @return A list of class file entries.
*/
public List<Object> getClassFileEntries() {
final List<Object> entries = new ArrayList<>(1);
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
index 09e06e7e4..8a964f05f 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
@@ -54,7 +54,7 @@ public ClassFileEntry() {
/**
* Returns an empty array.
*
- * @return an empty array.
+ * @return An empty array.
*/
protected ClassFileEntry[] getNestedClassFileEntries() {
return NONE;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java
index 8a6ba4525..9304a7f7c 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/forms/ByteCodeForm.java
@@ -444,7 +444,7 @@ public int[] getRewrite() {
/**
* Gets a copy of the rewrite array.
*
- * @return a copy of the rewrite array.
+ * @return A copy of the rewrite array.
*/
public int[] getRewriteCopy() {
return Arrays.copyOf(rewrite, rewrite.length);
diff --git
a/src/main/java/org/apache/commons/compress/java/util/jar/Pack200.java
b/src/main/java/org/apache/commons/compress/java/util/jar/Pack200.java
index fae5f2d69..c136eddd9 100644
--- a/src/main/java/org/apache/commons/compress/java/util/jar/Pack200.java
+++ b/src/main/java/org/apache/commons/compress/java/util/jar/Pack200.java
@@ -283,7 +283,7 @@ static Object newInstance(final String systemProperty,
final String defaultClass
* instance of the specified class is returned, otherwise the system's
default implementation is returned.
* </p>
*
- * @return an instance of {@code Packer}.
+ * @return An instance of {@code Packer}.
*/
public static Pack200.Packer newPacker() {
return (Packer) newInstance(SYSTEM_PROPERTY_PACKER,
"org.apache.commons.compress.harmony.pack200.Pack200PackerAdapter");
//$NON-NLS-1$
@@ -296,7 +296,7 @@ public static Pack200.Packer newPacker() {
* the specified class is returned, otherwise the system's default
implementation is returned.
* </p>
*
- * @return an instance of {@link Pack200.Unpacker}.
+ * @return An instance of {@link Pack200.Unpacker}.
*/
public static Pack200.Unpacker newUnpacker() {
return (Unpacker) newInstance(SYSTEM_PROPERTY_UNPACKER,
"org.apache.commons.compress.harmony.unpack200.Pack200UnpackerAdapter");
//$NON-NLS-1$
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 8139449d8..3c4076543 100644
---
a/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
+++
b/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
@@ -30,7 +30,7 @@ public interface ScatterGatherBackingStoreSupplier {
/**
* Constructs a ScatterGatherBackingStore.
*
- * @return a ScatterGatherBackingStore, not null.
+ * @return A ScatterGatherBackingStore, not null.
* @throws IOException when something fails.
*/
ScatterGatherBackingStore get() throws IOException;
diff --git a/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
b/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
index 5ca3b95fd..a656bd17d 100644
--- a/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
@@ -205,7 +205,7 @@ public static boolean matchAsciiBuffer(final String
expected, final byte[] buffe
* </p>
*
* @param s the string to sanitize.
- * @return a sanitized version of the argument.
+ * @return A sanitized version of the argument.
* @since 1.12
*/
public static String sanitize(final String s) {
diff --git a/src/main/java/org/apache/commons/compress/utils/Charsets.java
b/src/main/java/org/apache/commons/compress/utils/Charsets.java
index bd1e8c25c..7cd60c022 100644
--- a/src/main/java/org/apache/commons/compress/utils/Charsets.java
+++ b/src/main/java/org/apache/commons/compress/utils/Charsets.java
@@ -158,7 +158,7 @@ public static Charset toCharset(final Charset charset) {
* Returns a Charset for the named charset. If the name is null, return
the default Charset.
*
* @param charset The name of the requested charset, may be null.
- * @return a Charset for the named charset.
+ * @return A Charset for the named charset.
* @throws java.nio.charset.UnsupportedCharsetException If the named
charset is unavailable.
* @throws java.nio.charset.IllegalCharsetNameException If the given
charset name is illegal.
*/
diff --git a/src/main/java/org/apache/commons/compress/utils/Lists.java
b/src/main/java/org/apache/commons/compress/utils/Lists.java
index f67529948..c25744c0c 100644
--- a/src/main/java/org/apache/commons/compress/utils/Lists.java
+++ b/src/main/java/org/apache/commons/compress/utils/Lists.java
@@ -33,7 +33,7 @@ public class Lists {
* Creates a new {@link ArrayList}.
*
* @param <E> type of elements contained in new list.
- * @return a new {@link ArrayList}.
+ * @return A new {@link ArrayList}.
*/
public static <E> ArrayList<E> newArrayList() {
return new ArrayList<>();
@@ -44,7 +44,7 @@ public static <E> ArrayList<E> newArrayList() {
*
* @param iterator the source iterator.
* @param <E> type of elements contained in new list.
- * @return a new {@link ArrayList}.
+ * @return A new {@link ArrayList}.
*/
public static <E> ArrayList<E> newArrayList(final Iterator<? extends E>
iterator) {
final ArrayList<E> list = newArrayList();
diff --git a/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
b/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
index ec589bbae..85678b837 100644
--- a/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/TimeUtils.java
@@ -109,7 +109,7 @@ public static FileTime ntfsTimeToFileTime(final long
ntfsTime) {
* Converts {@link FileTime} to a {@link Date}. If the provided FileTime
is {@code null}, the returned Date is also {@code null}.
*
* @param fileTime the file time to be converted.
- * @return a {@link Date} which corresponds to the supplied time, or
{@code null} if the time is {@code null}.
+ * @return A {@link Date} which corresponds to the supplied time, or
{@code null} if the time is {@code null}.
* @see FileTimes#toFileTime(Date)
* @deprecated Use {@link FileTimes#toDate(FileTime)}.
*/
@@ -122,7 +122,7 @@ public static Date toDate(final FileTime fileTime) {
* Converts {@link Date} to a {@link FileTime}. If the provided Date is
{@code null}, the returned FileTime is also {@code null}.
*
* @param date the date to be converted.
- * @return a {@link FileTime} which corresponds to the supplied date, or
{@code null} if the date is {@code null}.
+ * @return A {@link FileTime} which corresponds to the supplied date, or
{@code null} if the date is {@code null}.
* @see FileTimes#toDate(FileTime)
* @deprecated Use {@link FileTimes#toFileTime(Date)}.
*/
diff --git
a/src/test/java/org/apache/commons/compress/archivers/ListerTest.java
b/src/test/java/org/apache/commons/compress/archivers/ListerTest.java
index c9ce60a65..f644bcae0 100644
--- a/src/test/java/org/apache/commons/compress/archivers/ListerTest.java
+++ b/src/test/java/org/apache/commons/compress/archivers/ListerTest.java
@@ -34,7 +34,7 @@ class ListerTest {
/**
* Creates a stream of paths of test fixtures with file names that don't
end with {@code "-fail"} or {@code "-lenient"} for specific file extensions.
*
- * @return a stream of paths.
+ * @return A stream of paths.
* @throws IOException if an I/O error is thrown.
*/
public static Stream<Path> getFixtures() throws IOException {
