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 b3737bb3 Normalize getter Javadoc
b3737bb3 is described below
commit b3737bb36d29b6ace26d40eee73e4594c5afe661
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Oct 31 06:44:48 2023 -0400
Normalize getter Javadoc
---
.../archivers/ar/ArArchiveInputStream.java | 2 +-
.../compress/archivers/arj/ArjArchiveEntry.java | 4 +-
.../commons/compress/archivers/dump/Dirent.java | 8 ++--
.../compress/archivers/dump/DumpArchiveEntry.java | 4 +-
.../archivers/dump/DumpArchiveInputStream.java | 2 +-
.../archivers/dump/DumpArchiveSummary.java | 22 ++++-----
.../compress/archivers/tar/TarArchiveEntry.java | 52 +++++++++++-----------
.../archivers/tar/TarArchiveInputStream.java | 10 ++---
.../commons/compress/archivers/tar/TarFile.java | 8 ++--
.../compress/archivers/zip/AsiExtraField.java | 6 +--
.../compress/archivers/zip/PKWareExtraHeader.java | 10 ++---
.../archivers/zip/UnrecognizedExtraField.java | 10 ++---
.../archivers/zip/X0015_CertificateIdForFile.java | 4 +-
.../X0016_CertificateIdForCentralDirectory.java | 4 +-
.../zip/X0017_StrongEncryptionHeader.java | 6 +--
.../compress/archivers/zip/ZipArchiveEntry.java | 6 +--
.../archivers/zip/ZipArchiveInputStream.java | 2 +-
.../archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../archivers/zip/ZipEightByteInteger.java | 10 ++---
.../commons/compress/archivers/zip/ZipLong.java | 8 ++--
.../commons/compress/archivers/zip/ZipShort.java | 6 +--
.../AbstractLZ77CompressorInputStream.java | 2 +-
.../snappy/SnappyCompressorInputStream.java | 2 +-
.../harmony/unpack200/NewAttributeBands.java | 2 +-
24 files changed, 96 insertions(+), 96 deletions(-)
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 4a3f73a8..ddb9e6c6 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
@@ -217,7 +217,7 @@ public class ArArchiveInputStream extends
ArchiveInputStream<ArArchiveEntry> {
}
/**
- * Get an extended name from the GNU extended name buffer.
+ * Gets an extended name from the GNU extended name buffer.
*
* @param offset pointer to entry within the buffer
* @return the extended file name; without trailing "/" if present.
diff --git
a/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
index 5ab7c873..23b22702 100644
---
a/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
@@ -165,7 +165,7 @@ public class ArjArchiveEntry implements ArchiveEntry {
}
/**
- * Get this entry's name.
+ * Gets this entry's name.
*
* <p>This method returns the raw name as it is stored inside of the
archive.</p>
*
@@ -181,7 +181,7 @@ public class ArjArchiveEntry implements ArchiveEntry {
}
/**
- * Get this entry's file size.
+ * Gets this entry's file size.
*
* @return This entry's file size.
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
b/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
index 30a522e1..73b2a3d4 100644
--- a/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
+++ b/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
@@ -43,7 +43,7 @@ class Dirent {
}
/**
- * Get ino.
+ * Gets ino.
* @return the i-node
*/
int getIno() {
@@ -51,7 +51,7 @@ class Dirent {
}
/**
- * Get name of directory entry.
+ * Gets name of directory entry.
*
* <p>This method returns the raw name as it is stored inside of the
archive.</p>
*
@@ -62,7 +62,7 @@ class Dirent {
}
/**
- * Get ino of parent directory.
+ * Gets ino of parent directory.
* @return the parent i-node
*/
int getParentIno() {
@@ -70,7 +70,7 @@ class Dirent {
}
/**
- * Get entry type.
+ * Gets entry type.
* @return the entry type
*/
int getType() {
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 651c4f74..6d391bc5 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
@@ -453,7 +453,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Get file creation time.
+ * Gets file creation time.
* @return the creation time
*/
public Date getCreationTime() {
@@ -594,7 +594,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Get the type of the entry.
+ * Gets the type of the entry.
* @return the type
*/
public TYPE getType() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
index ab8c180a..07d24a41 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
@@ -297,7 +297,7 @@ public class DumpArchiveInputStream extends
ArchiveInputStream<DumpArchiveEntry>
}
/**
- * Get full path for specified archive entry, or null if there's a gap.
+ * Gets full path for specified archive entry, or null if there's a gap.
*
* @param entry
* @return full path for specified archive entry, or null if there's a
gap.
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 2053e7b2..16e63245 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
@@ -78,7 +78,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
+ * Gets the device name, e.g., /dev/sda3 or /dev/mapper/vg0-home.
* @return device name
*/
public String getDevname() {
@@ -86,7 +86,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the date of this dump.
+ * Gets the date of this dump.
* @return the date of this dump.
*/
public Date getDumpDate() {
@@ -94,7 +94,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the last mountpoint, e.g., /home.
+ * Gets the last mountpoint, e.g., /home.
* @return last mountpoint
*/
public String getFilesystem() {
@@ -102,7 +102,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the inode of the first record on this volume.
+ * Gets the inode of the first record on this volume.
* @return inode of the first record on this volume.
*/
public int getFirstRecord() {
@@ -110,7 +110,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the miscellaneous flags. See below.
+ * Gets the miscellaneous flags. See below.
* @return flags
*/
public int getFlags() {
@@ -118,7 +118,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the hostname of the system where the dump was performed.
+ * Gets the hostname of the system where the dump was performed.
* @return hostname the host name
*/
public String getHostname() {
@@ -126,7 +126,7 @@ public class DumpArchiveSummary {
}
/**
- * Get dump label. This may be autogenerated, or it may be specified
+ * Gets dump label. This may be autogenerated, or it may be specified
* by the user.
* @return dump label
*/
@@ -135,7 +135,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the level of this dump. This is a number between 0 and 9, inclusive,
+ * Gets the level of this dump. This is a number between 0 and 9,
inclusive,
* and a level 0 dump is a complete dump of the partition. For any other
dump
* 'n' this dump contains all files that have changed since the last dump
* at this level or lower. This is used to support different levels of
@@ -147,7 +147,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the number of records per tape block. This is typically
+ * Gets the number of records per tape block. This is typically
* between 10 and 32.
* @return the number of records per tape block
*/
@@ -156,7 +156,7 @@ public class DumpArchiveSummary {
}
/**
- * Get the date of the previous dump at this level higher.
+ * Gets the date of the previous dump at this level higher.
* @return dumpdate may be null
*/
public Date getPreviousDumpDate() {
@@ -164,7 +164,7 @@ public class DumpArchiveSummary {
}
/**
- * Get volume (tape) number.
+ * Gets volume (tape) number.
* @return volume (tape) number.
*/
public int getVolume() {
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 a0a80cf4..8d79bbff 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
@@ -817,7 +817,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's creation time.
+ * Gets this entry's creation time.
*
* @since 1.22
* @return This entry's computed creation time.
@@ -836,7 +836,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's major device number.
+ * Gets this entry's major device number.
*
* @return This entry's major device number.
* @since 1.4
@@ -846,7 +846,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's minor device number.
+ * Gets this entry's minor device number.
*
* @return This entry's minor device number.
* @since 1.4
@@ -900,7 +900,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's file.
+ * Gets this entry's file.
*
* <p>This method is only useful for entries created from a {@code
* File} or {@code Path} but not for entries read from an archive.</p>
@@ -915,7 +915,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's group id.
+ * Gets this entry's group id.
*
* @return This entry's group id.
* @deprecated use #getLongGroupId instead as group ids can be
@@ -927,7 +927,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's group name.
+ * Gets this entry's group name.
*
* @return This entry's group name.
*/
@@ -936,7 +936,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's last access time.
+ * Gets this entry's last access time.
*
* @since 1.22
* @return This entry's last access time.
@@ -946,7 +946,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's modification time.
+ * Gets this entry's modification time.
* This is equivalent to {@link TarArchiveEntry#getLastModifiedTime()},
but precision is truncated to milliseconds.
*
* @return This entry's modification time.
@@ -958,7 +958,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's modification time.
+ * Gets this entry's modification time.
*
* @since 1.22
* @return This entry's modification time.
@@ -968,7 +968,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's link flag.
+ * Gets this entry's link flag.
*
* @return this entry's link flag.
* @since 1.23
@@ -978,7 +978,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's link name.
+ * Gets this entry's link name.
*
* @return This entry's link name.
*/
@@ -987,7 +987,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's group id.
+ * Gets this entry's group id.
*
* @since 1.10
* @return This entry's group id.
@@ -997,7 +997,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's user id.
+ * Gets this entry's user id.
*
* @return This entry's user id.
* @since 1.10
@@ -1007,7 +1007,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's mode.
+ * Gets this entry's mode.
*
* @return This entry's mode.
*/
@@ -1016,7 +1016,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's modification time.
+ * Gets this entry's modification time.
* This is equivalent to {@link TarArchiveEntry#getLastModifiedTime()},
but precision is truncated to milliseconds.
*
* @return This entry's modification time.
@@ -1027,7 +1027,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's name.
+ * Gets this entry's name.
*
* <p>This method returns the raw name as it is stored inside of the
archive.</p>
*
@@ -1039,7 +1039,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's sparse headers ordered by offset with all empty sparse
sections at the start filtered out.
+ * Gets this entry's sparse headers ordered by offset with all empty
sparse sections at the start filtered out.
*
* @return immutable list of this entry's sparse headers, never null
* @since 1.21
@@ -1079,7 +1079,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's file.
+ * Gets this entry's file.
*
* <p>This method is only useful for entries created from a {@code
* File} or {@code Path} but not for entries read from an archive.</p>
@@ -1092,7 +1092,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's real file size in case of a sparse file.
+ * Gets this entry's real file size in case of a sparse file.
*
* <p>This is the size a file would take on disk if the entry was
expanded.</p>
*
@@ -1108,7 +1108,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's file size.
+ * Gets this entry's file size.
*
* <p>This is the size the entry's data uses inside the archive. Usually
this is the same as {@link
* #getRealSize}, but it doesn't take the "holes" into account when the
entry represents a sparse file.
@@ -1121,7 +1121,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's sparse headers
+ * Gets this entry's sparse headers
*
* @return This entry's sparse headers
* @since 1.20
@@ -1131,7 +1131,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's status change time.
+ * Gets this entry's status change time.
*
* @since 1.22
* @return This entry's status change time.
@@ -1141,7 +1141,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's user id.
+ * Gets this entry's user id.
*
* @return This entry's user id.
* @deprecated use #getLongUserId instead as user ids can be
@@ -1153,7 +1153,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's user name.
+ * Gets this entry's user name.
*
* @return This entry's user name.
*/
@@ -1192,7 +1192,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get this entry's checksum status.
+ * Gets this entry's checksum status.
*
* @return if the header checksum is reasonably correct
* @see TarUtils#verifyCheckSum(byte[])
@@ -1365,7 +1365,7 @@ public class TarArchiveEntry implements ArchiveEntry,
TarConstants, EntryStreamO
}
/**
- * Get if this entry is a sparse file with 1.X PAX Format or not
+ * Gets if this entry is a sparse file with 1.X PAX Format or not
*
* @return True if this entry is a sparse file with 1.X PAX Format
* @since 1.20
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 7141c6a6..1f81b260 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
@@ -245,7 +245,7 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
}
/**
- * Get the available data that can be read from the current
+ * Gets the available data that can be read from the current
* entry in the archive. This does not indicate how much data
* is left in the entire archive, only in the current entry.
* This value is determined from the entry's size header field
@@ -375,7 +375,7 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
}
/**
- * Get the current TAR Archive Entry that this input stream is processing
+ * Gets the current TAR Archive Entry that this input stream is processing
*
* @return The current Archive Entry
*/
@@ -384,7 +384,7 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
}
/**
- * Get the next entry in this tar archive as long name data.
+ * Gets the next entry in this tar archive as long name data.
*
* @return The next entry in the archive as long name data, or null.
* @throws IOException on error
@@ -527,7 +527,7 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
}
/**
- * Get the next record in this tar archive. This will skip
+ * Gets the next record in this tar archive. This will skip
* over any remaining data in the current entry, if there
* is one, and place the input stream at the header of the
* next entry.
@@ -552,7 +552,7 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
}
/**
- * Get the record size being used by this stream's buffer.
+ * Gets the record size being used by this stream's buffer.
*
* @return The TarBuffer record size.
*/
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 3c4107dd..064e5b2a 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
@@ -394,7 +394,7 @@ public class TarFile implements Closeable {
}
/**
- * Get all TAR Archive Entries from the TarFile
+ * Gets all TAR Archive Entries from the TarFile
*
* @return All entries from the tar file
*/
@@ -417,7 +417,7 @@ public class TarFile implements Closeable {
}
/**
- * Get the next entry in this tar archive as long name data.
+ * Gets the next entry in this tar archive as long name data.
*
* @return The next entry in the archive as long name data, or null.
* @throws IOException on error
@@ -449,7 +449,7 @@ public class TarFile implements Closeable {
}
/**
- * Get the next entry in this tar archive. This will skip
+ * Gets the next entry in this tar archive. This will skip
* to the end of the current entry, if there is one, and
* place the position of the channel at the header of the
* next entry, and read the header and instantiate a new
@@ -537,7 +537,7 @@ public class TarFile implements Closeable {
}
/**
- * Get the next record in this tar archive. This will skip
+ * Gets the next record in this tar archive. This will skip
* over any remaining data in the current entry, if there
* is one, and place the input stream at the header of the
* next entry.
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 89e202f2..8d34e0fa 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
@@ -121,7 +121,7 @@ public class AsiExtraField implements ZipExtraField,
UnixStat, Cloneable {
}
/**
- * Get the group id.
+ * Gets the group id.
* @return the group id
*/
public int getGroupId() {
@@ -205,7 +205,7 @@ public class AsiExtraField implements ZipExtraField,
UnixStat, Cloneable {
}
/**
- * Get the file mode for given permissions with the correct file type.
+ * Gets the file mode for given permissions with the correct file type.
* @param mode the mode
* @return the type with the mode
*/
@@ -220,7 +220,7 @@ public class AsiExtraField implements ZipExtraField,
UnixStat, Cloneable {
}
/**
- * Get the user id.
+ * Gets the user id.
* @return the user id
*/
public int getUserId() {
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 30810100..b4f58431 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
@@ -205,7 +205,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Get the central data.
+ * Gets the central data.
*
* @return the central data if present, else return the local file data
*/
@@ -218,7 +218,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Get the central data length. If there is no central data, get the local
+ * Gets the central data length. If there is no central data, get the local
* file data length.
*
* @return the central data length
@@ -232,7 +232,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Get the header id.
+ * Gets the header id.
*
* @return the header id
*/
@@ -242,7 +242,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Get the local data.
+ * Gets the local data.
*
* @return the local data
*/
@@ -252,7 +252,7 @@ public abstract class PKWareExtraHeader implements
ZipExtraField {
}
/**
- * Get the length of the local data.
+ * Gets the length of the local data.
*
* @return the length of the local 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 f7382925..ca35d79b 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
@@ -48,7 +48,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
private byte[] centralData;
/**
- * Get the central data.
+ * Gets the central data.
* @return the central data if present, else return the local file data
*/
@Override
@@ -60,7 +60,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
}
/**
- * Get the central data length.
+ * Gets the central data length.
* If there is no central data, get the local file data length.
* @return the central data length
*/
@@ -73,7 +73,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
}
/**
- * Get the header id.
+ * Gets the header id.
* @return the header id
*/
@Override
@@ -82,7 +82,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
}
/**
- * Get the local data.
+ * Gets the local data.
* @return the local data
*/
@Override
@@ -91,7 +91,7 @@ public class UnrecognizedExtraField implements ZipExtraField {
}
/**
- * Get the length of the local data.
+ * Gets the length of the local data.
* @return the length of the local data
*/
@Override
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java
index 912e21bf..0efaad42 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X0015_CertificateIdForFile.java
@@ -54,7 +54,7 @@ public class X0015_CertificateIdForFile extends
PKWareExtraHeader {
}
/**
- * Get hash algorithm.
+ * Gets hash algorithm.
* @return the hash algorithm
*/
public HashAlgorithm getHashAlgorithm() {
@@ -62,7 +62,7 @@ public class X0015_CertificateIdForFile extends
PKWareExtraHeader {
}
/**
- * Get record count.
+ * Gets record count.
* @return the record count
*/
public int getRecordCount() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java
index 3547f674..46191429 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X0016_CertificateIdForCentralDirectory.java
@@ -54,7 +54,7 @@ public class X0016_CertificateIdForCentralDirectory extends
PKWareExtraHeader {
}
/**
- * Get hash algorithm.
+ * Gets hash algorithm.
* @return the hash algorithm
*/
public HashAlgorithm getHashAlgorithm() {
@@ -62,7 +62,7 @@ public class X0016_CertificateIdForCentralDirectory extends
PKWareExtraHeader {
}
/**
- * Get record count.
+ * Gets record count.
* @return the record count
*/
public int getRecordCount() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
index 875ba9a7..2ec9c587 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X0017_StrongEncryptionHeader.java
@@ -282,7 +282,7 @@ public class X0017_StrongEncryptionHeader extends
PKWareExtraHeader {
}
/**
- * Get encryption algorithm.
+ * Gets encryption algorithm.
* @return the encryption algorithm
*/
public EncryptionAlgorithm getEncryptionAlgorithm() {
@@ -290,7 +290,7 @@ public class X0017_StrongEncryptionHeader extends
PKWareExtraHeader {
}
/**
- * Get hash algorithm.
+ * Gets hash algorithm.
* @return the hash algorithm
*/
public HashAlgorithm getHashAlgorithm() {
@@ -298,7 +298,7 @@ public class X0017_StrongEncryptionHeader extends
PKWareExtraHeader {
}
/**
- * Get record count.
+ * Gets record count.
* @return the record count
*/
public long getRecordCount() {
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 ab3e0e36..5c6886ce 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
@@ -558,7 +558,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
implements ArchiveEn
}
/**
- * Get all extra fields, including unparseable ones.
+ * Gets all extra fields, including unparseable ones.
* @return An array of all extra fields. Not necessarily a copy of
internal data structures, hence private method
*/
private ZipExtraField[] getAllExtraFieldsNoCopy() {
@@ -777,7 +777,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
implements ArchiveEn
}
/**
- * Get the name of the entry.
+ * Gets the name of the entry.
*
* <p>This method returns the raw name as it is stored inside of the
archive.</p>
*
@@ -923,7 +923,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
implements ArchiveEn
}
/**
- * Get the hash code of the entry.
+ * Gets the hash code of the entry.
* This uses the name as the hash code.
* @return a hash code.
*/
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 7e4294e6..b6797a0d 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
@@ -673,7 +673,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream<ZipArchiveEntry> i
}
/**
- * Get the number of bytes Inflater has actually processed.
+ * Gets the number of bytes Inflater has actually processed.
*
* <p>for Java < Java7 the getBytes* methods in
* Inflater/Deflater seem to return unsigned ints rather than
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 ab6d797e..bbf4be71 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
@@ -1134,7 +1134,7 @@ public class ZipArchiveOutputStream extends
ArchiveOutputStream<ZipArchiveEntry>
}
/**
- * Get the existing ZIP64 extended information extra field or
+ * Gets the existing ZIP64 extended information extra field or
* create a new one and add it to the entry.
*
* @since 1.3
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 da4e755c..69d815bd 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
@@ -65,7 +65,7 @@ public final class ZipEightByteInteger implements
Serializable {
public static final ZipEightByteInteger ZERO = new ZipEightByteInteger(0);
/**
- * Get value as eight bytes in big endian byte order.
+ * Gets value as eight bytes in big endian byte order.
* @param value the value to convert
* @return value as eight bytes in big endian byte order
*/
@@ -87,7 +87,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Get value as eight bytes in big endian byte order.
+ * Gets value as eight bytes in big endian byte order.
* @param value the value to convert
* @return value as eight bytes in big endian byte order
*/
@@ -194,7 +194,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Get value as eight bytes in big endian byte order.
+ * Gets value as eight bytes in big endian byte order.
* @return value as eight bytes in big endian order
*/
public byte[] getBytes() {
@@ -202,7 +202,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Get value as Java long.
+ * Gets value as Java long.
* @return value as a long
*/
public long getLongValue() {
@@ -210,7 +210,7 @@ public final class ZipEightByteInteger implements
Serializable {
}
/**
- * Get value as Java BigInteger.
+ * Gets value as Java BigInteger.
* @return value as a BigInteger
*/
public BigInteger getValue() {
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 7e74936b..b43a3e0f 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
@@ -71,7 +71,7 @@ public final class ZipLong implements Cloneable, Serializable
{
public static final ZipLong AED_SIG = new ZipLong(0X08064B50L);
/**
- * Get value as four bytes in big endian byte order.
+ * Gets value as four bytes in big endian byte order.
* @param value the value to convert
* @return value as four bytes in big endian byte order
*/
@@ -173,7 +173,7 @@ public final class ZipLong implements Cloneable,
Serializable {
}
/**
- * Get value as four bytes in big endian byte order.
+ * Gets value as four bytes in big endian byte order.
* @return value as four bytes in big endian order
*/
public byte[] getBytes() {
@@ -181,14 +181,14 @@ public final class ZipLong implements Cloneable,
Serializable {
}
/**
- * Get value as a (signed) java int
+ * Gets value as a (signed) java int
* @return value as int
* @since 1.15
*/
public int getIntValue() { return (int) value;}
/**
- * Get value as Java long.
+ * Gets value as Java long.
* @return value as a long
*/
public long getValue() {
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 f40a1a1f..deb76892 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
@@ -35,7 +35,7 @@ public final class ZipShort implements Cloneable,
Serializable {
private static final long serialVersionUID = 1L;
/**
- * Get value as two bytes in big endian byte order.
+ * Gets value as two bytes in big endian byte order.
* @param value the Java int to convert to bytes
* @return the converted int as a byte array in big endian byte order
*/
@@ -127,7 +127,7 @@ public final class ZipShort implements Cloneable,
Serializable {
}
/**
- * Get value as two bytes in big endian byte order.
+ * Gets value as two bytes in big endian byte order.
* @return the value as a two byte array in big endian byte order
*/
public byte[] getBytes() {
@@ -137,7 +137,7 @@ public final class ZipShort implements Cloneable,
Serializable {
}
/**
- * Get value as Java int.
+ * Gets value as Java int.
* @return value as a Java int
*/
public int getValue() {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
index 788e5f2d..b7e46213 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/AbstractLZ77CompressorInputStream.java
@@ -158,7 +158,7 @@ public abstract class AbstractLZ77CompressorInputStream
extends CompressorInputS
}
/**
- * Get the uncompressed size of the stream
+ * Gets the uncompressed size of the stream
*
* @return the uncompressed size
*/
diff --git
a/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.java
index 8a4dbcd3..2a305ca9 100644
---
a/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/snappy/SnappyCompressorInputStream.java
@@ -204,7 +204,7 @@ public class SnappyCompressorInputStream extends
AbstractLZ77CompressorInputStre
}
/**
- * Get the uncompressed size of the stream
+ * Gets the uncompressed size of the stream
*
* @return the uncompressed size
*/
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 8402b7cd..0202fad2 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
@@ -620,7 +620,7 @@ public class NewAttributeBands extends BandSet {
}
/**
- * Get one attribute at the given index from the various bands. The
correct bands must have already been read in.
+ * Gets one attribute at the given index from the various bands. The
correct bands must have already been read in.
*
* @param index TODO
* @param elements TODO