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 2f07dc553 Javadoc @since tag should be after @throws
2f07dc553 is described below
commit 2f07dc553ba7c931e9f7d9dcfadec430c9ced7d9
Author: Gary D. Gregory <[email protected]>
AuthorDate: Sat Mar 22 09:09:46 2025 -0400
Javadoc @since tag should be after @throws
---
.../compress/archivers/dump/DumpArchiveInputStream.java | 2 +-
.../commons/compress/archivers/tar/TarArchiveEntry.java | 16 ++++++++--------
.../apache/commons/compress/archivers/zip/ZipFile.java | 2 +-
.../compressors/gzip/GzipCompressorOutputStream.java | 2 +-
4 files changed, 11 insertions(+), 11 deletions(-)
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 7b5d884bf..71dfd87ff 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
@@ -116,8 +116,8 @@ public DumpArchiveInputStream(final InputStream is) throws
ArchiveException {
*
* @param is stream to read from
* @param encoding the encoding to use for file names, use null for the
platform's default encoding
- * @since 1.6
* @throws ArchiveException on error
+ * @since 1.6
*/
public DumpArchiveInputStream(final InputStream is, final String encoding)
throws ArchiveException {
super(is, encoding);
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 38669a65c..b9f3c70bc 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
@@ -415,9 +415,9 @@ public TarArchiveEntry(final byte[] headerBuf) {
*
* @param headerBuf The header bytes from a tar archive entry.
* @param encoding encoding to use for file names
- * @since 1.4
* @throws IllegalArgumentException if any of the numeric fields have an
invalid format
* @throws IOException on error
+ * @since 1.4
*/
public TarArchiveEntry(final byte[] headerBuf, final ZipEncoding encoding)
throws IOException {
this(headerBuf, encoding, false);
@@ -430,9 +430,9 @@ public TarArchiveEntry(final byte[] headerBuf, final
ZipEncoding encoding) throw
* @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 ignored and the fields set to
* {@link #UNKNOWN}. When set to false such illegal
fields cause an exception instead.
- * @since 1.19
* @throws IllegalArgumentException if any of the numeric fields have an
invalid format
* @throws IOException on error
+ * @since 1.19
*/
public TarArchiveEntry(final byte[] headerBuf, final ZipEncoding encoding,
final boolean lenient) throws IOException {
this(Collections.emptyMap(), headerBuf, encoding, lenient);
@@ -446,9 +446,9 @@ public TarArchiveEntry(final byte[] headerBuf, final
ZipEncoding encoding, final
* @param lenient when set to true illegal values for group/userid,
mode, device numbers and timestamp will be ignored and the fields set to
* {@link #UNKNOWN}. When set to false such illegal
fields cause an exception instead.
* @param dataOffset position of the entry data in the random access file.
- * @since 1.21
* @throws IllegalArgumentException if any of the numeric fields have an
invalid format.
* @throws IOException on error.
+ * @since 1.21
*/
public TarArchiveEntry(final byte[] headerBuf, final ZipEncoding encoding,
final boolean lenient, final long dataOffset) throws IOException {
this(headerBuf, encoding, lenient);
@@ -519,9 +519,9 @@ public TarArchiveEntry(final File file, final String
fileName) {
* @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 ignored and the fields
set to
* {@link #UNKNOWN}. When set to false such
illegal fields cause an exception instead.
- * @since 1.22
* @throws IllegalArgumentException if any of the numeric fields have an
invalid format
* @throws IOException on error
+ * @since 1.22
*/
public TarArchiveEntry(final Map<String, String> globalPaxHeaders, final
byte[] headerBuf, final ZipEncoding encoding, final boolean lenient)
throws IOException {
@@ -538,9 +538,9 @@ public TarArchiveEntry(final Map<String, String>
globalPaxHeaders, final byte[]
* @param lenient when set to true illegal values for
group/userid, mode, device numbers and timestamp will be ignored and the fields
set to
* {@link #UNKNOWN}. When set to false such
illegal fields cause an exception instead.
* @param dataOffset position of the entry data in the random access
file.
- * @since 1.22
* @throws IllegalArgumentException if any of the numeric fields have an
invalid format.
* @throws IOException on error.
+ * @since 1.22
*/
public TarArchiveEntry(final Map<String, String> globalPaxHeaders, final
byte[] headerBuf, final ZipEncoding encoding, final boolean lenient,
final long dataOffset) throws IOException {
@@ -991,8 +991,8 @@ public String getName() {
* 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
* @throws IOException if the list of sparse headers contains blocks that
overlap
+ * @since 1.21
*/
public List<TarArchiveStructSparse> getOrderedSparseHeaders() throws
IOException {
if (sparseHeaders == null || sparseHeaders.isEmpty()) {
@@ -1434,9 +1434,9 @@ public void parseTarHeader(final byte[] header) {
*
* @param header The tar entry header buffer to get information from.
* @param encoding encoding to use for file names
- * @since 1.4
* @throws IllegalArgumentException if any of the numeric fields have an
invalid format
* @throws IOException on error
+ * @since 1.4
*/
public void parseTarHeader(final byte[] header, final ZipEncoding
encoding) throws IOException {
parseTarHeader(header, encoding, false, false);
@@ -1974,8 +1974,8 @@ public void writeEntryHeader(final byte[] outbuf) {
* @param encoding encoding to use when writing the file name.
* @param starMode whether to use the star/GNU tar/BSD tar extension for
numeric fields if their value doesn't fit in the maximum size of standard tar
* archives
- * @since 1.4
* @throws IOException on error
+ * @since 1.4
*/
public void writeEntryHeader(final byte[] outbuf, final ZipEncoding
encoding, final boolean starMode) throws IOException {
int offset = 0;
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 197e632ee..6dbc46ea8 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
@@ -1266,8 +1266,8 @@ public void close() throws IOException {
*
* @param entry The entry to get the stream for
* @return The raw input stream containing (possibly) compressed data.
- * @since 1.11
* @throws IOException if there is a problem reading data offset (added in
version 1.22).
+ * @since 1.11
*/
public InputStream getRawInputStream(final ZipArchiveEntry entry) throws
IOException {
if (!(entry instanceof Entry)) {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
index 05d823745..bff7e9ea6 100644
---
a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
@@ -94,8 +94,8 @@ private void deflate() throws IOException {
/**
* Finishes writing compressed data to the underlying stream without
closing it.
*
- * @since 1.7
* @throws IOException on error
+ * @since 1.7
*/
@Override
public void finish() throws IOException {
