Skip to content

Commit

Permalink
No need for blank Javadoc lines between Javadoc @ tags
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Nov 28, 2024
1 parent 86e37b0 commit b282518
Show file tree
Hide file tree
Showing 38 changed files with 0 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,6 @@ public CpioArchiveEntry(final short format, final File inputFile, final String e
* </pre>
*
* @param options options indicating how symbolic links are handled.
*
* @throws IOException if an I/O error occurs
* @since 1.21
*/
Expand Down Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand All @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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) {
Expand Down Expand Up @@ -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() {
Expand Down Expand Up @@ -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() {
Expand Down Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
* The algorithm is described in the ZIP File Format Specification.
*
* @see <a href="https://www.pkware.com/documents/casestudies/APPNOTE.TXT">ZIP File Format Specification</a>
*
* @since 1.7
*/
final class ExplodingInputStream extends InputStream implements InputStreamStatistics {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -372,7 +369,6 @@ public ZipExtraField onUnparseableExtraField(final byte[] data, final int off, f
* </p>
*
* @param clazz the class to register.
*
* @deprecated Use {@link ZipArchiveInputStream#setExtraFieldSupport} instead
* to not leak instances between archives and applications.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,6 @@ public final Callable<ScatterZipOutputStream> 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.
Expand Down Expand Up @@ -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<? extends Object> callable) {
Expand All @@ -249,7 +247,6 @@ public final void submit(final Callable<? extends Object> 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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
* </p>
*
* @see <a href="https://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE APPNOTE.TXT, section 4.6.8</a>
*
* @NotThreadSafe super-class is not thread-safe
*/
public class UnicodeCommentExtraField extends AbstractUnicodeExtraField {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
* </p>
*
* @see <a href="https://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE APPNOTE.TXT, section 4.6.9</a>
*
* @NotThreadSafe super-class is not thread-safe
*/
public class UnicodePathExtraField extends AbstractUnicodeExtraField {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
* </p>
*
* @see <a href="https://www.pkware.com/documents/casestudies/APPNOTE.TXT">PKWARE APPNOTE.TXT, section 4.5.3</a>
*
* @since 1.2
* @NotThreadSafe
*/
Expand Down Expand Up @@ -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) {
Expand All @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
* The different modes {@link ZipArchiveOutputStream} can operate in.
*
* @see ZipArchiveOutputStream#setUseZip64
*
* @since 1.3
*/
public enum Zip64Mode {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -926,7 +924,6 @@ public long getSize() {
* </p>
*
* @return The last modification time of the entry in milliseconds since the epoch, or -1 if not specified
*
* @see #setTime(long)
* @see #setLastModifiedTime(FileTime)
*/
Expand All @@ -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() {
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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()}.
*/
Expand Down Expand Up @@ -823,7 +821,6 @@ public ZipFile(final Path path, final String encoding, final boolean useUnicodeE
* </p>
*
* @param channel the archive.
*
* @throws IOException if an error occurs while reading the file.
* @since 1.13
* @deprecated Use {@link Builder#get()}.
Expand Down Expand Up @@ -1097,7 +1094,6 @@ public Iterable<ZipArchiveEntry> getEntries(final String name) {
* </p>
*
* @return all entries as {@link ZipArchiveEntry} instances
*
* @since 1.1
*/
public Enumeration<ZipArchiveEntry> getEntriesInPhysicalOrder() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand All @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,6 @@ private static Iterable<CompressorStreamProvider> 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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Loading

0 comments on commit b282518

Please sign in to comment.