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 8b19ce5f Normalize setter Javadoc
8b19ce5f is described below
commit 8b19ce5f116dc88728bc5b7cb8571dc28feace82
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:02:01 2023 -0400
Normalize setter Javadoc
---
.../archivers/ar/ArArchiveOutputStream.java | 2 +-
.../compress/archivers/cpio/CpioConstants.java | 4 +--
.../compress/archivers/dump/DumpArchiveEntry.java | 26 +++++++-------
.../archivers/dump/DumpArchiveSummary.java | 22 ++++++------
.../compress/archivers/dump/TapeInputStream.java | 2 +-
.../archivers/sevenz/SevenZArchiveEntry.java | 6 ++--
.../compress/archivers/tar/TarArchiveEntry.java | 42 +++++++++++-----------
.../compress/archivers/zip/AsiExtraField.java | 4 +--
.../compress/archivers/zip/PKWareExtraHeader.java | 4 +--
.../archivers/zip/UnrecognizedExtraField.java | 6 ++--
.../compress/archivers/zip/ZipArchiveEntry.java | 4 +--
.../archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../harmony/pack200/NewAttributeBands.java | 2 +-
.../harmony/unpack200/NewAttributeBands.java | 2 +-
14 files changed, 64 insertions(+), 64 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
index 3dc98d00..c1ba2c98 100644
---
a/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
@@ -155,7 +155,7 @@ public class ArArchiveOutputStream extends
ArchiveOutputStream<ArArchiveEntry> {
}
/**
- * Set the long file mode.
+ * Sets the long file mode.
* This can be LONGFILE_ERROR(0) or LONGFILE_BSD(1).
* This specifies the treatment of long file names (names >= 16).
* Default is LONGFILE_ERROR.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
index 57c618e5..f15761c0 100644
---
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
+++
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
@@ -88,10 +88,10 @@ public interface CpioConstants {
int C_ISFIFO = 0010000;
- /** Set user ID */
+ /** Sets user ID */
int C_ISUID = 0004000;
- /** Set group ID */
+ /** Sets group ID */
int C_ISGID = 0002000;
/** On directories, restricted deletion flag. */
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 6d391bc5..c44c5f70 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
@@ -689,7 +689,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the time the file was last accessed.
+ * Sets the time the file was last accessed.
* @param atime the access time
*/
public void setAccessTime(final Date atime) {
@@ -697,7 +697,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the file creation time.
+ * Sets the file creation time.
* @param ctime the creation time
*/
public void setCreationTime(final Date ctime) {
@@ -705,7 +705,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set whether this file has been deleted.
+ * Sets whether this file has been deleted.
* @param isDeleted whether the file has been deleted
*/
public void setDeleted(final boolean isDeleted) {
@@ -713,7 +713,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the generation of the file.
+ * Sets the generation of the file.
* @param generation the generation
*/
public void setGeneration(final int generation) {
@@ -721,7 +721,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the group id.
+ * Sets the group id.
* @param gid the group id
*/
public void setGroupId(final int gid) {
@@ -729,7 +729,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the time the file was last modified.
+ * Sets the time the file was last modified.
* @param mtime the last modified time
*/
public void setLastModifiedDate(final Date mtime) {
@@ -737,7 +737,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the access permissions on the entry.
+ * Sets the access permissions on the entry.
* @param mode the access permissions
*/
public void setMode(final int mode) {
@@ -763,7 +763,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the number of hard links.
+ * Sets the number of hard links.
* @param nlink the number of hard links
*/
public void setNlink(final int nlink) {
@@ -771,7 +771,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the offset within the archive.
+ * Sets the offset within the archive.
* @param offset the offset
*/
public void setOffset(final long offset) {
@@ -787,7 +787,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the size of the entry.
+ * Sets the size of the entry.
* @param size the size
*/
public void setSize(final long size) {
@@ -795,7 +795,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the type of the entry.
+ * Sets the type of the entry.
* @param type the type
*/
public void setType(final TYPE type) {
@@ -803,7 +803,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the user id.
+ * Sets the user id.
* @param uid the user id
*/
public void setUserId(final int uid) {
@@ -811,7 +811,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Set the tape volume.
+ * Sets the tape volume.
* @param volume the volume
*/
public void setVolume(final int volume) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
index 16e63245..93d6621a 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
@@ -221,7 +221,7 @@ public class DumpArchiveSummary {
}
/**
- * Set the device name.
+ * Sets the device name.
* @param devname the device name
*/
public void setDevname(final String devname) {
@@ -229,7 +229,7 @@ public class DumpArchiveSummary {
}
/**
- * Set dump date.
+ * Sets dump date.
* @param dumpDate the dump date
*/
public void setDumpDate(final Date dumpDate) {
@@ -237,7 +237,7 @@ public class DumpArchiveSummary {
}
/**
- * Set the last mountpoint.
+ * Sets the last mountpoint.
* @param fileSystem the last mountpoint
*/
public void setFilesystem(final String fileSystem) {
@@ -245,7 +245,7 @@ public class DumpArchiveSummary {
}
/**
- * Set the inode of the first record.
+ * Sets the inode of the first record.
* @param firstrec the first record
*/
public void setFirstRecord(final int firstrec) {
@@ -253,7 +253,7 @@ public class DumpArchiveSummary {
}
/**
- * Set the miscellaneous flags.
+ * Sets the miscellaneous flags.
* @param flags flags
*/
public void setFlags(final int flags) {
@@ -261,7 +261,7 @@ public class DumpArchiveSummary {
}
/**
- * Set the hostname.
+ * Sets the hostname.
* @param hostname the host name
*/
public void setHostname(final String hostname) {
@@ -269,7 +269,7 @@ public class DumpArchiveSummary {
}
/**
- * Set dump label.
+ * Sets dump label.
* @param label the label
*/
public void setLabel(final String label) {
@@ -277,7 +277,7 @@ public class DumpArchiveSummary {
}
/**
- * Set level.
+ * Sets level.
* @param level the level
*/
public void setLevel(final int level) {
@@ -285,7 +285,7 @@ public class DumpArchiveSummary {
}
/**
- * Set the number of records per tape block.
+ * Sets the number of records per tape block.
* @param ntrec the number of records per tape block
*/
public void setNTRec(final int ntrec) {
@@ -293,7 +293,7 @@ public class DumpArchiveSummary {
}
/**
- * Set previous dump date.
+ * Sets previous dump date.
* @param previousDumpDate the previous dump dat
*/
public void setPreviousDumpDate(final Date previousDumpDate) {
@@ -301,7 +301,7 @@ public class DumpArchiveSummary {
}
/**
- * Set volume (tape) number.
+ * Sets volume (tape) number.
* @param volume the volume number
*/
public void setVolume(final int volume) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
index 66301bcf..f84d7a83 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
@@ -287,7 +287,7 @@ class TapeInputStream extends FilterInputStream {
}
/**
- * Set the DumpArchive Buffer's block size. We need to sync the block size
with the
+ * Sets the DumpArchive Buffer's block size. We need to sync the block
size with the
* dump archive's actual block size since compression is handled at the
* block level.
*
diff --git
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
index d1aac461..c3332ccd 100644
---
a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
@@ -450,7 +450,7 @@ public class SevenZArchiveEntry implements ArchiveEntry {
}
/**
- * Set this entry's compressed file size.
+ * Sets this entry's compressed file size.
*
* @param size This entry's new compressed file size.
*/
@@ -642,7 +642,7 @@ public class SevenZArchiveEntry implements ArchiveEntry {
}
/**
- * Set this entry's name.
+ * Sets this entry's name.
*
* @param name This entry's new name.
*/
@@ -651,7 +651,7 @@ public class SevenZArchiveEntry implements ArchiveEntry {
}
/**
- * Set this entry's file size.
+ * Sets this entry's file size.
*
* @param size This entry's new file size.
*/
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 8d79bbff..5f62ea37 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
@@ -1800,7 +1800,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's creation time.
+ * Sets this entry's creation time.
*
* @param time This entry's new creation time.
* @since 1.22
@@ -1810,7 +1810,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set the offset of the data for the tar entry.
+ * Sets the offset of the data for the tar entry.
* @param dataOffset the position of the data in the tar.
* @since 1.21
*/
@@ -1822,7 +1822,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's major device number.
+ * Sets this entry's major device number.
*
* @param devNo This entry's major device number.
* @throws IllegalArgumentException if the devNo is < 0.
@@ -1837,7 +1837,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's minor device number.
+ * Sets this entry's minor device number.
*
* @param devNo This entry's minor device number.
* @throws IllegalArgumentException if the devNo is < 0.
@@ -1852,7 +1852,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's group id.
+ * Sets this entry's group id.
*
* @param groupId This entry's new group id.
*/
@@ -1861,7 +1861,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's group id.
+ * Sets this entry's group id.
*
* @since 1.10
* @param groupId This entry's new group id.
@@ -1871,7 +1871,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's group name.
+ * Sets this entry's group name.
*
* @param groupName This entry's new group name.
*/
@@ -1891,7 +1891,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's last access time.
+ * Sets this entry's last access time.
*
* @param time This entry's new last access time.
* @since 1.22
@@ -1901,7 +1901,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's modification time.
+ * Sets this entry's modification time.
*
* @param time This entry's new modification time.
* @since 1.22
@@ -1911,7 +1911,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's link name.
+ * Sets this entry's link name.
*
* @param link the link name to use.
*
@@ -1922,7 +1922,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set the mode for this entry
+ * Sets the mode for this entry
*
* @param mode the mode for this entry
*/
@@ -1931,7 +1931,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's modification time.
+ * Sets this entry's modification time.
*
* @param time This entry's new modification time.
* @see TarArchiveEntry#setLastModifiedTime(FileTime)
@@ -1941,7 +1941,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's modification time.
+ * Sets this entry's modification time.
*
* @param time This entry's new modification time.
* @since 1.21
@@ -1952,7 +1952,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's modification time. The parameter passed
+ * Sets this entry's modification time. The parameter passed
* to this method is in "Java time".
*
* @param time This entry's new modification time.
@@ -1963,7 +1963,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's name.
+ * Sets this entry's name.
*
* @param name This entry's new name.
*/
@@ -1983,7 +1983,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's file size.
+ * Sets this entry's file size.
*
* @param size This entry's new file size.
* @throws IllegalArgumentException if the size is < 0.
@@ -1996,7 +1996,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's sparse headers
+ * Sets this entry's sparse headers
* @param sparseHeaders The new sparse headers
* @since 1.20
*/
@@ -2005,7 +2005,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's status change time.
+ * Sets this entry's status change time.
*
* @param time This entry's new status change time.
* @since 1.22
@@ -2015,7 +2015,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's user id.
+ * Sets this entry's user id.
*
* @param userId This entry's new user id.
*/
@@ -2024,7 +2024,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's user id.
+ * Sets this entry's user id.
*
* @param userId This entry's new user id.
* @since 1.10
@@ -2034,7 +2034,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Set this entry's user name.
+ * Sets this entry's user name.
*
* @param userName This entry's new user name.
*/
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 8d34e0fa..8f3a5374 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
@@ -313,7 +313,7 @@ public class AsiExtraField implements ZipExtraField,
UnixStat, Cloneable {
}
/**
- * Set the group id.
+ * Sets the group id.
* @param gid the group id
*/
public void setGroupId(final int gid) {
@@ -340,7 +340,7 @@ public class AsiExtraField implements ZipExtraField,
UnixStat, Cloneable {
}
/**
- * Set the user id.
+ * Sets the user id.
* @param uid the user id
*/
public void setUserId(final int uid) {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
index b4f58431..cc68c0a2 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/PKWareExtraHeader.java
@@ -296,7 +296,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Set the extra field data in central directory.
+ * Sets the extra field data in central directory.
*
* @param data
* the data to use
@@ -306,7 +306,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Set the extra field data in the local file data - without Header-ID or
+ * Sets the extra field data in the local file data - without Header-ID or
* length specifier.
*
* @param data
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
b/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
index ca35d79b..08b28820 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/UnrecognizedExtraField.java
@@ -127,7 +127,7 @@ public class UnrecognizedExtraField implements
ZipExtraField {
}
/**
- * Set the extra field data in central directory.
+ * Sets the extra field data in central directory.
* @param data the data to use
*/
public void setCentralDirectoryData(final byte[] data) {
@@ -135,7 +135,7 @@ public class UnrecognizedExtraField implements
ZipExtraField {
}
/**
- * Set the header id.
+ * Sets the header id.
* @param headerId the header id to use
*/
public void setHeaderId(final ZipShort headerId) {
@@ -143,7 +143,7 @@ public class UnrecognizedExtraField implements
ZipExtraField {
}
/**
- * Set the extra field data in the local file data -
+ * Sets the extra field data in the local file data -
* without Header-ID or length specifier.
* @param data the field data to use
*/
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 5c6886ce..f4527a4e 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
@@ -1289,7 +1289,7 @@ public class ZipArchiveEntry extends
java.util.zip.ZipEntry implements ArchiveEn
}
/**
- * Set the name of the entry.
+ * Sets the name of the entry.
* @param name the name to use
*/
protected void setName(String name) {
@@ -1324,7 +1324,7 @@ public class ZipArchiveEntry extends
java.util.zip.ZipEntry implements ArchiveEn
}
/**
- * Set the platform (UNIX or FAT).
+ * Sets the platform (UNIX or FAT).
* @param platform an {@code int} value - 0 is FAT, 3 is UNIX
*/
protected void setPlatform(final int platform) {
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 bbf4be71..9099d5fe 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
@@ -1412,7 +1412,7 @@ public class ZipArchiveOutputStream extends
ArchiveOutputStream<ZipArchiveEntry>
}
/**
- * Set the file comment.
+ * Sets the file comment.
* @param comment the comment
*/
public void setComment(final String comment) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
index 2c6da49a..16cd11eb 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
@@ -31,7 +31,7 @@ import
org.apache.commons.compress.harmony.pack200.AttributeDefinitionBands.Attr
import org.objectweb.asm.Label;
/**
- * Set of bands relating to a non-predefined attribute that has had a layout
definition given to pack200 (e.g. via one
+ * Sets of bands relating to a non-predefined attribute that has had a layout
definition given to pack200 (e.g. via one
* of the -C, -M, -F or -D command line options)
*/
public class NewAttributeBands extends BandSet {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
index 0202fad2..edcfac44 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
@@ -41,7 +41,7 @@ import
org.apache.commons.compress.harmony.unpack200.bytecode.CPUTF8;
import org.apache.commons.compress.harmony.unpack200.bytecode.NewAttribute;
/**
- * Set of bands relating to a non-predefined attribute
+ * Sets of bands relating to a non-predefined attribute
*/
public class NewAttributeBands extends BandSet {
