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 0629aa85c Javadoc @since tag should be after @return and @throws
0629aa85c is described below
commit 0629aa85c641806eb97095861788e71dc352b6e2
Author: Gary D. Gregory <[email protected]>
AuthorDate: Sat Mar 22 09:29:05 2025 -0400
Javadoc @since tag should be after @return and @throws
---
.../archivers/sevenz/SevenZArchiveEntry.java | 10 ++++-----
.../archivers/sevenz/SevenZOutputFile.java | 2 +-
.../compress/archivers/tar/TarArchiveEntry.java | 24 +++++++++++-----------
.../archivers/tar/TarArchiveSparseEntry.java | 2 +-
.../commons/compress/archivers/tar/TarUtils.java | 6 +++---
.../compress/archivers/zip/ZipArchiveEntry.java | 2 +-
.../archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../commons/compress/archivers/zip/ZipFile.java | 2 +-
.../compressors/CompressorStreamFactory.java | 2 +-
.../commons/compress/compressors/xz/XZUtils.java | 2 +-
10 files changed, 27 insertions(+), 27 deletions(-)
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 5686ebc79..441e3a232 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
@@ -162,8 +162,8 @@ int getCompressedCrc() {
/**
* Gets the compressed CRC.
*
- * @since 1.7
* @return the CRC
+ * @since 1.7
*/
long getCompressedCrcValue() {
return compressedCrc;
@@ -190,8 +190,8 @@ long getCompressedSize() {
* The methods will be consulted in iteration order to create the final
output.
* </p>
*
- * @since 1.8
* @return the methods to use for the content
+ * @since 1.8
*/
public Iterable<? extends SevenZMethodConfiguration> getContentMethods() {
return contentMethods;
@@ -211,8 +211,8 @@ public int getCrc() {
/**
* Gets the CRC.
*
- * @since 1.7
* @return the CRC
+ * @since 1.7
*/
public long getCrcValue() {
return crc;
@@ -440,8 +440,8 @@ void setCompressedCrc(final int crc) {
/**
* Sets the compressed CRC.
*
- * @since 1.7
* @param crc the CRC
+ * @since 1.7
*/
void setCompressedCrcValue(final long crc) {
this.compressedCrc = crc;
@@ -514,8 +514,8 @@ public void setCrc(final int crc) {
/**
* Sets the CRC.
*
- * @since 1.7
* @param crc the CRC
+ * @since 1.7
*/
public void setCrcValue(final long crc) {
this.crc = crc;
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 9df0e7b3a..5ee042ef7 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
@@ -408,8 +408,8 @@ public void setContentCompression(final SevenZMethod
method) {
* The methods will be consulted in iteration order to create the final
output.
* </p>
*
- * @since 1.8
* @param methods the default (compression) methods
+ * @since 1.8
*/
public void setContentMethods(final Iterable<? extends
SevenZMethodConfiguration> methods) {
this.contentMethods = reverse(methods);
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 b9f3c70bc..4a61d615b 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
@@ -766,8 +766,8 @@ void fillStarSparseData(final Map<String, String> headers)
throws IOException {
/**
* Gets this entry's creation time.
*
- * @since 1.22
* @return This entry's computed creation time.
+ * @since 1.22
*/
public FileTime getCreationTime() {
return birthTime;
@@ -887,8 +887,8 @@ public String getGroupName() {
/**
* Gets this entry's last access time.
*
- * @since 1.22
* @return This entry's last access time.
+ * @since 1.22
*/
public FileTime getLastAccessTime() {
return aTime;
@@ -908,8 +908,8 @@ public Date getLastModifiedDate() {
/**
* Gets this entry's modification time.
*
- * @since 1.22
* @return This entry's modification time.
+ * @since 1.22
*/
public FileTime getLastModifiedTime() {
return mTime;
@@ -937,8 +937,8 @@ public String getLinkName() {
/**
* Gets this entry's group id.
*
- * @since 1.10
* @return This entry's group id.
+ * @since 1.10
*/
public long getLongGroupId() {
return groupId;
@@ -1079,8 +1079,8 @@ public List<TarArchiveStructSparse> getSparseHeaders() {
/**
* Gets this entry's status change time.
*
- * @since 1.22
* @return This entry's status change time.
+ * @since 1.22
*/
public FileTime getStatusChangeTime() {
return cTime;
@@ -1119,8 +1119,8 @@ public int hashCode() {
/**
* Tests whether this is a block device entry.
*
- * @since 1.2
* @return whether this is a block device
+ * @since 1.2
*/
public boolean isBlockDevice() {
return linkFlag == LF_BLK;
@@ -1129,8 +1129,8 @@ public boolean isBlockDevice() {
/**
* Tests whether this is a character device entry.
*
- * @since 1.2
* @return whether this is a character device
+ * @since 1.2
*/
public boolean isCharacterDevice() {
return linkFlag == LF_CHR;
@@ -1185,8 +1185,8 @@ public boolean isExtended() {
/**
* Tests whether this is a FIFO (pipe) entry.
*
- * @since 1.2
* @return whether this is a FIFO entry
+ * @since 1.2
*/
public boolean isFIFO() {
return linkFlag == LF_FIFO;
@@ -1195,8 +1195,8 @@ public boolean isFIFO() {
/**
* Tests whether this is a "normal file"
*
- * @since 1.2
* @return whether this is a "normal file"
+ * @since 1.2
*/
public boolean isFile() {
if (file != null) {
@@ -1284,8 +1284,8 @@ private boolean isInvalidXtarTime(final byte[] buffer,
final int offset, final i
/**
* Tests whether this is a link entry.
*
- * @since 1.2
* @return whether this is a link entry
+ * @since 1.2
*/
public boolean isLink() {
return linkFlag == LF_LINK;
@@ -1364,8 +1364,8 @@ public boolean isStreamContiguous() {
/**
* Tests whether this is a symbolic link entry.
*
- * @since 1.2
* @return whether this is a symbolic link
+ * @since 1.2
*/
public boolean isSymbolicLink() {
return linkFlag == LF_SYMLINK;
@@ -1756,8 +1756,8 @@ public void setGroupId(final int groupId) {
/**
* Sets this entry's group id.
*
- * @since 1.10
* @param groupId This entry's new group id.
+ * @since 1.10
*/
public void setGroupId(final long groupId) {
this.groupId = groupId;
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 1bcb1b1a9..05ae43d12 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
@@ -73,8 +73,8 @@ public TarArchiveSparseEntry(final byte[] headerBuf) throws
IOException {
/**
* Gets information about the configuration for the sparse entry.
*
- * @since 1.20
* @return information about the configuration for the sparse entry.
+ * @since 1.20
*/
public List<TarArchiveStructSparse> getSparseHeaders() {
return sparseHeaders;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
index 3b2b5be88..82c0fe979 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
@@ -247,9 +247,9 @@ public static int formatNameBytes(final String name, final
byte[] buf, final int
* @param offset The starting offset into the buffer
* @param length The maximum number of header bytes to copy.
* @param encoding name of the encoding to use for file names
- * @since 1.4
* @return The updated offset, i.e. offset + length
* @throws IOException on error
+ * @since 1.4
*/
public static int formatNameBytes(final String name, final byte[] buf,
final int offset, final int length, final ZipEncoding encoding) throws
IOException {
int len = name.length();
@@ -417,9 +417,9 @@ public static String parseName(final byte[] buffer, final
int offset, final int
* @param offset The offset into the buffer from which to parse.
* @param length The maximum number of bytes to parse.
* @param encoding name of the encoding to use for file names
- * @since 1.4
* @return The entry name.
* @throws IOException on error
+ * @since 1.4
*/
public static String parseName(final byte[] buffer, final int offset,
final int length, final ZipEncoding encoding) throws IOException {
int len = 0;
@@ -744,10 +744,10 @@ protected static Map<String, String>
parsePaxHeaders(final InputStream inputStre
/**
* Parses the content of a PAX 1.0 sparse block.
*
- * @since 1.20
* @param buffer The buffer from which to parse.
* @param offset The offset into the buffer from which to parse.
* @return a parsed sparse struct
+ * @since 1.20
*/
public static TarArchiveStructSparse parseSparse(final byte[] buffer,
final int offset) {
final long sparseOffset = parseOctalOrBinary(buffer, offset,
TarConstants.SPARSE_OFFSET_LEN);
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 8bcc3d64e..2468dcb3b 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
@@ -1059,8 +1059,8 @@ public boolean isStreamContiguous() {
/**
* Tests whether this entry represents a Unix symlink, in which case the
entry's content contains the target path for the symlink.
*
- * @since 1.5
* @return true if the entry represents a Unix symlink, false otherwise.
+ * @since 1.5
*/
public boolean isUnixSymlink() {
return (getUnixMode() & UnixStat.FILE_TYPE_FLAG) == UnixStat.LINK_FLAG;
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 7f9759350..7e9f62efb 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
@@ -1430,8 +1430,8 @@ public void setUseLanguageEncodingFlag(final boolean b) {
* non-seekable stream - in this case the default is {@link
Zip64Mode#Never Never}.
* </p>
*
- * @since 1.3
* @param mode Whether Zip64 extensions will be used.
+ * @since 1.3
*/
public void setUseZip64(final Zip64Mode mode) {
zip64Mode = mode;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
index 6dbc46ea8..cb5e482ab 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
@@ -1000,9 +1000,9 @@ public ZipFile(final String name, final String encoding)
throws IOException {
* May return false if it is set up to use encryption or a compression
method that hasn't been implemented yet.
* </p>
*
- * @since 1.1
* @param entry the entry
* @return whether this class is able to read the given entry.
+ * @since 1.1
*/
public boolean canReadEntryData(final ZipArchiveEntry entry) {
return ZipUtil.canHandleEntryData(entry);
diff --git
a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
index d6b0096e5..ffc5f88de 100644
---
a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
+++
b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
@@ -345,8 +345,8 @@ public static String getDeflate() {
}
/**
- * @since 1.16
* @return the constant {@link #DEFLATE64}
+ * @since 1.16
*/
public static String getDeflate64() {
return DEFLATE64;
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
index 9f8cc1623..975223d54 100644
--- a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
+++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
@@ -155,8 +155,8 @@ public static boolean isCompressedFileName(final String
fileName) {
/**
* Are the classes required to support XZ compression available?
*
- * @since 1.5
* @return true if the classes required to support XZ compression are
available
+ * @since 1.5
*/
public static boolean isXZCompressionAvailable() {
final CachedAvailability cachedResult = cachedXZAvailability;
