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 d8804b50e Javadoc
d8804b50e is described below
commit d8804b50e00081ab238541aca3c395f6553c5375
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Nov 10 17:33:28 2023 -0500
Javadoc
---
.../archivers/cpio/CpioArchiveInputStream.java | 8 +++---
.../archivers/cpio/CpioArchiveOutputStream.java | 10 ++++----
.../compress/archivers/tar/TarArchiveEntry.java | 30 +++++++++++-----------
.../archivers/tar/TarArchiveSparseEntry.java | 2 +-
.../compress/archivers/zip/NioZipEncoding.java | 2 +-
.../harmony/unpack200/AttributeLayout.java | 2 +-
6 files changed, 27 insertions(+), 27 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
index 806e84430..20acf251a 100644
---
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
@@ -156,7 +156,7 @@ public class CpioArchiveInputStream extends
ArchiveInputStream<CpioArchiveEntry>
final String encoding;
/**
- * Construct the cpio input stream with a blocksize of {@link
+ * Constructs the cpio input stream with a blocksize of {@link
* CpioConstants#BLOCK_SIZE BLOCK_SIZE} and expecting ASCII file
* names.
*
@@ -168,7 +168,7 @@ public class CpioArchiveInputStream extends
ArchiveInputStream<CpioArchiveEntry>
}
/**
- * Construct the cpio input stream with a blocksize of {@link
+ * Constructs the cpio input stream with a blocksize of {@link
* CpioConstants#BLOCK_SIZE BLOCK_SIZE} expecting ASCII file
* names.
*
@@ -183,7 +183,7 @@ public class CpioArchiveInputStream extends
ArchiveInputStream<CpioArchiveEntry>
}
/**
- * Construct the cpio input stream with a blocksize of {@link
CpioConstants#BLOCK_SIZE BLOCK_SIZE}.
+ * Constructs the cpio input stream with a blocksize of {@link
CpioConstants#BLOCK_SIZE BLOCK_SIZE}.
*
* @param in
* The cpio stream
@@ -206,7 +206,7 @@ public class CpioArchiveInputStream extends
ArchiveInputStream<CpioArchiveEntry>
}
/**
- * Construct the cpio input stream with a blocksize of {@link
+ * Constructs the cpio input stream with a blocksize of {@link
* CpioConstants#BLOCK_SIZE BLOCK_SIZE}.
*
* @param in
diff --git
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
index 872c6cef7..b5d59fda2 100644
---
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
@@ -100,7 +100,7 @@ public class CpioArchiveOutputStream extends
ArchiveOutputStream<CpioArchiveEntr
final String encoding;
/**
- * Construct the cpio output stream. The format for this CPIO stream is the
+ * Constructs the cpio output stream. The format for this CPIO stream is
the
* "new" format using ASCII encoding for file names
*
* @param out
@@ -111,7 +111,7 @@ public class CpioArchiveOutputStream extends
ArchiveOutputStream<CpioArchiveEntr
}
/**
- * Construct the cpio output stream with a specified format, a
+ * Constructs the cpio output stream with a specified format, a
* blocksize of {@link CpioConstants#BLOCK_SIZE BLOCK_SIZE} and
* using ASCII as the file name encoding.
*
@@ -125,7 +125,7 @@ public class CpioArchiveOutputStream extends
ArchiveOutputStream<CpioArchiveEntr
}
/**
- * Construct the cpio output stream with a specified format using
+ * Constructs the cpio output stream with a specified format using
* ASCII as the file name encoding.
*
* @param out
@@ -143,7 +143,7 @@ public class CpioArchiveOutputStream extends
ArchiveOutputStream<CpioArchiveEntr
}
/**
- * Construct the cpio output stream with a specified format using
+ * Constructs the cpio output stream with a specified format using
* ASCII as the file name encoding.
*
* @param out
@@ -178,7 +178,7 @@ public class CpioArchiveOutputStream extends
ArchiveOutputStream<CpioArchiveEntr
}
/**
- * Construct the cpio output stream. The format for this CPIO stream is the
+ * Constructs the cpio output stream. The format for this CPIO stream is
the
* "new" format.
*
* @param out
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
index 5f62ea377..360f9407a 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
@@ -394,7 +394,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
private long dataOffset = EntryStreamOffsets.OFFSET_UNKNOWN;
/**
- * Construct an empty entry and prepares the header values.
+ * Constructs an empty entry and prepares the header values.
*/
private TarArchiveEntry(final boolean preserveAbsolutePath) {
String user = System.getProperty("user.name", "");
@@ -410,7 +410,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry from an archive's header bytes. File is set
+ * Constructs an entry from an archive's header bytes. File is set
* to null.
*
* @param headerBuf The header bytes from a tar archive entry.
@@ -422,7 +422,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry from an archive's header bytes. File is set
+ * Constructs an entry from an archive's header bytes. File is set
* to null.
*
* @param headerBuf The header bytes from a tar archive entry.
@@ -437,7 +437,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry from an archive's header bytes. File is set
+ * Constructs an entry from an archive's header bytes. File is set
* to null.
*
* @param headerBuf The header bytes from a tar archive entry.
@@ -454,7 +454,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry from an archive's header bytes for random access
tar. File is set to null.
+ * Constructs an entry from an archive's header bytes for random access
tar. File is set to null.
* @param headerBuf the header bytes from a tar archive entry.
* @param encoding encoding to use for file names.
* @param lenient when set to true illegal values for group/userid, mode,
device numbers and timestamp will be
@@ -471,7 +471,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry for a file. File is set to file, and the
+ * Constructs an entry for a file. File is set to file, and the
* header is constructed from information from the file.
* The name is set from the normalized file path.
*
@@ -493,7 +493,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry for a file. File is set to file, and the
+ * Constructs an entry for a file. File is set to file, and the
* header is constructed from information from the file.
*
* <p>The entry's name will be the value of the {@code fileName}
@@ -537,7 +537,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry from an archive's header bytes. File is set to null.
+ * Constructs an entry from an archive's header bytes. File is set to null.
*
* @param globalPaxHeaders the parsed global PAX headers, or null if this
is the first one.
* @param headerBuf The header bytes from a tar archive entry.
@@ -555,7 +555,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry from an archive's header bytes for random access
tar. File is set to null.
+ * Constructs an entry from an archive's header bytes for random access
tar. File is set to null.
* @param globalPaxHeaders the parsed global PAX headers, or null if this
is the first one.
* @param headerBuf the header bytes from a tar archive entry.
* @param encoding encoding to use for file names.
@@ -573,7 +573,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry for a file. File is set to file, and the
+ * Constructs an entry for a file. File is set to file, and the
* header is constructed from information from the file.
* The name is set from the normalized file path.
*
@@ -592,7 +592,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry for a file. File is set to file, and the
+ * Constructs an entry for a file. File is set to file, and the
* header is constructed from information from the file.
*
* <p>The entry's name will be the value of the {@code fileName}
@@ -620,7 +620,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry with only a name. This allows the programmer
+ * Constructs an entry with only a name. This allows the programmer
* to construct the entry's header "by hand". File is set to null.
*
* <p>The entry's name will be the value of the {@code name}
@@ -634,7 +634,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry with only a name. This allows the programmer
+ * Constructs an entry with only a name. This allows the programmer
* to construct the entry's header "by hand". File is set to null.
*
* <p>The entry's name will be the value of the {@code name}
@@ -662,7 +662,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry with a name and a link flag.
+ * Constructs an entry with a name and a link flag.
*
* <p>The entry's name will be the value of the {@code name}
* argument with all file separators replaced by forward slashes
@@ -677,7 +677,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Construct an entry with a name and a link flag.
+ * Constructs an entry with a name and a link flag.
*
* <p>The entry's name will be the value of the {@code name}
* argument with all file separators replaced by forward slashes.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
index c21556af9..0926ff8c5 100644
---
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveSparseEntry.java
@@ -53,7 +53,7 @@ public class TarArchiveSparseEntry implements TarConstants {
private final List<TarArchiveStructSparse> sparseHeaders;
/**
- * Construct an entry from an archive's header bytes. File is set
+ * Constructs an entry from an archive's header bytes. File is set
* to null.
*
* @param headerBuf The header bytes from a tar archive entry.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
b/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
index 89c857f81..b1499945f 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
@@ -101,7 +101,7 @@ final class NioZipEncoding implements ZipEncoding,
CharsetAccessor {
private final boolean useReplacement;
/**
- * Construct an NioZipEncoding using the given charset.
+ * Constructs an NioZipEncoding using the given charset.
* @param charset The character set to use.
* @param useReplacement should invalid characters be replaced, or
reported.
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
index 0948b074a..2df7da0f0 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
@@ -260,7 +260,7 @@ public class AttributeLayout implements IMatcher {
private int backwardsCallCount;
/**
- * Construct a default AttributeLayout (equivalent to
+ * Constructs a default AttributeLayout (equivalent to
* {@code new AttributeLayout(name, context, layout, index, true);})
*
* @param name TODO
