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 204f74759 Javadoc
204f74759 is described below
commit 204f74759531cd6eda5406e81d9a5b760505809f
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jan 13 16:56:58 2024 -0500
Javadoc
---
.../apache/commons/compress/PasswordRequiredException.java | 2 +-
.../commons/compress/archivers/ArchiveStreamFactory.java | 4 ++--
.../apache/commons/compress/archivers/ar/ArArchiveEntry.java | 4 ++--
.../compress/archivers/jar/JarArchiveOutputStream.java | 2 +-
.../commons/compress/archivers/zip/ExplodingInputStream.java | 2 +-
.../compress/archivers/zip/ZipArchiveInputStream.java | 12 ++++++------
.../commons/compress/archivers/zip/ZipEightByteInteger.java | 8 ++++----
.../org/apache/commons/compress/archivers/zip/ZipLong.java | 2 +-
.../org/apache/commons/compress/archivers/zip/ZipShort.java | 6 +++---
.../org/apache/commons/compress/harmony/pack200/BandSet.java | 4 ++--
.../commons/compress/harmony/pack200/SegmentHeader.java | 2 +-
.../compress/harmony/unpack200/bytecode/CPConstant.java | 2 +-
.../compress/harmony/unpack200/bytecode/CPMember.java | 2 +-
.../compress/harmony/unpack200/bytecode/CPNameAndType.java | 2 +-
.../commons/compress/harmony/unpack200/bytecode/CPRef.java | 2 +-
.../harmony/unpack200/bytecode/ExceptionTableEntry.java | 4 ++--
.../compress/parallel/ScatterGatherBackingStoreSupplier.java | 2 +-
.../commons/compress/utils/BoundedArchiveInputStream.java | 2 +-
.../utils/BoundedSeekableByteChannelInputStream.java | 2 +-
.../commons/compress/utils/FixedLengthBlockOutputStream.java | 4 ++--
20 files changed, 35 insertions(+), 35 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/PasswordRequiredException.java
b/src/main/java/org/apache/commons/compress/PasswordRequiredException.java
index 4e8e60d66..0c51afd59 100644
--- a/src/main/java/org/apache/commons/compress/PasswordRequiredException.java
+++ b/src/main/java/org/apache/commons/compress/PasswordRequiredException.java
@@ -28,7 +28,7 @@ public class PasswordRequiredException extends IOException {
private static final long serialVersionUID = 1391070005491684483L;
/**
- * Create a new exception.
+ * Constructs a new exception.
*
* @param name name of the archive containing encrypted streams or the
encrypted file.
*/
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 f11c8f8ab..646120ba7 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
@@ -367,14 +367,14 @@ public class ArchiveStreamFactory implements
ArchiveStreamProvider {
private SortedMap<String, ArchiveStreamProvider>
archiveOutputStreamProviders;
/**
- * Create an instance using the platform default encoding.
+ * Constructs an instance using the platform default encoding.
*/
public ArchiveStreamFactory() {
this(null);
}
/**
- * Create an instance using the specified encoding.
+ * Constructs an instance using the specified encoding.
*
* @param encoding the encoding to be used.
*
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
index 14cde6516..536388644 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
@@ -103,7 +103,7 @@ public class ArArchiveEntry implements ArchiveEntry {
}
/**
- * Create a new instance using a couple of default values.
+ * Constructs a new instance using a couple of default values.
*
* <p>
* Sets userId and groupId to 0, the octal file mode to 644 and the last
modified time to the current time.
@@ -117,7 +117,7 @@ public class ArArchiveEntry implements ArchiveEntry {
}
/**
- * Create a new instance.
+ * Constructs a new instance.
*
* @param name name of the entry
* @param length length of the entry in bytes
diff --git
a/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveOutputStream.java
index c764d1f7c..de04d7e72 100644
---
a/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveOutputStream.java
@@ -39,7 +39,7 @@ public class JarArchiveOutputStream extends
ZipArchiveOutputStream {
}
/**
- * Create and instance that wraps the output stream using the provided
encoding.
+ * Constructs a new instance that wraps the output stream using the
provided encoding.
*
* @param out the output stream to wrap
* @param encoding the encoding to use. Use null for the platform default.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
index 9c8309db3..8ccd71bd8 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java
@@ -69,7 +69,7 @@ final class ExplodingInputStream extends InputStream
implements InputStreamStati
private long treeSizes;
/**
- * Create a new stream decompressing the content of the specified stream
using the explode algorithm.
+ * Constructs a new stream decompressing the content of the specified
stream using the explode algorithm.
*
* @param dictionarySize the size of the sliding dictionary (4096 or 8192)
* @param numberOfTrees the number of trees (2 or 3)
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 0c6e62fb2..6b51d400c 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
@@ -311,7 +311,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
/** Whether the stream will try to skip the ZIP split signature(08074B50)
at the beginning **/
private final boolean skipSplitSig;
- // cached buffers - must only be used locally in the class (COMPRESS-172 -
reduce garbage collection)
+ /** 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];
@@ -325,7 +325,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
private int entriesRead;
/**
- * Create an instance using UTF-8 encoding
+ * Constructs an instance using UTF-8 encoding
*
* @param inputStream the stream to wrap
*/
@@ -334,7 +334,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
}
/**
- * Create an instance using the specified encoding
+ * Constructs an instance using the specified encoding
*
* @param inputStream the stream to wrap
* @param encoding the encoding to use for file names, use null for the
platform's default encoding
@@ -345,7 +345,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
}
/**
- * Create an instance using the specified encoding
+ * Constructs an instance using the specified encoding
*
* @param inputStream the stream to wrap
* @param encoding the encoding to use for file names, use
null for the platform's default encoding
@@ -356,7 +356,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
}
/**
- * Create an instance using the specified encoding
+ * Constructs an instance using the specified encoding
*
* @param inputStream the stream to wrap
* @param encoding the encoding to use for
file names, use null for the platform's default encoding
@@ -370,7 +370,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
}
/**
- * Create an instance using the specified encoding
+ * Constructs an instance using the specified encoding
*
* @param inputStream the stream to wrap
* @param encoding the encoding to use for
file names, use null for the platform's default encoding
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
index 01190cdb4..8af931710 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEightByteInteger.java
@@ -151,7 +151,7 @@ public final class ZipEightByteInteger implements
Serializable {
private final BigInteger value;
/**
- * Create instance from a number.
+ * Constructs a new instance from a number.
*
* @param value the BigInteger to store as a ZipEightByteInteger
*/
@@ -160,7 +160,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Create instance from bytes.
+ * Constructs a new instance from bytes.
*
* @param bytes the bytes to store as a ZipEightByteInteger
*/
@@ -169,7 +169,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Create instance from the eight bytes starting at offset.
+ * Constructs a new instance from the eight bytes starting at offset.
*
* @param bytes the bytes to store as a ZipEightByteInteger
* @param offset the offset to start
@@ -179,7 +179,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Create instance from a number.
+ * Constructs a new instance from a number.
*
* @param value the long to store as a ZipEightByteInteger
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
index 7fbdbbea5..37ea47d73 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
@@ -120,7 +120,7 @@ public final class ZipLong implements Cloneable,
Serializable {
private final long value;
/**
- * Create instance from bytes.
+ * Constructs a new instance from bytes.
*
* @param bytes the bytes to store as a ZipLong
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
index e8bb23d95..246bc284a 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
@@ -82,7 +82,7 @@ public final class ZipShort implements Cloneable,
Serializable {
private final int value;
/**
- * Create instance from bytes.
+ * Constructs a new instance from bytes.
*
* @param bytes the bytes to store as a ZipShort
*/
@@ -91,7 +91,7 @@ public final class ZipShort implements Cloneable,
Serializable {
}
/**
- * Create instance from the two bytes starting at offset.
+ * Constructs a new instance from the two bytes starting at offset.
*
* @param bytes the bytes to store as a ZipShort
* @param offset the offset to start
@@ -101,7 +101,7 @@ public final class ZipShort implements Cloneable,
Serializable {
}
/**
- * Create instance from a number.
+ * Constructs a new instance from a number.
*
* @param value the int to store as a ZipShort
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
index ee585e554..0459afb8c 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
@@ -75,7 +75,7 @@ public abstract class BandSet {
private Map<Integer, Integer> distinctValues;
/**
- * Create a new instance of BandData. The band is then analysed.
+ * Constructs a new instance of BandData. The band is then analysed.
*
* @param band - the band of integers
*/
@@ -190,7 +190,7 @@ public abstract class BandSet {
private long[] canonicalSmallest;
/**
- * Create a new BandSet
+ * Constructs a new BandSet.
*
* @param effort - the packing effort to be used (must be 1-9)
* @param header - the segment header
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
index 6a79c83d6..2920a1949 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
@@ -107,7 +107,7 @@ public class SegmentHeader extends BandSet {
private final Counter majverCounter = new Counter();
/**
- * Create a new SegmentHeader
+ * Constructs a new SegmentHeader
*/
public SegmentHeader() {
super(1, null); // Pass 1 for effort because bands in the segment
header
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
index 42e3ee0ca..793058a6e 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
@@ -26,7 +26,7 @@ public abstract class CPConstant extends ConstantPoolEntry {
private final Object value;
/**
- * Create a new CPConstant
+ * Constructs a new CPConstant.
*
* @param tag TODO
* @param value TODO
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
index 51e000199..ecc8a91f9 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
@@ -35,7 +35,7 @@ public class CPMember extends ClassFileEntry {
transient int descriptorIndex;
/**
- * Create a new CPMember
+ * Constructs a new CPMember.
*
* @param name TODO
* @param descriptor TODO
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
index 8ff03882b..ea4031733 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
@@ -40,7 +40,7 @@ public class CPNameAndType extends ConstantPoolEntry {
private int cachedHashCode;
/**
- * Create a new CPNameAndType
+ * Constructs a new CPNameAndType.
*
* @param name TODO
* @param descriptor TODO
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
index 1b509c245..90353639c 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
@@ -34,7 +34,7 @@ public abstract class CPRef extends ConstantPoolEntry {
protected String cachedToString;
/**
- * Create a new CPRef
+ * Constructs a new CPRef.
*
* @param type TODO
* @param className TODO
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
index 633d6a600..b60f4b135 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ExceptionTableEntry.java
@@ -36,8 +36,8 @@ public class ExceptionTableEntry {
private int catchTypeIndex;
/**
- * Create a new ExceptionTableEntry. Exception tables are of two kinds:
either a normal one (with a Throwable as the catchType) or a finally clause
(which
- * has no catchType). In the class file, the finally clause is represented
as catchType == 0.
+ * Constructs a new ExceptionTableEntry. Exception tables are of two
kinds: either a normal one (with a Throwable as the catchType) or a finally
clause
+ * (which has no catchType). In the class file, the finally clause is
represented as catchType == 0.
*
* To create a finally clause with this method, pass in null for the
catchType.
*
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 9a216a7b8..877a2b92e 100644
---
a/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
+++
b/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java
@@ -27,7 +27,7 @@ import java.io.IOException;
*/
public interface ScatterGatherBackingStoreSupplier {
/**
- * Create a ScatterGatherBackingStore.
+ * Constructs a ScatterGatherBackingStore.
*
* @return a ScatterGatherBackingStore, not null
* @throws IOException when something fails
diff --git
a/src/main/java/org/apache/commons/compress/utils/BoundedArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/utils/BoundedArchiveInputStream.java
index 19540c259..a22683527 100644
---
a/src/main/java/org/apache/commons/compress/utils/BoundedArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/BoundedArchiveInputStream.java
@@ -33,7 +33,7 @@ public abstract class BoundedArchiveInputStream extends
InputStream {
private long loc;
/**
- * Create a new bounded input stream.
+ * Constructs a new bounded input stream.
*
* @param start position in the stream from where the reading of this
bounded stream starts.
* @param remaining amount of bytes which are allowed to read from the
bounded stream.
diff --git
a/src/main/java/org/apache/commons/compress/utils/BoundedSeekableByteChannelInputStream.java
b/src/main/java/org/apache/commons/compress/utils/BoundedSeekableByteChannelInputStream.java
index 1004f4da6..2d40e1f29 100644
---
a/src/main/java/org/apache/commons/compress/utils/BoundedSeekableByteChannelInputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/BoundedSeekableByteChannelInputStream.java
@@ -31,7 +31,7 @@ public class BoundedSeekableByteChannelInputStream extends
BoundedArchiveInputSt
private final SeekableByteChannel channel;
/**
- * Create a bounded stream on the underlying {@link SeekableByteChannel}
+ * Constructs a bounded stream on the underlying {@link
SeekableByteChannel}
*
* @param start Position in the stream from where the reading of this
bounded stream starts
* @param remaining Amount of bytes which are allowed to read from the
bounded stream
diff --git
a/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
b/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
index 5ba2299cd..a9de3bf00 100644
---
a/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStream.java
@@ -111,7 +111,7 @@ public class FixedLengthBlockOutputStream extends
OutputStream implements Writab
private final AtomicBoolean closed = new AtomicBoolean(false);
/**
- * Create a fixed length block output stream with given destination stream
and block size
+ * Constructs a fixed length block output stream with given destination
stream and block size.
*
* @param os The stream to wrap.
* @param blockSize The block size to use.
@@ -129,7 +129,7 @@ public class FixedLengthBlockOutputStream extends
OutputStream implements Writab
}
/**
- * Create a fixed length block output stream with given destination
writable byte channel and block size
+ * Constructs a fixed length block output stream with given destination
writable byte channel and block size.
*
* @param out The writable byte channel to wrap.
* @param blockSize The block size to use.
