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 b1ae23b75 Javadoc
b1ae23b75 is described below
commit b1ae23b75d9db8f7c33a4b426f3043482eec3903
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 14 15:11:50 2024 -0500
Javadoc
---
.../archivers/tar/TarArchiveInputStream.java | 97 +++++++++++-----------
1 file changed, 48 insertions(+), 49 deletions(-)
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 d9bd6b683..25172d1dd 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
@@ -123,73 +123,73 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
private final boolean lenient;
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
+ * @param inputStream the input stream to use
*/
- public TarArchiveInputStream(final InputStream is) {
- this(is, TarConstants.DEFAULT_BLKSIZE, TarConstants.DEFAULT_RCDSIZE);
+ public TarArchiveInputStream(final InputStream inputStream) {
+ this(inputStream, TarConstants.DEFAULT_BLKSIZE,
TarConstants.DEFAULT_RCDSIZE);
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param lenient when set to true illegal values for group/userid, mode,
device numbers and timestamp will be ignored and the fields set to
- * {@link TarArchiveEntry#UNKNOWN}. When set to false such
illegal fields cause an exception instead.
+ * @param inputStream the input stream to use
+ * @param lenient when set to true illegal values for group/userid,
mode, device numbers and timestamp will be ignored and the fields set to
+ * {@link TarArchiveEntry#UNKNOWN}. When set to false
such illegal fields cause an exception instead.
* @since 1.19
*/
- public TarArchiveInputStream(final InputStream is, final boolean lenient) {
- this(is, TarConstants.DEFAULT_BLKSIZE, TarConstants.DEFAULT_RCDSIZE,
null, lenient);
+ public TarArchiveInputStream(final InputStream inputStream, final boolean
lenient) {
+ this(inputStream, TarConstants.DEFAULT_BLKSIZE,
TarConstants.DEFAULT_RCDSIZE, null, lenient);
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param blockSize the block size to use
+ * @param inputStream the input stream to use
+ * @param blockSize the block size to use
*/
- public TarArchiveInputStream(final InputStream is, final int blockSize) {
- this(is, blockSize, TarConstants.DEFAULT_RCDSIZE);
+ public TarArchiveInputStream(final InputStream inputStream, final int
blockSize) {
+ this(inputStream, blockSize, TarConstants.DEFAULT_RCDSIZE);
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param blockSize the block size to use
- * @param recordSize the record size to use
+ * @param inputStream the input stream to use
+ * @param blockSize the block size to use
+ * @param recordSize the record size to use
*/
- public TarArchiveInputStream(final InputStream is, final int blockSize,
final int recordSize) {
- this(is, blockSize, recordSize, null);
+ public TarArchiveInputStream(final InputStream inputStream, final int
blockSize, final int recordSize) {
+ this(inputStream, blockSize, recordSize, null);
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param blockSize the block size to use
- * @param recordSize the record size to use
- * @param encoding name of the encoding to use for file names
+ * @param inputStream the input stream to use
+ * @param blockSize the block size to use
+ * @param recordSize the record size to use
+ * @param encoding name of the encoding to use for file names
* @since 1.4
*/
- public TarArchiveInputStream(final InputStream is, final int blockSize,
final int recordSize, final String encoding) {
- this(is, blockSize, recordSize, encoding, false);
+ public TarArchiveInputStream(final InputStream inputStream, final int
blockSize, final int recordSize, final String encoding) {
+ this(inputStream, blockSize, recordSize, encoding, false);
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param blockSize the block size to use
- * @param recordSize the record size to use
- * @param encoding name of the encoding to use for file names
- * @param lenient when set to true illegal values for group/userid,
mode, device numbers and timestamp will be ignored and the fields set to
- * {@link TarArchiveEntry#UNKNOWN}. When set to false
such illegal fields cause an exception instead.
+ * @param inputStream the input stream to use
+ * @param blockSize the block size to use
+ * @param recordSize the record size to use
+ * @param encoding name of the encoding to use for file names
+ * @param lenient when set to true illegal values for group/userid,
mode, device numbers and timestamp will be ignored and the fields set to
+ * {@link TarArchiveEntry#UNKNOWN}. When set to false
such illegal fields cause an exception instead.
* @since 1.19
*/
- public TarArchiveInputStream(final InputStream is, final int blockSize,
final int recordSize, final String encoding, final boolean lenient) {
- this.inputStream = is;
+ public TarArchiveInputStream(final InputStream inputStream, final int
blockSize, final int recordSize, final String encoding, final boolean lenient) {
+ this.inputStream = inputStream;
this.hasHitEOF = false;
this.encoding = encoding;
this.zipEncoding = ZipEncodingHelper.getZipEncoding(encoding);
@@ -200,26 +200,26 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param blockSize the block size to use
- * @param encoding name of the encoding to use for file names
+ * @param inputStream the input stream to use
+ * @param blockSize the block size to use
+ * @param encoding name of the encoding to use for file names
* @since 1.4
*/
- public TarArchiveInputStream(final InputStream is, final int blockSize,
final String encoding) {
- this(is, blockSize, TarConstants.DEFAULT_RCDSIZE, encoding);
+ public TarArchiveInputStream(final InputStream inputStream, final int
blockSize, final String encoding) {
+ this(inputStream, blockSize, TarConstants.DEFAULT_RCDSIZE, encoding);
}
/**
- * Constructor for TarInputStream.
+ * Constructs a new instance.
*
- * @param is the input stream to use
- * @param encoding name of the encoding to use for file names
+ * @param inputStream the input stream to use
+ * @param encoding name of the encoding to use for file names
* @since 1.4
*/
- public TarArchiveInputStream(final InputStream is, final String encoding) {
- this(is, TarConstants.DEFAULT_BLKSIZE, TarConstants.DEFAULT_RCDSIZE,
encoding);
+ public TarArchiveInputStream(final InputStream inputStream, final String
encoding) {
+ this(inputStream, TarConstants.DEFAULT_BLKSIZE,
TarConstants.DEFAULT_RCDSIZE, encoding);
}
private void applyPaxHeadersToCurrentEntry(final Map<String, String>
headers, final List<TarArchiveStructSparse> sparseHeaders) throws IOException {
@@ -240,7 +240,6 @@ public class TarArchiveInputStream extends
ArchiveInputStream<TarArchiveEntry> {
if (isDirectory()) {
return 0;
}
-
if (currEntry.getRealSize() - entryOffset > Integer.MAX_VALUE) {
return Integer.MAX_VALUE;
}
