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 1776a8a Use Javadoc tags instead of HTML.
1776a8a is described below
commit 1776a8ad90192ec396233a306910c41a17ef7742
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Oct 17 10:55:23 2021 -0400
Use Javadoc tags instead of HTML.
---
.../archivers/cpio/CpioArchiveInputStream.java | 2 +-
.../archivers/tar/TarArchiveInputStream.java | 10 ++++-----
.../archivers/zip/AbstractUnicodeExtraField.java | 4 ++--
.../compress/archivers/zip/AsiExtraField.java | 2 +-
.../archivers/zip/UnicodeCommentExtraField.java | 4 ++--
.../archivers/zip/UnicodePathExtraField.java | 4 ++--
.../commons/compress/archivers/zip/X000A_NTFS.java | 4 ++--
.../archivers/zip/X5455_ExtendedTimestamp.java | 4 ++--
.../compress/archivers/zip/X7875_NewUnix.java | 4 ++--
.../compress/archivers/zip/ZipArchiveEntry.java | 8 ++++----
.../archivers/zip/ZipArchiveInputStream.java | 2 +-
.../archivers/zip/ZipArchiveOutputStream.java | 2 +-
.../compress/archivers/zip/ZipEncoding.java | 2 +-
.../commons/compress/archivers/zip/ZipFile.java | 14 ++++++-------
.../commons/compress/archivers/zip/ZipUtil.java | 8 ++++----
.../bzip2/BZip2CompressorOutputStream.java | 6 +++---
.../deflate/DeflateCompressorOutputStream.java | 2 +-
.../gzip/GzipCompressorInputStream.java | 12 +++++------
.../AbstractLZ77CompressorInputStream.java | 16 +++++++--------
.../compressors/lz77support/LZ77Compressor.java | 22 ++++++++++----------
.../compressors/lz77support/Parameters.java | 24 +++++++++++-----------
.../lzma/LZMACompressorInputStream.java | 4 ++--
.../compress/compressors/lzw/LZWInputStream.java | 4 ++--
.../compressors/xz/XZCompressorInputStream.java | 6 +++---
.../compressors/xz/XZCompressorOutputStream.java | 4 ++--
.../commons/compress/harmony/pack200/Archive.java | 2 +-
.../compress/harmony/pack200/BHSDCodec.java | 12 +++++------
.../commons/compress/harmony/pack200/BcBands.java | 2 +-
.../compress/harmony/pack200/ClassBands.java | 2 +-
.../commons/compress/harmony/pack200/Codec.java | 8 ++++----
.../compress/harmony/pack200/CodecEncoding.java | 2 +-
.../compress/harmony/pack200/FileBands.java | 2 +-
.../commons/compress/harmony/pack200/IcBands.java | 2 +-
.../commons/compress/harmony/pack200/IntList.java | 2 +-
.../harmony/pack200/MetadataBandGroup.java | 2 +-
.../compress/harmony/pack200/NewAttribute.java | 8 ++++----
.../commons/compress/harmony/pack200/Segment.java | 4 ++--
.../compress/harmony/pack200/SegmentHeader.java | 2 +-
.../compress/harmony/unpack200/Archive.java | 2 +-
.../harmony/unpack200/AttributeLayout.java | 2 +-
.../compress/harmony/unpack200/BandSet.java | 16 +++++++--------
.../compress/harmony/unpack200/CpBands.java | 8 ++++----
.../compress/harmony/unpack200/SegmentHeader.java | 2 +-
.../commons/compress/utils/CharsetNames.java | 12 +++++------
.../apache/commons/compress/utils/Charsets.java | 12 +++++------
.../org/apache/commons/compress/utils/IOUtils.java | 14 ++++++-------
.../archivers/zip/ZipArchiveInputStreamTest.java | 4 ++--
47 files changed, 148 insertions(+), 148 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
index de57548..63ad802 100644
---
a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
@@ -148,7 +148,7 @@ public class CpioArchiveInputStream extends
ArchiveInputStream implements
* @param encoding
* The encoding of file names to expect - use null for
* the platform's default.
- * @throws IllegalArgumentException if <code>blockSize</code> is not
bigger than 0
+ * @throws IllegalArgumentException if {@code blockSize} is not bigger
than 0
* @since 1.6
*/
public CpioArchiveInputStream(final InputStream in, final int blockSize,
final String encoding) {
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 7a07926..0fbec40 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
@@ -246,13 +246,13 @@ public class TarArchiveInputStream extends
ArchiveInputStream {
/**
- * Skips over and discards <code>n</code> bytes of data from this input
- * stream. The <code>skip</code> method may, for a variety of reasons, end
- * up skipping over some smaller number of bytes, possibly <code>0</code>.
+ * Skips over and discards {@code n} bytes of data from this input
+ * stream. The {@code skip} method may, for a variety of reasons, end
+ * up skipping over some smaller number of bytes, possibly {@code 0}.
* This may result from any of a number of conditions; reaching end of file
- * or end of entry before <code>n</code> bytes have been skipped; are only
+ * or end of entry before {@code n} bytes have been skipped; are only
* two possibilities. The actual number of bytes skipped is returned. If
- * <code>n</code> is negative, no bytes are skipped.
+ * {@code n} is negative, no bytes are skipped.
*
*
* @param n
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
b/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
index 60dae9b..27a438b 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
@@ -43,9 +43,9 @@ public abstract class AbstractUnicodeExtraField implements
ZipExtraField {
* @param bytes The encoded of the file name or comment in the zip
* file.
* @param off The offset of the encoded file name or comment in
- * <code>bytes</code>.
+ * {@code bytes}.
* @param len The length of the encoded file name or comment in
- * <code>bytes</code>.
+ * {@code bytes}.
*/
protected AbstractUnicodeExtraField(final String text, final byte[] bytes,
final int off, final int len) {
final CRC32 crc32 = new CRC32();
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 bf82a3b..a487bc3 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
@@ -100,7 +100,7 @@ public class AsiExtraField implements ZipExtraField,
UnixStat, Cloneable {
/**
* Length of the extra field in the local file data - without
* Header-ID or length specifier.
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getLocalFileDataLength() {
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 0b0e84e..94f96dc 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
@@ -42,9 +42,9 @@ public class UnicodeCommentExtraField extends
AbstractUnicodeExtraField {
*
* @param text The file name
* @param bytes the bytes actually written to the archive
- * @param off The offset of the encoded comment in <code>bytes</code>.
+ * @param off The offset of the encoded comment in {@code bytes}.
* @param len The length of the encoded comment or comment in
- * <code>bytes</code>.
+ * {@code bytes}.
*/
public UnicodeCommentExtraField(final String text, final byte[] bytes,
final int off,
final int len) {
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 ab2796e..932f379 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
@@ -42,9 +42,9 @@ public class UnicodePathExtraField extends
AbstractUnicodeExtraField {
*
* @param text The file name
* @param bytes the bytes actually written to the archive
- * @param off The offset of the encoded file name in <code>bytes</code>.
+ * @param off The offset of the encoded file name in {@code bytes}.
* @param len The length of the encoded file name or comment in
- * <code>bytes</code>.
+ * {@code bytes}.
*/
public UnicodePathExtraField(final String text, final byte[] bytes, final
int off, final int len) {
super(text, bytes, off, len);
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
index 80b61e5..2f8645d 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X000A_NTFS.java
@@ -87,7 +87,7 @@ public class X000A_NTFS implements ZipExtraField {
* Length of the extra field in the local file data - without
* Header-ID or length specifier.
*
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getLocalFileDataLength() {
@@ -105,7 +105,7 @@ public class X000A_NTFS implements ZipExtraField {
* local length, because central cannot contain access or create
* timestamps.</p>
*
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getCentralDirectoryLength() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
index b462d6b..b1ded6f 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
@@ -137,7 +137,7 @@ public class X5455_ExtendedTimestamp implements
ZipExtraField, Cloneable, Serial
* Length of the extra field in the local file data - without
* Header-ID or length specifier.
*
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getLocalFileDataLength() {
@@ -156,7 +156,7 @@ public class X5455_ExtendedTimestamp implements
ZipExtraField, Cloneable, Serial
* local length, because central cannot contain access or create
* timestamps.</p>
*
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getCentralDirectoryLength() {
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
b/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
index c10ca6d..bf63439 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java
@@ -131,7 +131,7 @@ public class X7875_NewUnix implements ZipExtraField,
Cloneable, Serializable {
* Length of the extra field in the local file data - without
* Header-ID or length specifier.
*
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getLocalFileDataLength() {
@@ -148,7 +148,7 @@ public class X7875_NewUnix implements ZipExtraField,
Cloneable, Serializable {
* Length of the extra field in the central directory data - without
* Header-ID or length specifier.
*
- * @return a <code>ZipShort</code> for the length of the data of this
extra field
+ * @return a {@code ZipShort} for the length of the data of this extra
field
*/
@Override
public ZipShort getCentralDirectoryLength() {
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 1da9b55..ff51b82 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
@@ -324,7 +324,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
/**
* Sets the internal file attributes.
- * @param value an <code>int</code> value
+ * @param value an {@code int} value
*/
public void setInternalAttributes(final int value) {
internalAttributes = value;
@@ -345,7 +345,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
/**
* Sets the external file attributes.
- * @param value an <code>long</code> value
+ * @param value an {@code long} value
*/
public void setExternalAttributes(final long value) {
externalAttributes = value;
@@ -354,7 +354,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
/**
* Sets Unix permissions in a way that is understood by Info-Zip's
* unzip command.
- * @param mode an <code>int</code> value
+ * @param mode an {@code int} value
*/
public void setUnixMode(final int mode) {
// CheckStyle:MagicNumberCheck OFF - no point
@@ -401,7 +401,7 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
/**
* Set the platform (UNIX or FAT).
- * @param platform an <code>int</code> value - 0 is FAT, 3 is UNIX
+ * @param platform an {@code int} value - 0 is FAT, 3 is UNIX
*/
protected void setPlatform(final int platform) {
this.platform = platform;
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 ab6994a..1d25372 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
@@ -1339,7 +1339,7 @@ public class ZipArchiveInputStream extends
ArchiveInputStream implements InputSt
private long pos;
/**
- * Creates a new <code>BoundedInputStream</code> that wraps the given
input
+ * Creates a new {@code BoundedInputStream} that wraps the given input
* stream and limits it to a certain size.
*
* @param in The wrapped input stream
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 f73af51..7b6558e 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
@@ -981,7 +981,7 @@ public class ZipArchiveOutputStream extends
ArchiveOutputStream {
* Sets the default compression method for subsequent entries.
*
* <p>Default is DEFLATED.</p>
- * @param method an <code>int</code> from java.util.zip.ZipEntry
+ * @param method an {@code int} from java.util.zip.ZipEntry
*/
public void setMethod(final int method) {
this.method = method;
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
index fc52e57..435cc14 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
@@ -66,7 +66,7 @@ public interface ZipEncoding {
* @return A byte buffer with a backing array containing the
* encoded name. Unmappable characters or malformed
* character sequences are mapped to a sequence of utf-16
- * words encoded in the format <code>%Uxxxx</code>. It is
+ * words encoded in the format {@code %Uxxxx}. It is
* assumed, that the byte buffer is positioned at the
* beginning of the encoded result, the byte buffer has a
* backing array and the limit of the byte buffer points
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 33bd40a..8165b0f 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
@@ -58,31 +58,31 @@ import static
org.apache.commons.compress.archivers.zip.ZipConstants.ZIP64_MAGIC
import static
org.apache.commons.compress.archivers.zip.ZipConstants.ZIP64_MAGIC_SHORT;
/**
- * Replacement for <code>java.util.ZipFile</code>.
+ * Replacement for {@code java.util.ZipFile}.
*
* <p>This class adds support for file name encodings other than UTF-8
* (which is required to work on ZIP files created by native zip tools
* and is able to skip a preamble like the one found in self
* extracting archives. Furthermore it returns instances of
- * <code>org.apache.commons.compress.archivers.zip.ZipArchiveEntry</code>
- * instead of <code>java.util.zip.ZipEntry</code>.</p>
+ * {@code org.apache.commons.compress.archivers.zip.ZipArchiveEntry}
+ * instead of {@code java.util.zip.ZipEntry}.</p>
*
- * <p>It doesn't extend <code>java.util.zip.ZipFile</code> as it would
+ * <p>It doesn't extend {@code java.util.zip.ZipFile} as it would
* have to reimplement all methods anyway. Like
- * <code>java.util.ZipFile</code>, it uses SeekableByteChannel under the
+ * {@code java.util.ZipFile}, it uses SeekableByteChannel under the
* covers and supports compressed and uncompressed entries. As of
* Apache Commons Compress 1.3 it also transparently supports Zip64
* extensions and thus individual entries and archives larger than 4
* GB or with more than 65536 entries.</p>
*
* <p>The method signatures mimic the ones of
- * <code>java.util.zip.ZipFile</code>, with a couple of exceptions:
+ * {@code java.util.zip.ZipFile}, with a couple of exceptions:
*
* <ul>
* <li>There is no getName method.</li>
* <li>entries has been renamed to getEntries.</li>
* <li>getEntries and getEntry return
- * <code>org.apache.commons.compress.archivers.zip.ZipArchiveEntry</code>
+ * {@code org.apache.commons.compress.archivers.zip.ZipArchiveEntry}
* instances.</li>
* <li>close is allowed to throw IOException.</li>
* </ul>
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 104b396..233be03 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
@@ -37,8 +37,8 @@ public abstract class ZipUtil {
/**
* Convert a Date object to a DOS date/time field.
- * @param time the <code>Date</code> to convert
- * @return the date as a <code>ZipLong</code>
+ * @param time the {@code Date} to convert
+ * @return the date as a {@code ZipLong}
*/
public static ZipLong toDosTime(final Date time) {
return new ZipLong(toDosTime(time.getTime()));
@@ -47,7 +47,7 @@ public abstract class ZipUtil {
/**
* Convert a Date object to a DOS date/time field.
*
- * <p>Stolen from InfoZip's <code>fileio.c</code></p>
+ * <p>Stolen from InfoZip's {@code fileio.c}</p>
* @param t number of milliseconds since the epoch
* @return the date as a byte array
*/
@@ -60,7 +60,7 @@ public abstract class ZipUtil {
/**
* Convert a Date object to a DOS date/time field.
*
- * <p>Stolen from InfoZip's <code>fileio.c</code></p>
+ * <p>Stolen from InfoZip's {@code fileio.c}</p>
* @param t number of milliseconds since the epoch
* @param buf the output buffer
* @param offset
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 72c7a9f..082c8ee 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
@@ -351,7 +351,7 @@ public class BZip2CompressorOutputStream extends
CompressorOutputStream
* @throws IOException
* if an I/O error occurs in the specified stream.
* @throws NullPointerException
- * if <code>out == null</code>.
+ * if {@code out == null}.
*/
public BZip2CompressorOutputStream(final OutputStream out)
throws IOException {
@@ -369,9 +369,9 @@ public class BZip2CompressorOutputStream extends
CompressorOutputStream
* @throws IOException
* if an I/O error occurs in the specified stream.
* @throws IllegalArgumentException
- * if <code>(blockSize < 1) || (blockSize > 9)</code>.
+ * if {@code (blockSize < 1) || (blockSize > 9)}.
* @throws NullPointerException
- * if <code>out == null</code>.
+ * if {@code out == null}.
*
* @see #MIN_BLOCKSIZE
* @see #MAX_BLOCKSIZE
diff --git
a/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java
index a315605..a12ec54 100644
---
a/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java
@@ -65,7 +65,7 @@ public class DeflateCompressorOutputStream extends
CompressorOutputStream {
}
/**
- * Flushes the encoder and calls <code>outputStream.flush()</code>.
+ * Flushes the encoder and calls {@code outputStream.flush()}.
* All buffered pending data will then be decompressible from
* the output stream. Calling this function very often may increase
* the compressed file size a lot.
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 e46912b..693ee34 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
@@ -53,7 +53,7 @@ import static java.nio.charset.StandardCharsets.*;
* </p>
*
* <p>
- * Instead of using <code>GZIPInputStream</code>, this class has its own .gz
+ * Instead of using {@code GZIPInputStream}, this class has its own .gz
* container format decoder. The actual decompression is done with
* {@link java.util.zip.Inflater}.
* </p>
@@ -119,7 +119,7 @@ public class GzipCompressorInputStream extends
CompressorInputStream
* from the specified input stream.
* <p>
* This is equivalent to
- * <code>GzipCompressorInputStream(inputStream, false)</code> and thus
+ * {@code GzipCompressorInputStream(inputStream, false)} and thus
* will not decompress concatenated .gz files.
*
* @param inputStream the InputStream from which this object should
@@ -136,12 +136,12 @@ public class GzipCompressorInputStream extends
CompressorInputStream
* Constructs a new input stream that decompresses gzip-compressed data
* from the specified input stream.
* <p>
- * If <code>decompressConcatenated</code> is {@code false}:
+ * If {@code decompressConcatenated} is {@code false}:
* This decompressor might read more input than it will actually use.
- * If <code>inputStream</code> supports <code>mark</code> and
- * <code>reset</code>, then the input position will be adjusted
+ * If {@code inputStream} supports {@code mark} and
+ * {@code reset}, then the input position will be adjusted
* so that it is right after the last byte of the compressed stream.
- * If <code>mark</code> isn't supported, the input position will be
+ * If {@code mark} isn't supported, the input position will be
* undefined.
*
* @param inputStream the InputStream from which this object should
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 25546f7..d08b22d 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
@@ -227,10 +227,10 @@ public abstract class AbstractLZ77CompressorInputStream
extends CompressorInputS
* @throws IOException if the underlying stream throws or signals
* an EOF before the amount of data promised for the block have
* been read
- * @throws NullPointerException if <code>b</code> is null
- * @throws IndexOutOfBoundsException if <code>off</code> is
- * negative, <code>len</code> is negative, or <code>len</code> is
- * greater than <code>b.length - off</code>
+ * @throws NullPointerException if {@code b} is null
+ * @throws IndexOutOfBoundsException if {@code off} is
+ * negative, {@code len} is negative, or {@code len} is
+ * greater than {@code b.length - off}
*/
protected final int readLiteral(final byte[] b, final int off, final int
len) throws IOException {
final int avail = available();
@@ -301,10 +301,10 @@ public abstract class AbstractLZ77CompressorInputStream
extends CompressorInputS
* @param len maximum amount of data to read
* @return number of bytes read, may be 0. Will never return -1 as
* EOF-detection is the responsibility of the subclass
- * @throws NullPointerException if <code>b</code> is null
- * @throws IndexOutOfBoundsException if <code>off</code> is
- * negative, <code>len</code> is negative, or <code>len</code> is
- * greater than <code>b.length - off</code>
+ * @throws NullPointerException if {@code b} is null
+ * @throws IndexOutOfBoundsException if {@code off} is
+ * negative, {@code len} is negative, or {@code len} is
+ * greater than {@code b.length - off}
*/
protected final int readBackReference(final byte[] b, final int off, final
int len) {
final int avail = available();
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
index 688c3e3..9423f6a 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/LZ77Compressor.java
@@ -27,9 +27,9 @@ import java.util.Objects;
*
* <p>Most LZ77 derived algorithms split input data into blocks of
* uncompressed data (called literal blocks) and back-references
- * (pairs of offsets and lengths) that state "add <code>length</code>
+ * (pairs of offsets and lengths) that state "add {@code length}
* bytes that are the same as those already written starting
- * <code>offset</code> bytes before the current position. The details
+ * {@code offset} bytes before the current position. The details
* of how those blocks and back-references are encoded are quite
* different between the algorithms and some algorithms perform
* additional steps (Huffman encoding in the case of DEFLATE for
@@ -47,7 +47,7 @@ import java.util.Objects;
* talk about it :-), LZSS would likely be closer to the truth but
* LZ77 has become the synonym for a whole family of algorithms.</p>
*
- * <p>The API consists of a compressor that is fed <code>byte</code>s
+ * <p>The API consists of a compressor that is fed {@code byte}s
* and emits {@link Block}s to a registered callback where the blocks
* represent either {@link LiteralBlock literal blocks}, {@link
* BackReference back-references} or {@link EOD end of data
@@ -58,24 +58,24 @@ import java.util.Objects;
* <p>Several parameters influence the outcome of the "compression":</p>
* <dl>
*
- * <dt><code>windowSize</code></dt> <dd>the size of the sliding
+ * <dt>{@code windowSize}</dt> <dd>the size of the sliding
* window, must be a power of two - this determines the maximum
* offset a back-reference can take. The compressor maintains a
- * buffer of twice of <code>windowSize</code> - real world values are
+ * buffer of twice of {@code windowSize} - real world values are
* in the area of 32k.</dd>
*
- * <dt><code>minBackReferenceLength</code></dt>
+ * <dt>{@code minBackReferenceLength}</dt>
* <dd>Minimal length of a back-reference found. A true minimum of 3 is
* hard-coded inside of this implementation but bigger lengths can be
* configured.</dd>
*
- * <dt><code>maxBackReferenceLength</code></dt>
+ * <dt>{@code maxBackReferenceLength}</dt>
* <dd>Maximal length of a back-reference found.</dd>
*
- * <dt><code>maxOffset</code></dt>
+ * <dt>{@code maxOffset}</dt>
* <dd>Maximal offset of a back-reference.</dd>
*
- * <dt><code>maxLiteralLength</code></dt>
+ * <dt>{@code maxLiteralLength}</dt>
* <dd>Maximal length of a literal block.</dd>
* </dl>
*
@@ -253,7 +253,7 @@ public class LZ77Compressor {
* Initializes a compressor with parameters and a callback.
* @param params the parameters
* @param callback the callback
- * @throws NullPointerException if either parameter is <code>null</code>
+ * @throws NullPointerException if either parameter is {@code null}
*/
public LZ77Compressor(final Parameters params, final Callback callback) {
Objects.requireNonNull(params, "params");
@@ -458,7 +458,7 @@ public class LZ77Compressor {
* Inserts the current three byte sequence into the dictionary and
* returns the previous head of the hash-chain.
*
- * <p>Updates <code>insertHash</code> and <code>prev</code> as a
+ * <p>Updates {@code insertHash} and {@code prev} as a
* side effect.</p>
*/
private int insertString(final int pos) {
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
index cd468a1..8c0fc15 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lz77support/Parameters.java
@@ -29,8 +29,8 @@ public final class Parameters {
/**
* Initializes the builder for the compressor's parameters with a
- * <code>minBackReferenceLength</code> of 3 and <code>max*Length</code>
- * equal to <code>windowSize - 1</code>.
+ * {@code minBackReferenceLength} of 3 and {@code max*Length}
+ * equal to {@code windowSize - 1}.
*
* <p>It is recommended to not use this method directly but rather
* tune a pre-configured builder created by a format specific
@@ -70,8 +70,8 @@ public final class Parameters {
/**
* Sets the minimal length of a back-reference.
*
- * <p>Ensures <code>maxBackReferenceLength</code> is not
- * smaller than <code>minBackReferenceLength</code>.
+ * <p>Ensures {@code maxBackReferenceLength} is not
+ * smaller than {@code minBackReferenceLength}.
*
* <p>It is recommended to not use this method directly but
* rather tune a pre-configured builder created by a format
@@ -81,8 +81,8 @@ public final class Parameters {
* @param minBackReferenceLength the minimal length of a
back-reference found. A
* true minimum of 3 is hard-coded inside of this implementation
* but bigger lengths can be configured.
- * @throws IllegalArgumentException if <code>windowSize</code>
- * is smaller than <code>minBackReferenceLength</code>.
+ * @throws IllegalArgumentException if {@code windowSize}
+ * is smaller than {@code minBackReferenceLength}.
* @return the builder
*/
public Builder withMinBackReferenceLength(final int
minBackReferenceLength) {
@@ -106,9 +106,9 @@ public final class Parameters {
*
* @param maxBackReferenceLength maximal length of a
* back-reference found. A value smaller than
- * <code>minBackReferenceLength</code> is interpreted as
- * <code>minBackReferenceLength</code>.
<code>maxBackReferenceLength</code>
- * is capped at <code>windowSize - 1</code>.
+ * {@code minBackReferenceLength} is interpreted as
+ * {@code minBackReferenceLength}. {@code maxBackReferenceLength}
+ * is capped at {@code windowSize - 1}.
* @return the builder
*/
public Builder withMaxBackReferenceLength(final int
maxBackReferenceLength) {
@@ -127,7 +127,7 @@ public final class Parameters {
*
* @param maxOffset maximal offset of a back-reference. A
* non-positive value as well as values bigger than
- * <code>windowSize - 1</code> are interpreted as <code>windowSize
+ * {@code windowSize - 1} are interpreted as <code>windowSize
* - 1</code>.
* @return the builder
*/
@@ -146,8 +146,8 @@ public final class Parameters {
*
* @param maxLiteralLength maximal length of a literal
* block. Negative numbers and 0 as well as values bigger than
- * <code>windowSize</code> are interpreted as
- * <code>windowSize</code>.
+ * {@code windowSize} are interpreted as
+ * {@code windowSize}.
* @return the builder
*/
public Builder withMaxLiteralLength(final int maxLiteralLength) {
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 9fe20bc..4bb140a 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
@@ -49,7 +49,7 @@ public class LZMACompressorInputStream extends
CompressorInputStream
* the input is corrupt or truncated, the .lzma
* headers specify sizes that are not supported
* by this implementation, or the underlying
- * <code>inputStream</code> throws an exception
+ * {@code inputStream} throws an exception
*/
public LZMACompressorInputStream(final InputStream inputStream)
throws IOException {
@@ -69,7 +69,7 @@ public class LZMACompressorInputStream extends
CompressorInputStream
* the input is corrupt or truncated, the .lzma
* headers specify sizes that are not supported
* by this implementation, or the underlying
- * <code>inputStream</code> throws an exception
+ * {@code inputStream} throws an exception
*
* @since 1.14
*/
diff --git
a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
index abf6f88..736faf1 100644
---
a/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/lzw/LZWInputStream.java
@@ -131,7 +131,7 @@ public abstract class LZWInputStream extends
CompressorInputStream implements In
* @param maxCodeSize maximum code size
* @param memoryLimitInKb maximum allowed estimated memory usage in Kb
* @throws MemoryLimitException if estimated memory usage is greater than
memoryLimitInKb
- * @throws IllegalArgumentException if <code>maxCodeSize</code> is not
bigger than 0
+ * @throws IllegalArgumentException if {@code maxCodeSize} is not bigger
than 0
*/
protected void initializeTables(final int maxCodeSize, final int
memoryLimitInKb)
throws MemoryLimitException {
@@ -156,7 +156,7 @@ public abstract class LZWInputStream extends
CompressorInputStream implements In
/**
* Initializes the arrays based on the maximum code size.
* @param maxCodeSize maximum code size
- * @throws IllegalArgumentException if <code>maxCodeSize</code> is not
bigger than 0
+ * @throws IllegalArgumentException if {@code maxCodeSize} is not bigger
than 0
*/
protected void initializeTables(final int maxCodeSize) {
if (maxCodeSize <= 0) {
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 8d3b214..86e2a84 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
@@ -73,7 +73,7 @@ public class XZCompressorInputStream extends
CompressorInputStream
* the input is corrupt or truncated, the .xz
* headers specify options that are not supported
* by this implementation, or the underlying
- * <code>inputStream</code> throws an exception
+ * {@code inputStream} throws an exception
*/
public XZCompressorInputStream(final InputStream inputStream)
throws IOException {
@@ -95,7 +95,7 @@ public class XZCompressorInputStream extends
CompressorInputStream
* the input is corrupt or truncated, the .xz
* headers specify options that are not supported
* by this implementation, or the underlying
- * <code>inputStream</code> throws an exception
+ * {@code inputStream} throws an exception
*/
public XZCompressorInputStream(final InputStream inputStream,
final boolean decompressConcatenated)
@@ -121,7 +121,7 @@ public class XZCompressorInputStream extends
CompressorInputStream
* the input is corrupt or truncated, the .xz
* headers specify options that are not supported
* by this implementation,
- * or the underlying <code>inputStream</code>
throws an exception
+ * or the underlying {@code inputStream} throws
an exception
*
* @since 1.14
*/
diff --git
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
index 6e9b70e..d2674e7 100644
---
a/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
+++
b/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
@@ -34,7 +34,7 @@ public class XZCompressorOutputStream extends
CompressorOutputStream {
/**
* Creates a new XZ compressor using the default LZMA2 options.
- * This is equivalent to <code>XZCompressorOutputStream(outputStream,
6)</code>.
+ * This is equivalent to {@code XZCompressorOutputStream(outputStream, 6)}.
* @param outputStream the stream to wrap
* @throws IOException on error
*/
@@ -75,7 +75,7 @@ public class XZCompressorOutputStream extends
CompressorOutputStream {
}
/**
- * Flushes the encoder and calls <code>outputStream.flush()</code>.
+ * Flushes the encoder and calls {@code outputStream.flush()}.
* All buffered pending data will then be decompressible from
* the output stream. Calling this function very often may increase
* the compressed file size a lot.
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
index 8a1bcde..76a2f79 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
@@ -30,7 +30,7 @@ import java.util.zip.ZipEntry;
/**
* Archive is the main entry point to pack200 and represents a packed archive.
An archive is constructed with either a
* JarInputStream and an output stream or a JarFile as input and an
OutputStream. Options can be set, then
- * <code>pack()</code> is called, to pack the Jar file into a pack200 archive.
+ * {@code pack()} is called, to pack the Jar file into a pack200 archive.
*/
public class Archive {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/BHSDCodec.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/BHSDCodec.java
index 0e5dd11..39cac37 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/BHSDCodec.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/BHSDCodec.java
@@ -37,8 +37,8 @@ import java.util.List;
* <dd>The maximum number of bytes that each value is encoded as. B must be a
value between [1..5]. For a pass-through
* coding (where each byte is encoded as itself, aka {@link #BYTE1}, B is 1
(each byte takes a maximum of 1 byte).</dd>
* <dt>H</dt>
- * <dd>The radix of the integer. Values are defined as a sequence of values,
where value <code>n</code> is multiplied by
- * <code>H^<sup>n</sup></code>. So the number 1234 may be represented as the
sequence 4 3 2 1 with a radix (H) of 10.
+ * <dd>The radix of the integer. Values are defined as a sequence of values,
where value {@code n} is multiplied by
+ * {@code H^<sup>n</sup>}. So the number 1234 may be represented as the
sequence 4 3 2 1 with a radix (H) of 10.
* Note that other permutations are also possible; 43 2 1 will also encode
1234. The co-parameter L is defined as 256-H.
* This is important because only the last value in a sequence may be < L;
all prior values must be > L.</dd>
* <dt>S</dt>
@@ -46,9 +46,9 @@ import java.util.List;
* complement) or 2 (signed, two's complement)</dd>
* <dt>D</dt>
* <dd>Whether the codec represents a delta encoding. This may be 0 (no delta)
or 1 (delta encoding). A delta encoding
- * of 1 indicates that values are cumulative; a sequence of <code>1 1 1 1
1</code> will represent the sequence
- * <code>1 2 3 4 5</code>. For this reason, the codec supports two variants of
decode; one
- * {@link #decode(InputStream, long) with} and one {@link #decode(InputStream)
without} a <code>last</code> parameter.
+ * of 1 indicates that values are cumulative; a sequence of {@code 1 1 1 1 1}
will represent the sequence
+ * {@code 1 2 3 4 5}. For this reason, the codec supports two variants of
decode; one
+ * {@link #decode(InputStream, long) with} and one {@link #decode(InputStream)
without} a {@code last} parameter.
* If the codec is a non-delta encoding, then the value is ignored if passed.
If the codec is a delta encoding, it is a
* run-time error to call the value without the extra parameter, and the
previous value should be returned. (It was
* designed this way to support multi-threaded access without requiring a new
instance of the Codec to be cloned for
@@ -277,7 +277,7 @@ public final class BHSDCodec extends Codec {
* True if this encoding can code the given value
*
* @param value the value to check
- * @return <code>true</code> if the encoding can encode this value
+ * @return {@code true} if the encoding can encode this value
*/
public boolean encodes(final long value) {
return value >= smallest && value <= largest;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
index 53457a0..bd734be 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/BcBands.java
@@ -26,7 +26,7 @@ import java.util.Map;
import org.objectweb.asm.Label;
/**
- * Bytecode bands (corresponds to the <code>bc_bands</code> set of bands in
the pack200 specification)
+ * Bytecode bands (corresponds to the {@code bc_bands} set of bands in the
pack200 specification)
*/
public class BcBands extends BandSet {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/ClassBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/ClassBands.java
index a3f5a80..f28f327 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/ClassBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/ClassBands.java
@@ -33,7 +33,7 @@ import org.objectweb.asm.Label;
import org.objectweb.asm.Opcodes;
/**
- * Class bands (corresponds to the <code>class_bands</code> set of bands in
the pack200 specification)
+ * Class bands (corresponds to the {@code class_bands} set of bands in the
pack200 specification)
*/
public class ClassBands extends BandSet {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
index add73d9..e7e04b4 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
@@ -134,12 +134,12 @@ public abstract class Codec {
public abstract int decode(InputStream in, long last) throws IOException,
Pack200Exception;
/**
- * Decodes a sequence of <code>n</code> values from <code>in</code>. This
should probably be used in most cases,
+ * Decodes a sequence of {@code n} values from {@code in}. This should
probably be used in most cases,
* since some codecs (such as {@link PopulationCodec}) only work when the
number of values to be read is known.
*
* @param n the number of values to decode
* @param in the input stream to read from
- * @return an array of <code>int</code> values corresponding to values
decoded
+ * @return an array of {@code int} values corresponding to values decoded
* @throws IOException if there is a problem reading from the underlying
input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
@@ -154,12 +154,12 @@ public abstract class Codec {
}
/**
- * Decodes a sequence of <code>n</code> values from <code>in</code>.
+ * Decodes a sequence of {@code n} values from {@code in}.
*
* @param n the number of values to decode
* @param in the input stream to read from
* @param firstValue the first value in the band if it has already been
read
- * @return an array of <code>int</code> values corresponding to values
decoded, with firstValue as the first value
+ * @return an array of {@code int} values corresponding to values decoded,
with firstValue as the first value
* in the array.
* @throws IOException if there is a problem reading from the underlying
input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
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 f0b7827..509b707 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
@@ -76,7 +76,7 @@ public class CodecEncoding {
* @param value the canonical encoding value
* @param in the input stream to read additional byte headers from
* @param defaultCodec TODO
- * @return the corresponding codec, or <code>null</code> if the default
should be used
+ * @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
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/FileBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/FileBands.java
index 9c087f9..746b900 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/FileBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/FileBands.java
@@ -29,7 +29,7 @@ import org.objectweb.asm.ClassReader;
/**
* Bands containing information about files in the pack200 archive and the
file contents for non-class-files.
- * Corresponds to the <code>file_bands</code> set of bands described in the
specification.
+ * Corresponds to the {@code file_bands} set of bands described in the
specification.
*/
public class FileBands extends BandSet {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/IcBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/IcBands.java
index 5950dbc..cfbb197 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/IcBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/IcBands.java
@@ -26,7 +26,7 @@ import java.util.Set;
import java.util.TreeSet;
/**
- * Inner class bands (corresponds to the <code>ic_bands</code> set of bands in
the pack200 specification)
+ * Inner class bands (corresponds to the {@code ic_bands} set of bands in the
pack200 specification)
*/
public class IcBands extends BandSet {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
index 1b76877..34e9c2f 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/IntList.java
@@ -19,7 +19,7 @@ package org.apache.commons.compress.harmony.pack200;
import java.util.Arrays;
/**
- * IntList is based on <code>java.util.ArrayList</code>, but is written
specifically for ints in order to reduce boxing
+ * IntList is based on {@code java.util.ArrayList}, but is written
specifically for ints in order to reduce boxing
* and unboxing to Integers, reduce the memory required and improve
performance of pack200.
*/
public class IntList {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
index da0b841..a28c3c5 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
@@ -60,7 +60,7 @@ public class MetadataBandGroup extends BandSet {
* Constructs a new MetadataBandGroup
*
* @param type must be either AD, RVA, RIA, RVPA or RIPA.
- * @param context <code>CONTEXT_CLASS</code>, <code>CONTEXT_METHOD</code>
or <code>CONTEXT_FIELD</code>
+ * @param context {@code CONTEXT_CLASS}, {@code CONTEXT_METHOD} or {@code
CONTEXT_FIELD}
* @param cpBands constant pool bands
* @param segmentHeader segment header
* @param effort packing effort
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
index 1b1e520..c052e00 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttribute.java
@@ -21,7 +21,7 @@ import org.objectweb.asm.ClassReader;
import org.objectweb.asm.Label;
/**
- * NewAttribute extends <code>Attribute</code> and manages unknown attributes
encountered by ASM that have had a layout
+ * NewAttribute extends {@code Attribute} and manages unknown attributes
encountered by ASM that have had a layout
* definition given to pack200 (e.g. via one of the -C, -M, -F or -D command
line options)
*/
public class NewAttribute extends Attribute {
@@ -145,7 +145,7 @@ public class NewAttribute extends Attribute {
}
/**
- * ErrorAttribute extends <code>NewAttribute</code> and manages attributes
encountered by ASM that have had an error
+ * ErrorAttribute extends {@code NewAttribute} and manages attributes
encountered by ASM that have had an error
* action specified to pack200 (e.g. via one of the -C, -M, -F or -D
command line options such as
* -Cattribute-name=error)
*/
@@ -164,7 +164,7 @@ public class NewAttribute extends Attribute {
}
/**
- * StripAttribute extends <code>NewAttribute</code> and manages attributes
encountered by ASM that have had an strip
+ * StripAttribute extends {@code NewAttribute} and manages attributes
encountered by ASM that have had an strip
* action specified to pack200 (e.g. via one of the -C, -M, -F or -D
command line options such as
* -Cattribute-name=strip)
*/
@@ -183,7 +183,7 @@ public class NewAttribute extends Attribute {
}
/**
- * PassAttribute extends <code>NewAttribute</code> and manages attributes
encountered by ASM that have had an pass
+ * PassAttribute extends {@code NewAttribute} and manages attributes
encountered by ASM that have had an pass
* action specified to pack200 (e.g. via one of the -C, -M, -F or -D
command line options such as
* -Cattribute-name=pass)
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
index 42231d2..fe8a7fd 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
@@ -436,7 +436,7 @@ public class Segment extends ClassVisitor {
}
/**
- * SegmentAnnotationVisitor implements <code>AnnotationVisitor</code> to
visit Annotations found in a class file.
+ * SegmentAnnotationVisitor implements {@code AnnotationVisitor} to visit
Annotations found in a class file.
*/
public class SegmentAnnotationVisitor extends AnnotationVisitor {
@@ -625,7 +625,7 @@ public class Segment extends ClassVisitor {
}
/**
- * SegmentFieldVisitor implements <code>FieldVisitor</code> to visit the
metadata relating to fields in a class
+ * SegmentFieldVisitor implements {@code FieldVisitor} to visit the
metadata relating to fields in a class
* file.
*/
public class SegmentFieldVisitor extends FieldVisitor {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
index 804ecd8..5c1ca48 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/SegmentHeader.java
@@ -20,7 +20,7 @@ import java.io.IOException;
import java.io.OutputStream;
/**
- * SegmentHeader is the header band of a {@link Segment}. Corresponds to
<code>segment_header</code> in the pack200
+ * SegmentHeader is the header band of a {@link Segment}. Corresponds to
{@code segment_header} in the pack200
* specification.
*/
public class SegmentHeader extends BandSet {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
index cf998a3..690c465 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
@@ -34,7 +34,7 @@ import
org.apache.commons.compress.harmony.pack200.Pack200Exception;
/**
* Archive is the main entry point to unpack200. An archive is constructed
with either two file names, a pack file and
- * an output file name or an input stream and an output streams. Then
<code>unpack()</code> is called, to unpack the
+ * an output file name or an input stream and an output streams. Then {@code
unpack()} is called, to unpack the
* pack200 archive.
*/
public class Archive {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
index f6dba75..822433f 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/AttributeLayout.java
@@ -110,7 +110,7 @@ public class AttributeLayout implements IMatcher {
/**
* Construct a default AttributeLayout (equivalent to
- * <code>new AttributeLayout(name, context, layout, index, true);</code>)
+ * {@code new AttributeLayout(name, context, layout, index, true);})
*
* @param name TODO
* @param context 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 76d36d0..03d7840 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
@@ -61,13 +61,13 @@ public abstract class BandSet {
}
/**
- * Decode a band and return an array of <code>int</code> values
+ * Decode a band and return an array of {@code int} values
*
* @param name the name of the band (primarily for logging/debugging
purposes)
* @param in the InputStream to decode from
* @param codec the default Codec for this band
* @param count the number of elements to read
- * @return an array of decoded <code>int</code> values
+ * @return an array of decoded {@code int} values
* @throws IOException if there is a problem reading from the underlying
input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
@@ -127,13 +127,13 @@ public abstract class BandSet {
}
/**
- * Decode a band and return an array of <code>int[]</code> values
+ * Decode a band and return an array of {@code int[]} values
*
* @param name the name of the band (primarily for logging/debugging
purposes)
* @param in the InputStream to decode from
* @param defaultCodec the default codec for this band
* @param counts the numbers of elements to read for each int array within
the array to be returned
- * @return an array of decoded <code>int[]</code> values
+ * @return an array of decoded {@code int[]} values
* @throws IOException if there is a problem reading from the underlying
input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
@@ -207,8 +207,8 @@ public abstract class BandSet {
}
/**
- * Parses <i>count</i> references from <code>in</code>, using
<code>codec</code> to decode the values as indexes
- * into <code>reference</code> (which is populated prior to this call). An
exception is thrown if a decoded index
+ * Parses <i>count</i> references from {@code in}, using {@code codec} to
decode the values as indexes
+ * into {@code reference} (which is populated prior to this call). An
exception is thrown if a decoded index
* falls outside the range [0..reference.length-1].
*
* @param name the band name
@@ -227,8 +227,8 @@ public abstract class BandSet {
}
/**
- * Parses <i>count</i> references from <code>in</code>, using
<code>codec</code> to decode the values as indexes
- * into <code>reference</code> (which is populated prior to this call). An
exception is thrown if a decoded index
+ * Parses <i>count</i> references from {@code in}, using {@code codec} to
decode the values as indexes
+ * into {@code reference} (which is populated prior to this call). An
exception is thrown if a decoded index
* falls outside the range [0..reference.length-1]. Unlike the other
parseReferences, this post-processes the result
* into an array of results.
*
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/CpBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/CpBands.java
index 90e5c5e..dcee0f6 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/CpBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/CpBands.java
@@ -162,7 +162,7 @@ public class CpBands extends BandSet {
* Parses the constant pool descriptor definitions, using {@link
#cpDescriptorCount} to populate
* {@link #cpDescriptor}. For ease of use, the cpDescriptor is stored as a
string of the form <i>name:type</i>,
* largely to make it easier for representing field and method descriptors
(e.g.
- * <code>out:java.lang.PrintStream</code>) in a way that is compatible
with passing String arrays.
+ * {@code out:java.lang.PrintStream}) in a way that is compatible with
passing String arrays.
*
* @param in the input stream to read from
* @throws IOException if a problem occurs during reading from the
underlying stream
@@ -274,9 +274,9 @@ public class CpBands extends BandSet {
* Parses the constant pool signature classes, using {@link
#cpSignatureCount} to populate {@link #cpSignature}. A
* signature form is akin to the bytecode representation of a class; Z for
boolean, I for int, [ for array etc.
* However, although classes are started with L, the classname does not
follow the form; instead, there is a
- * separate array of classes. So an array corresponding to <code>public
static void main(String args[])</code> has a
- * form of <code>[L(V)</code> and a classes array of
<code>[java.lang.String]</code>. The {@link #cpSignature} is a
- * string representation identical to the bytecode equivalent
<code>[Ljava/lang/String;(V)</code> TODO Check that
+ * separate array of classes. So an array corresponding to {@code public
static void main(String args[])} has a
+ * form of {@code [L(V)} and a classes array of {@code
[java.lang.String]}. The {@link #cpSignature} is a
+ * string representation identical to the bytecode equivalent {@code
[Ljava/lang/String;(V)} TODO Check that
* the form is as above and update other types e.g. J
*
* @param in the input stream to read from
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
index 8713845..d800897 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentHeader.java
@@ -308,7 +308,7 @@ public class SegmentHeader {
* @param name the name of the scalar (primarily for logging/debugging
purposes)
* @param in the input stream to read from
* @param codec the codec for this scalar
- * @return an array of decoded <code>long[]</code> values
+ * @return an array of decoded {@code long[]} values
* @throws IOException if there is a problem reading from the underlying
input stream
* @throws Pack200Exception if there is a problem decoding the value or
that the value is invalid
*/
diff --git a/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
b/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
index f6b9cc8..7a49133 100644
--- a/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
+++ b/src/main/java/org/apache/commons/compress/utils/CharsetNames.java
@@ -30,17 +30,17 @@ package org.apache.commons.compress.utils;
* </p>
*
* <dl>
- * <dt><code>US-ASCII</code></dt>
+ * <dt>{@code US-ASCII}</dt>
* <dd>Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
Unicode character set.</dd>
- * <dt><code>ISO-8859-1</code></dt>
+ * <dt>{@code ISO-8859-1}</dt>
* <dd>ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</dd>
- * <dt><code>UTF-8</code></dt>
+ * <dt>{@code UTF-8}</dt>
* <dd>Eight-bit Unicode Transformation Format.</dd>
- * <dt><code>UTF-16BE</code></dt>
+ * <dt>{@code UTF-16BE}</dt>
* <dd>Sixteen-bit Unicode Transformation Format, big-endian byte order.</dd>
- * <dt><code>UTF-16LE</code></dt>
+ * <dt>{@code UTF-16LE}</dt>
* <dd>Sixteen-bit Unicode Transformation Format, little-endian byte
order.</dd>
- * <dt><code>UTF-16</code></dt>
+ * <dt>{@code UTF-16}</dt>
* <dd>Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either order
* accepted on input, big-endian used on output.)</dd>
* </dl>
diff --git a/src/main/java/org/apache/commons/compress/utils/Charsets.java
b/src/main/java/org/apache/commons/compress/utils/Charsets.java
index 7f5d0bf..f446654 100644
--- a/src/main/java/org/apache/commons/compress/utils/Charsets.java
+++ b/src/main/java/org/apache/commons/compress/utils/Charsets.java
@@ -33,17 +33,17 @@ import java.nio.charset.StandardCharsets;
* </p>
*
* <dl>
- * <dt><code>US-ASCII</code></dt>
+ * <dt>{@code US-ASCII}</dt>
* <dd>Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the
Unicode character set.</dd>
- * <dt><code>ISO-8859-1</code></dt>
+ * <dt>{@code ISO-8859-1}</dt>
* <dd>ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</dd>
- * <dt><code>UTF-8</code></dt>
+ * <dt>{@code UTF-8}</dt>
* <dd>Eight-bit Unicode Transformation Format.</dd>
- * <dt><code>UTF-16BE</code></dt>
+ * <dt>{@code UTF-16BE}</dt>
* <dd>Sixteen-bit Unicode Transformation Format, big-endian byte order.</dd>
- * <dt><code>UTF-16LE</code></dt>
+ * <dt>{@code UTF-16LE}</dt>
* <dd>Sixteen-bit Unicode Transformation Format, little-endian byte
order.</dd>
- * <dt><code>UTF-16</code></dt>
+ * <dt>{@code UTF-16}</dt>
* <dd>Sixteen-bit Unicode Transformation Format, byte order specified by a
mandatory initial byte-order mark (either order
* accepted on input, big-endian used on output.)</dd>
* </dl>
diff --git a/src/main/java/org/apache/commons/compress/utils/IOUtils.java
b/src/main/java/org/apache/commons/compress/utils/IOUtils.java
index d07f3d8..a043b8e 100644
--- a/src/main/java/org/apache/commons/compress/utils/IOUtils.java
+++ b/src/main/java/org/apache/commons/compress/utils/IOUtils.java
@@ -239,12 +239,12 @@ public final class IOUtils {
// Assuming our copy() works just as well as theirs! :-)
/**
- * Gets the contents of an <code>InputStream</code> as a
<code>byte[]</code>.
+ * Gets the contents of an {@code InputStream} as a {@code byte[]}.
* <p>
* This method buffers the input internally, so there is no need to use a
- * <code>BufferedInputStream</code>.
+ * {@code BufferedInputStream}.
*
- * @param input the <code>InputStream</code> to read from
+ * @param input the {@code InputStream} to read from
* @return the requested byte array
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
@@ -335,9 +335,9 @@ public final class IOUtils {
}
/**
- * Gets part of the contents of an <code>InputStream</code> as a
<code>byte[]</code>.
+ * Gets part of the contents of an {@code InputStream} as a {@code byte[]}.
*
- * @param input the <code>InputStream</code> to read from
+ * @param input the {@code InputStream} to read from
* @param len
* maximum amount of bytes to copy
* @return the requested byte array
@@ -352,9 +352,9 @@ public final class IOUtils {
}
/**
- * Gets part of the contents of an <code>ReadableByteChannel</code> as a
<code>byte[]</code>.
+ * Gets part of the contents of an {@code ReadableByteChannel} as a {@code
byte[]}.
*
- * @param input the <code>ReadableByteChannel</code> to read from
+ * @param input the {@code ReadableByteChannel} to read from
* @param len
* maximum amount of bytes to copy
* @return the requested byte array
diff --git
a/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStreamTest.java
b/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStreamTest.java
index 296b4ec..5b817ca 100644
---
a/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStreamTest.java
+++
b/src/test/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStreamTest.java
@@ -268,8 +268,8 @@ public class ZipArchiveInputStreamTest {
}
/**
- * <code>getNextZipEntry()</code> should throw a <code>ZipException</code>
rather than return
- * <code>null</code> when an unexpected structure is encountered.
+ * {@code getNextZipEntry()} should throw a {@code ZipException} rather
than return
+ * {@code null} when an unexpected structure is encountered.
*/
@Test
public void testThrowOnInvalidEntry() throws Exception {
