From b2825183ed13b224bcf79720254ff90060ee6dfa Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Thu, 28 Nov 2024 12:25:35 -0500 Subject: [PATCH] No need for blank Javadoc lines between Javadoc @ tags --- .../commons/compress/archivers/ArchiveOutputStream.java | 2 -- .../commons/compress/archivers/ArchiveStreamFactory.java | 1 - .../commons/compress/archivers/ar/ArArchiveInputStream.java | 1 - .../commons/compress/archivers/cpio/CpioArchiveEntry.java | 2 -- .../compress/archivers/cpio/CpioArchiveOutputStream.java | 2 -- .../org/apache/commons/compress/archivers/cpio/CpioUtil.java | 1 - .../compress/archivers/examples/CloseableConsumer.java | 1 - .../commons/compress/archivers/sevenz/SevenZOutputFile.java | 1 - .../commons/compress/archivers/tar/TarArchiveEntry.java | 5 ----- .../commons/compress/archivers/zip/ExplodingInputStream.java | 1 - .../commons/compress/archivers/zip/ExtraFieldUtils.java | 4 ---- .../org/apache/commons/compress/archivers/zip/JarMarker.java | 1 - .../compress/archivers/zip/ParallelScatterZipCreator.java | 3 --- .../compress/archivers/zip/UnicodeCommentExtraField.java | 1 - .../compress/archivers/zip/UnicodePathExtraField.java | 1 - .../archivers/zip/UnparseableExtraFieldBehavior.java | 1 - .../archivers/zip/Zip64ExtendedInformationExtraField.java | 3 --- .../org/apache/commons/compress/archivers/zip/Zip64Mode.java | 1 - .../commons/compress/archivers/zip/ZipArchiveEntry.java | 5 ----- .../compress/archivers/zip/ZipArchiveOutputStream.java | 1 - .../commons/compress/archivers/zip/ZipEightByteInteger.java | 1 - .../org/apache/commons/compress/archivers/zip/ZipFile.java | 4 ---- .../org/apache/commons/compress/archivers/zip/ZipMethod.java | 1 - .../org/apache/commons/compress/archivers/zip/ZipUtil.java | 1 - .../commons/compress/compressors/CompressorInputStream.java | 2 -- .../compress/compressors/CompressorStreamFactory.java | 1 - .../compressors/bzip2/BZip2CompressorInputStream.java | 1 - .../compressors/bzip2/BZip2CompressorOutputStream.java | 3 --- .../compressors/deflate/DeflateCompressorInputStream.java | 1 - .../compress/compressors/gzip/GzipCompressorInputStream.java | 3 --- .../compressors/gzip/GzipCompressorOutputStream.java | 1 - .../lz77support/AbstractLZ77CompressorInputStream.java | 1 - .../compress/compressors/lzma/LZMACompressorInputStream.java | 4 ---- .../compressors/snappy/SnappyCompressorInputStream.java | 3 --- .../compress/compressors/xz/XZCompressorInputStream.java | 1 - .../compress/compressors/z/ZCompressorInputStream.java | 1 - .../commons/compress/harmony/pack200/CodecEncoding.java | 1 - .../apache/commons/compress/harmony/unpack200/BandSet.java | 2 -- 38 files changed, 70 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java b/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java index eac387132dc..5720c5e34ba 100644 --- a/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java +++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java @@ -169,7 +169,6 @@ protected void count(final long written) { * @param inputFile the file to create the entry from * @param entryName name to use for the entry * @return the ArchiveEntry set up with details from the file - * * @throws IOException if an I/O error occurs */ public abstract E createArchiveEntry(File inputFile, String entryName) throws IOException; @@ -191,7 +190,6 @@ protected void count(final long written) { * @param entryName name to use for the entry * @param options options indicating how symbolic links are handled. * @return the ArchiveEntry set up with details from the file - * * @throws IOException if an I/O error occurs * @since 1.21 */ diff --git a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java index 6794acbdc3b..3fb8106ee19 100644 --- a/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java +++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java @@ -381,7 +381,6 @@ public ArchiveStreamFactory() { * Constructs an instance using the specified encoding. * * @param entryEncoding the encoding to be used. - * * @since 1.10 */ public ArchiveStreamFactory(final String entryEncoding) { 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 d2e277dce85..dbfb486eddb 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 @@ -197,7 +197,6 @@ public void close() throws IOException { * Reads the real name from the current stream assuming the very first bytes to be read are the real file name. * * @see #isBSDLongName - * * @since 1.3 */ private String getBSDLongName(final String bsdLongName) throws IOException { diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java index 7a91d531c72..6723190adb1 100644 --- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java +++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java @@ -314,7 +314,6 @@ public CpioArchiveEntry(final short format, final File inputFile, final String e * * * @param options options indicating how symbolic links are handled. - * * @throws IOException if an I/O error occurs * @since 1.21 */ @@ -553,7 +552,6 @@ public int getHeaderPadCount(final Charset charset) { * * @param nameSize The length of the name in bytes, as read in the stream. Without the trailing zero byte. * @return the number of bytes needed to pad the header (0,1,2,3) - * * @since 1.18 */ public int getHeaderPadCount(final long nameSize) { 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 b554cbcf709..71503e9f55d 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 @@ -120,7 +120,6 @@ public CpioArchiveOutputStream(final OutputStream out, final short format) { * @param out The cpio stream * @param format The format of the stream * @param blockSize The block size of the archive. - * * @since 1.1 */ public CpioArchiveOutputStream(final OutputStream out, final short format, final int blockSize) { @@ -134,7 +133,6 @@ public CpioArchiveOutputStream(final OutputStream out, final short format, final * @param format The format of the stream * @param blockSize The block size of the archive. * @param encoding The encoding of file names to write - use null for the platform's default. - * * @since 1.6 */ public CpioArchiveOutputStream(final OutputStream out, final short format, final int blockSize, final String encoding) { diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java index febad773a99..760a4b161ca 100644 --- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java +++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java @@ -75,7 +75,6 @@ static long fileType(final long mode) { * Converts a long number to a byte array Halfwords can be swapped by setting swapHalfWord=true. * * @param number the input long number to be converted - * * @param length The length of the returned array * @param swapHalfWord Swap halfwords ([0][1][2][3]->[1][0][3][2]) * @return The long value diff --git a/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java b/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java index 9cb6bf176a1..1d9c9055946 100644 --- a/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java +++ b/src/main/java/org/apache/commons/compress/archivers/examples/CloseableConsumer.java @@ -49,7 +49,6 @@ public interface CloseableConsumer { * Archiver no longer need them. * * @param c Closeable created by Expander or Archiver that is now no longer used - * * @throws IOException on error */ void accept(Closeable c) throws IOException; 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 0ce3cf585a5..15b46e7c525 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 @@ -264,7 +264,6 @@ public SevenZArchiveEntry createArchiveEntry(final File inputFile, final String * @param entryName the name to use * @param options options indicating how symbolic links are handled. * @return the ArchiveEntry set up with details from the file - * * @throws IOException on error * @since 1.21 */ 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 a06bc26cec5..65a8c4520c2 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 @@ -609,7 +609,6 @@ public TarArchiveEntry(final String name) { * * @param name the entry name * @param preserveAbsolutePath whether to allow leading slashes or drive letters in the name. - * * @since 1.1 */ public TarArchiveEntry(String name, final boolean preserveAbsolutePath) { @@ -647,7 +646,6 @@ public TarArchiveEntry(final String name, final byte linkFlag) { * @param name the entry name * @param linkFlag the entry link flag. * @param preserveAbsolutePath whether to allow leading slashes or drive letters in the name. - * * @since 1.5 */ public TarArchiveEntry(final String name, final byte linkFlag, final boolean preserveAbsolutePath) { @@ -1214,7 +1212,6 @@ public boolean isFile() { * Tests whether this is a Pax header. * * @return {@code true} if this is a Pax header. - * * @since 1.1 */ public boolean isGlobalPaxHeader() { @@ -1328,7 +1325,6 @@ public boolean isPaxGNUSparse() { * Tests whether this is a Pax header. * * @return {@code true} if this is a Pax header. - * * @since 1.1 */ public boolean isPaxHeader() { @@ -1816,7 +1812,6 @@ public void setLastModifiedTime(final FileTime time) { * Sets this entry's link name. * * @param link the link name to use. - * * @since 1.1 */ public void setLinkName(final String link) { diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java index 4eb124f48f4..3a4b290ec48 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ExplodingInputStream.java @@ -33,7 +33,6 @@ * The algorithm is described in the ZIP File Format Specification. * * @see ZIP File Format Specification - * * @since 1.7 */ final class ExplodingInputStream extends InputStream implements InputStreamStatistics { diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java index a5123743924..7f20b05add9 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java @@ -179,7 +179,6 @@ public static ZipExtraField createExtraFieldNoDefault(final ZipShort headerId) { * data. * @return the filled field, will never be {@code null} * @throws ZipException if an error occurs - * * @since 1.19 */ public static ZipExtraField fillExtraField(final ZipExtraField ze, final byte[] data, final int off, final int len, final boolean local) @@ -301,7 +300,6 @@ public static ZipExtraField[] parse(final byte[] data, final boolean local) thro * @param local whether data originates from the local file data or the central directory * @return an array of ExtraFields * @throws ZipException on error - * * @since 1.19 */ public static ZipExtraField[] parse(final byte[] data, final boolean local, final ExtraFieldParsingBehavior parsingBehavior) throws ZipException { @@ -341,7 +339,6 @@ public static ZipExtraField[] parse(final byte[] data, final boolean local, fina * @param onUnparseableData what to do if the extra field data cannot be parsed. * @return an array of ExtraFields * @throws ZipException on error - * * @since 1.1 */ public static ZipExtraField[] parse(final byte[] data, final boolean local, final UnparseableExtraField onUnparseableData) throws ZipException { @@ -372,7 +369,6 @@ public ZipExtraField onUnparseableExtraField(final byte[] data, final int off, f *

* * @param clazz the class to register. - * * @deprecated Use {@link ZipArchiveInputStream#setExtraFieldSupport} instead * to not leak instances between archives and applications. */ diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java b/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java index 093a940e961..538db9d098d 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java @@ -109,7 +109,6 @@ public void parseFromCentralDirectoryData(final byte[] buffer, final int offset, * @param data an array of bytes * @param offset the start offset * @param length the number of bytes in the array from offset - * * @throws ZipException on error */ @Override diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.java b/src/main/java/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.java index b327a008a10..8ded131b50d 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ParallelScatterZipCreator.java @@ -200,7 +200,6 @@ public final Callable createCallable(final ZipArchiveEnt * {@link ZipArchiveEntryRequestSupplier}. * * @see #createCallable(ZipArchiveEntry, InputStreamSupplier) - * * @param zipArchiveEntryRequestSupplier Should supply the entry to be added. * @return A callable that should subsequently be passed to #submitStreamAwareCallable, possibly in a wrapped/adapted from. The value of this callable is * not used, but any exceptions happening inside the compression will be propagated through the callable. @@ -235,7 +234,6 @@ public ScatterStatistics getStatisticsMessage() { * Submits a callable for compression. * * @see ParallelScatterZipCreator#createCallable for details of if/when to use this. - * * @param callable The callable to run, created by {@link #createCallable createCallable}, possibly wrapped by caller. */ public final void submit(final Callable callable) { @@ -249,7 +247,6 @@ public final void submit(final Callable callable) { * Submits a callable for compression. * * @see ParallelScatterZipCreator#createCallable for details of if/when to use this. - * * @param callable The callable to run, created by {@link #createCallable createCallable}, possibly wrapped by caller. * @since 1.19 */ diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java index 4a217d98064..0c7f79be03f 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java @@ -25,7 +25,6 @@ *

* * @see PKWARE APPNOTE.TXT, section 4.6.8 - * * @NotThreadSafe super-class is not thread-safe */ public class UnicodeCommentExtraField extends AbstractUnicodeExtraField { diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java index 2d30661d1ba..627d804f6df 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java @@ -25,7 +25,6 @@ *

* * @see PKWARE APPNOTE.TXT, section 4.6.9 - * * @NotThreadSafe super-class is not thread-safe */ public class UnicodePathExtraField extends AbstractUnicodeExtraField { diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java index f4a91deb3cf..a9a0ce1edf9 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldBehavior.java @@ -35,7 +35,6 @@ public interface UnparseableExtraFieldBehavior { * @param local whether the extra field data stems from the local file header. If this is false then the data is part if the central directory * header extra data. * @param claimedLength length of the extra field claimed by the third and forth byte if it did follow the recommended pattern - * * @return null if the data should be ignored or an extra field implementation that represents the data * @throws ZipException if an error occurs or unparseable extra fields must not be accepted */ diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java index 1fe1f6f8750..c75222b96a9 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java @@ -37,7 +37,6 @@ *

* * @see PKWARE APPNOTE.TXT, section 4.5.3 - * * @since 1.2 * @NotThreadSafe */ @@ -72,7 +71,6 @@ public Zip64ExtendedInformationExtraField() { * * @param size the entry's original size * @param compressedSize the entry's compressed size - * * @throws IllegalArgumentException if size or compressedSize is null */ public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final ZipEightByteInteger compressedSize) { @@ -86,7 +84,6 @@ public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final * @param compressedSize the entry's compressed size * @param relativeHeaderOffset the entry's offset * @param diskStart the disk start - * * @throws IllegalArgumentException if size or compressedSize is null */ public Zip64ExtendedInformationExtraField(final ZipEightByteInteger size, final ZipEightByteInteger compressedSize, diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64Mode.java b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64Mode.java index 21dfe992c83..18c36723b18 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64Mode.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64Mode.java @@ -21,7 +21,6 @@ * The different modes {@link ZipArchiveOutputStream} can operate in. * * @see ZipArchiveOutputStream#setUseZip64 - * * @since 1.3 */ public enum Zip64Mode { 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 fcd21e9092a..227e91d45a0 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 @@ -708,7 +708,6 @@ public ZipExtraField[] getExtraFields() { * * @param includeUnparseable whether to also return unparseable extra fields as {@link UnparseableExtraFieldData} if such data exists. * @return an array of the extra fields - * * @since 1.1 */ public ZipExtraField[] getExtraFields(final boolean includeUnparseable) { @@ -823,7 +822,6 @@ private ZipExtraField[] getMergedFields() { * Gets the compression method of this entry, or -1 if the compression method has not been specified. * * @return compression method - * * @since 1.1 */ @Override @@ -926,7 +924,6 @@ public long getSize() { *

* * @return The last modification time of the entry in milliseconds since the epoch, or -1 if not specified - * * @see #setTime(long) * @see #setLastModifiedTime(FileTime) */ @@ -951,7 +948,6 @@ public int getUnixMode() { * Gets up extra field data that couldn't be parsed correctly. * * @return null if no such field exists. - * * @since 1.1 */ public UnparseableExtraFieldData getUnparseableExtraFieldData() { @@ -1361,7 +1357,6 @@ protected void setLocalHeaderOffset(final long localHeaderOffset) { * Sets the compression method of this entry. * * @param method compression method - * * @since 1.1 */ @Override 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 3c59986238b..ab004d9db37 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 @@ -403,7 +403,6 @@ public ZipArchiveOutputStream(final File file) throws IOException { * * @param file the file that will become the last part of the split archive * @param zipSplitSize maximum size of a single part of the split archive created by this stream. Must be between 64kB and about 4GB. - * * @throws IOException on error * @throws IllegalArgumentException if zipSplitSize is not in the required range * @since 1.20 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 61446772983..1d74c435025 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 @@ -25,7 +25,6 @@ * Utility class that represents an eight byte integer with conversion rules for the little-endian byte order of ZIP files. * * @Immutable - * * @since 1.2 */ public final class ZipEightByteInteger implements Serializable { 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 d167e2f4b8c..cb8e6daf2f7 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 @@ -177,7 +177,6 @@ public Builder setIgnoreLocalFileHeader(final boolean ignoreLocalFileHeader) { * Sets max number of multi archive disks, default is 1 (no multi archive). * * @param maxNumberOfDisks max number of multi archive disks. - * * @return {@code this} instance. */ public Builder setMaxNumberOfDisks(final long maxNumberOfDisks) { @@ -690,7 +689,6 @@ private static boolean tryToLocateSignature(final SeekableByteChannel channel, f * Opens the given file for reading, assuming "UTF8" for file names. * * @param file the archive. - * * @throws IOException if an error occurs while reading the file. * @deprecated Use {@link Builder#get()}. */ @@ -823,7 +821,6 @@ public ZipFile(final Path path, final String encoding, final boolean useUnicodeE *

* * @param channel the archive. - * * @throws IOException if an error occurs while reading the file. * @since 1.13 * @deprecated Use {@link Builder#get()}. @@ -1097,7 +1094,6 @@ public Iterable getEntries(final String name) { *

* * @return all entries as {@link ZipArchiveEntry} instances - * * @since 1.1 */ public Enumeration getEntriesInPhysicalOrder() { diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java index fb8e936238b..43ee456009b 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java @@ -201,7 +201,6 @@ public static ZipMethod getMethodByCode(final int code) { * the code of the compression method. * * @see ZipArchiveEntry#getMethod() - * * @return an integer code for the method */ public int getCode() { diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java index 0fb57fe79c8..cc141e96d6d 100644 --- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java +++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java @@ -277,7 +277,6 @@ static BigInteger longToBig(long l) { * Reverses a byte[] array. Reverses in-place (thus provided array is mutated), but also returns same for convenience. * * @param array to reverse (mutated in-place, but also returned for convenience). - * * @return the reversed array (mutated in-place, but also returned for convenience). * @since 1.5 */ diff --git a/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java index 1c03e223419..a2597e46f9d 100644 --- a/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java @@ -35,7 +35,6 @@ public CompressorInputStream() { * Increments the counter of already read bytes. Doesn't increment if the EOF has been hit (read == -1) * * @param read the number of bytes read - * * @since 1.1 */ protected void count(final int read) { @@ -57,7 +56,6 @@ protected void count(final long read) { * Gets the current number of bytes read from this stream. * * @return the number of read bytes - * * @since 1.1 */ public long getBytesRead() { 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 b5b84e73782..f1e72d34101 100644 --- a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java +++ b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java @@ -207,7 +207,6 @@ private static Iterable archiveStreamProviderIterable( * @return type of compressor stream detected * @throws CompressorException if no compressor stream type was detected or if something else went wrong * @throws IllegalArgumentException if stream is null or does not support mark - * * @since 1.14 */ public static String detect(final InputStream inputStream) throws CompressorException { diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java index 82190e4b38e..c3f3f72384d 100644 --- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java @@ -200,7 +200,6 @@ private static void hbCreateDecodeTables(final int[] limit, final int[] base, fi * @param signature the bytes to check * @param length the number of bytes to check * @return true, if this stream is a bzip2 compressed stream, false otherwise - * * @since 1.1 */ public static boolean matches(final byte[] signature, final int length) { diff --git a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java index 18e53f8e0b6..8fe4792a4b8 100644 --- a/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java @@ -404,7 +404,6 @@ private static void hbMakeCodeLengths(final byte[] len, final int[] freq, final * Constructs a new {@code BZip2CompressorOutputStream} with a blocksize of 900k. * * @param out the destination stream. - * * @throws IOException if an I/O error occurs in the specified stream. * @throws NullPointerException if {@code out == null}. */ @@ -417,11 +416,9 @@ public BZip2CompressorOutputStream(final OutputStream out) throws IOException { * * @param out the destination stream. * @param blockSize the blockSize as 100k units. - * * @throws IOException if an I/O error occurs in the specified stream. * @throws IllegalArgumentException if {@code (blockSize < 1) || (blockSize > 9)}. * @throws NullPointerException if {@code out == null}. - * * @see #MIN_BLOCKSIZE * @see #MAX_BLOCKSIZE */ diff --git a/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorInputStream.java index 09ec9076a4e..f833abc58d0 100644 --- a/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorInputStream.java @@ -46,7 +46,6 @@ public class DeflateCompressorInputStream extends CompressorInputStream implemen * @param signature the bytes to check * @param length the number of bytes to check * @return true, if this stream is zlib / deflate compressed with a header stream, false otherwise - * * @since 1.10 */ public static boolean matches(final byte[] signature, final int length) { diff --git a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java index a37f632a397..8e05bdebe67 100644 --- a/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java @@ -80,7 +80,6 @@ public class GzipCompressorInputStream extends CompressorInputStream implements * @param signature the bytes to check * @param length the number of bytes to check * @return true if this is a .gz stream, false otherwise - * * @since 1.1 */ public static boolean matches(final byte[] signature, final int length) { @@ -132,7 +131,6 @@ private static byte[] readToNull(final DataInput inData) throws IOException { * This is equivalent to {@code GzipCompressorInputStream(inputStream, false)} and thus will not decompress concatenated .gz files. * * @param inputStream the InputStream from which this object should be created of - * * @throws IOException if the stream could not be created */ public GzipCompressorInputStream(final InputStream inputStream) throws IOException { @@ -148,7 +146,6 @@ public GzipCompressorInputStream(final InputStream inputStream) throws IOExcepti * * @param inputStream the InputStream from which this object should be created of * @param decompressConcatenated if true, decompress until the end of the input; if false, stop after the first .gz member - * * @throws IOException if the stream could not be created */ public GzipCompressorInputStream(final InputStream inputStream, final boolean decompressConcatenated) throws IOException { 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 3c07c12e03d..cae17ba411a 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 @@ -75,7 +75,6 @@ public GzipCompressorOutputStream(final OutputStream out) throws IOException { * @param out the stream to compress to * @param parameters the parameters to use * @throws IOException if writing fails - * * @since 1.7 */ public GzipCompressorOutputStream(final OutputStream out, final GzipParameters parameters) throws IOException { 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 ada7d721c6b..28e795a9f20 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 @@ -114,7 +114,6 @@ public abstract class AbstractLZ77CompressorInputStream extends CompressorInputS * * @param is An InputStream to read compressed data from * @param windowSize Size of the window kept for back-references, must be bigger than the biggest offset expected. - * * @throws IllegalArgumentException if windowSize is not bigger than 0 */ public AbstractLZ77CompressorInputStream(final InputStream is, final int windowSize) { diff --git a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java index ff0695a93e8..81cc7254a5b 100644 --- a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java @@ -40,7 +40,6 @@ public class LZMACompressorInputStream extends CompressorInputStream implements * @param signature the bytes to check * @param length the number of bytes to check * @return true, if this stream is an LZMA compressed stream, false otherwise - * * @since 1.10 */ public static boolean matches(final byte[] signature, final int length) { @@ -55,7 +54,6 @@ public static boolean matches(final byte[] signature, final int length) { * Creates a new input stream that decompresses LZMA-compressed data from the specified input stream. * * @param inputStream where to read the compressed data - * * @throws IOException if the input is not in the .lzma format, the input is corrupt or truncated, the .lzma headers specify sizes that are not supported by * this implementation, or the underlying {@code inputStream} throws an exception */ @@ -67,9 +65,7 @@ public LZMACompressorInputStream(final InputStream inputStream) throws IOExcepti * Creates a new input stream that decompresses LZMA-compressed data from the specified input stream. * * @param inputStream where to read the compressed data - * * @param memoryLimitInKb calculated memory use threshold. Throws MemoryLimitException if calculate memory use is above this threshold - * * @throws IOException if the input is not in the .lzma format, the input is corrupt or truncated, the .lzma headers specify sizes that are not supported by * this implementation, or the underlying {@code inputStream} throws an exception * 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 06105286128..7796f20cdc2 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 @@ -63,7 +63,6 @@ private enum State { * Constructor using the default buffer size of 32k. * * @param is An InputStream to read compressed data from - * * @throws IOException if reading fails */ public SnappyCompressorInputStream(final InputStream is) throws IOException { @@ -75,7 +74,6 @@ public SnappyCompressorInputStream(final InputStream is) throws IOException { * * @param is An InputStream to read compressed data from * @param blockSize The block size used in compression - * * @throws IOException if reading fails * @throws IllegalArgumentException if blockSize is not bigger than 0 */ @@ -268,7 +266,6 @@ private int readLiteralLength(final int b) throws IOException { * stored as 0x40, and an uncompressed length of 2097150 (0x1FFFFE) would be stored as 0xFE 0xFF 0x7F. * * @return The size of the uncompressed data - * * @throws IOException Could not read a byte */ private long readSize() throws IOException { diff --git a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java index 9bfdff849a6..464863d95d8 100644 --- a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java @@ -65,7 +65,6 @@ public static boolean matches(final byte[] signature, final int length) { * Creates a new input stream that decompresses XZ-compressed data from the specified input stream. This doesn't support concatenated .xz files. * * @param inputStream where to read the compressed data - * * @throws IOException if the input is not in the .xz format, the input is corrupt or truncated, the .xz headers specify options that are not supported by * this implementation, or the underlying {@code inputStream} throws an exception */ diff --git a/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java index 83ef89e0c46..bfd6091a00a 100644 --- a/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java +++ b/src/main/java/org/apache/commons/compress/compressors/z/ZCompressorInputStream.java @@ -42,7 +42,6 @@ public class ZCompressorInputStream extends LZWInputStream { * @param signature the bytes to check * @param length the number of bytes to check * @return true, if this stream is a UNIX compress compressed stream, false otherwise - * * @since 1.9 */ public static boolean matches(final byte[] signature, final int length) { diff --git a/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java b/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java index 5cf4b662277..ce4f7dac152 100644 --- a/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java +++ b/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java @@ -81,7 +81,6 @@ public static BHSDCodec getCanonicalCodec(final int i) { * @param in the input stream to read additional byte headers from * @param defaultCodec TODO * @return the corresponding codec, or {@code null} if the default should be used - * * @throws IOException if there is a problem reading from the input stream (which in reality, is never, since the band_headers are likely stored in a * byte array and accessed via a ByteArrayInputStream. However, an EOFException could occur if things go wrong) * @throws Pack200Exception TODO diff --git a/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java b/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java index d7219607d7b..ba447b62bfe 100644 --- a/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java +++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java @@ -411,7 +411,6 @@ public long[][] parseFlags(final String name, final InputStream in, final int[] * @param count the number of references to decode * @param reference the array of values to use for the references * @return Parsed references. - * * @throws IOException if a problem occurs during reading from the underlying stream * @throws Pack200Exception if a problem occurs with an unexpected value or unsupported Codec */ @@ -431,7 +430,6 @@ public String[] parseReferences(final String name, final InputStream in, final B * @param counts the numbers of references to decode for each array entry * @param reference the array of values to use for the references * @return Parsed references. - * * @throws IOException if a problem occurs during reading from the underlying stream * @throws Pack200Exception if a problem occurs with an unexpected value or unsupported Codec */