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 5016e93fa Javadoc
5016e93fa is described below
commit 5016e93fadd74a122c5126eb352c4a10ec36166e
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jan 13 16:58:17 2024 -0500
Javadoc
---
.../commons/compress/archivers/ArchiveStreamFactory.java | 2 +-
.../commons/compress/archivers/sevenz/SevenZOutputFile.java | 4 ++--
.../commons/compress/archivers/zip/ExtraFieldUtils.java | 4 ++--
.../commons/compress/archivers/zip/StreamCompressor.java | 12 ++++++------
.../compress/archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../org/apache/commons/compress/archivers/zip/ZipLong.java | 4 ++--
.../commons/compress/archivers/zip/ZipSplitOutputStream.java | 4 ++--
7 files changed, 16 insertions(+), 16 deletions(-)
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 646120ba7..f95896edc 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
@@ -387,7 +387,7 @@ public class ArchiveStreamFactory implements
ArchiveStreamProvider {
}
/**
- * Create an archive input stream from an input stream, autodetecting the
archive type from the first few bytes of the stream. The InputStream must
support
+ * Creates an archive input stream from an input stream, autodetecting the
archive type from the first few bytes of the stream. The InputStream must
support
* marks, like BufferedInputStream.
*
* @param <I> The {@link ArchiveInputStream} type.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
index 66c2ad3a8..eab13c467 100644
---
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
+++
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
@@ -241,7 +241,7 @@ public class SevenZOutputFile implements Closeable {
}
/**
- * Create an archive entry using the inputFile and entryName provided.
+ * Creates an archive entry using the inputFile and entryName provided.
*
* @param inputFile file to create an entry from
* @param entryName the name to use
@@ -260,7 +260,7 @@ public class SevenZOutputFile implements Closeable {
}
/**
- * Create an archive entry using the inputPath and entryName provided.
+ * Creates an archive entry using the inputPath and entryName provided.
*
* @param inputPath path to create an entry from
* @param entryName the name to use
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 4d22853ec..12a0acf1e 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
@@ -136,7 +136,7 @@ public class ExtraFieldUtils {
static final ZipExtraField[] EMPTY_ZIP_EXTRA_FIELD_ARRAY = {};
/**
- * Create an instance of the appropriate ExtraField, falls back to {@link
UnrecognizedExtraField UnrecognizedExtraField}.
+ * 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
@@ -154,7 +154,7 @@ public class ExtraFieldUtils {
}
/**
- * Create an instance of the appropriate ExtraField.
+ * Creates an instance of the appropriate ExtraField.
*
* @param headerId the header identifier
* @return an instance of the appropriate ExtraField or null if the id is
not supported
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
b/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
index d30db30dd..c2bd12047 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
@@ -103,7 +103,7 @@ public abstract class StreamCompressor implements Closeable
{
private static final int BUFFER_SIZE = 4096;
/**
- * Create a stream compressor with the given compression level.
+ * Creates a stream compressor with the given compression level.
*
* @param os The DataOutput to receive output
* @param deflater The deflater to use for the compressor
@@ -114,7 +114,7 @@ public abstract class StreamCompressor implements Closeable
{
}
/**
- * Create a stream compressor with the given compression level.
+ * Creates a stream compressor with the given compression level.
*
* @param compressionLevel The {@link Deflater} compression level
* @param bs The ScatterGatherBackingStore to receive output
@@ -126,7 +126,7 @@ public abstract class StreamCompressor implements Closeable
{
}
/**
- * Create a stream compressor with the default compression level.
+ * Creates a stream compressor with the default compression level.
*
* @param os The stream to receive output
* @return A stream compressor
@@ -136,7 +136,7 @@ public abstract class StreamCompressor implements Closeable
{
}
/**
- * Create a stream compressor with the given compression level.
+ * Creates a stream compressor with the given compression level.
*
* @param os The stream to receive output
* @param deflater The deflater to use
@@ -147,7 +147,7 @@ public abstract class StreamCompressor implements Closeable
{
}
/**
- * Create a stream compressor with the default compression level.
+ * Creates a stream compressor with the default compression level.
*
* @param bs The ScatterGatherBackingStore to receive output
* @return A stream compressor
@@ -157,7 +157,7 @@ public abstract class StreamCompressor implements Closeable
{
}
/**
- * Create a stream compressor with the given compression level.
+ * Creates a stream compressor with the given compression level.
*
* @param os The SeekableByteChannel to receive output
* @param deflater The deflater to use for the compressor
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 576a4e552..55d12c228 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
@@ -138,7 +138,7 @@ public class ZipArchiveOutputStream extends
ArchiveOutputStream<ZipArchiveEntry>
public static final UnicodeExtraFieldPolicy NEVER = new
UnicodeExtraFieldPolicy("never");
/**
- * Create Unicode extra fields for file names that cannot be encoded
using the specified encoding.
+ * Creates Unicode extra fields for file names that cannot be encoded
using the specified encoding.
*/
public static final UnicodeExtraFieldPolicy NOT_ENCODEABLE = new
UnicodeExtraFieldPolicy("not encodeable");
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 37ea47d73..90cf3df3b 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
@@ -129,7 +129,7 @@ public final class ZipLong implements Cloneable,
Serializable {
}
/**
- * Create instance from the four bytes starting at offset.
+ * Creates instance from the four bytes starting at offset.
*
* @param bytes the bytes to store as a ZipLong
* @param offset the offset to start
@@ -149,7 +149,7 @@ public final class ZipLong implements Cloneable,
Serializable {
}
/**
- * Create instance from a number.
+ * Creates instance from a number.
*
* @param value the long to store as a ZipLong
*/
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 acc6bc6a1..c8aae07ca 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
@@ -92,7 +92,7 @@ final class ZipSplitOutputStream extends OutputStream {
}
/**
- * Create the new ZIP split segment, the last ZIP segment should be .zip,
and the ZIP split segments' suffix should be like .z01, .z02, .z03, ... .z99,
+ * Creates the new ZIP split segment, the last ZIP segment should be .zip,
and the ZIP split segments' suffix should be like .z01, .z02, .z03, ... .z99,
* .z100, ..., .z(N-1), .zip
* <p>
* 8.3.3 Split ZIP files are typically written to the same location and
are subject to name collisions if the spanned name format is used since each
segment
@@ -151,7 +151,7 @@ final class ZipSplitOutputStream extends OutputStream {
}
/**
- * Create a new ZIP split segment and prepare to write to the new segment
+ * Creates a new ZIP split segment and prepare to write to the new segment
*
* @throws IOException
*/
