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
commit 8c32109021de0fe42b76a9f86811fb6921b6e9d6
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jan 17 10:16:09 2024 -0500
Javadoc
---
.../compress/archivers/dump/DumpArchiveEntry.java | 20 ++++++++++----------
.../archivers/dump/DumpArchiveInputStream.java | 12 ++++++------
.../compress/archivers/zip/StreamCompressor.java | 2 +-
.../commons/compress/compressors/bzip2/Rand.java | 2 +-
4 files changed, 18 insertions(+), 18 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
index c75bae350..48f93df9e 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
@@ -442,7 +442,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the generation of the file.
+ * Gets the generation of the file.
*
* @return the generation
*/
@@ -451,7 +451,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the group id
+ * Gets the group id
*
* @return the group id
*/
@@ -460,7 +460,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the number of records in this segment.
+ * Gets the number of records in this segment.
*
* @return the number of records
*/
@@ -469,7 +469,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the number of sparse records in this segment.
+ * Gets the number of sparse records in this segment.
*
* @return the number of sparse records
*/
@@ -478,7 +478,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the type of the tape segment header.
+ * Gets the type of the tape segment header.
*
* @return the segment header
*/
@@ -506,7 +506,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the access permissions on the entry.
+ * Gets the access permissions on the entry.
*
* @return the access permissions
*/
@@ -529,7 +529,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the number of hard links to the entry.
+ * Gets the number of hard links to the entry.
*
* @return the number of hard links
*/
@@ -538,7 +538,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the offset within the archive
+ * Gets the offset within the archive
*
* @return the offset
*/
@@ -593,7 +593,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the user id.
+ * Gets the user id.
*
* @return the user id
*/
@@ -602,7 +602,7 @@ public class DumpArchiveEntry implements ArchiveEntry {
}
/**
- * Return the tape volume where this file is located.
+ * Gets the tape volume where this file is located.
*
* @return the volume
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
index 82454c6e4..f76df65d2 100644
---
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
+++
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
@@ -37,10 +37,10 @@ import org.apache.commons.compress.utils.IOUtils;
/**
* The DumpArchiveInputStream reads a UNIX dump archive as an InputStream.
Methods are provided to position at each successive entry in the archive, and
the
* read each entry as a normal input stream using read().
- *
+ * <p>
* There doesn't seem to exist a hint on the encoding of string values in any
piece documentation. Given the main purpose of dump/restore is backing up a
system
* it seems very likely the format uses the current default encoding of the
system.
- *
+ * </p>
* @NotThreadSafe
*/
public class DumpArchiveInputStream extends
ArchiveInputStream<DumpArchiveEntry> {
@@ -85,13 +85,13 @@ public class DumpArchiveInputStream extends
ArchiveInputStream<DumpArchiveEntry>
protected TapeInputStream raw;
- // map of ino -> dirent entry. We can use this to reconstruct full paths.
+ /** Map of ino -> dirent entry. We can use this to reconstruct full paths.
*/
private final Map<Integer, Dirent> names = new HashMap<>();
- // map of ino -> (directory) entry when we're missing one or more elements
in the path.
+ /** Map of ino -> (directory) entry when we're missing one or more
elements in the path. */
private final Map<Integer, DumpArchiveEntry> pending = new HashMap<>();
- // queue of (directory) entries where we now have the full path.
+ /** Queue of (directory) entries where we now have the full path. */
private final Queue<DumpArchiveEntry> queue;
/**
@@ -331,7 +331,7 @@ public class DumpArchiveInputStream extends
ArchiveInputStream<DumpArchiveEntry>
}
/**
- * Return the archive summary information.
+ * Gets the archive summary information.
*
* @return the summary
*/
diff --git
a/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
b/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
index c2bd12047..7cd92f21c 100644
---
a/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
+++
b/src/main/java/org/apache/commons/compress/archivers/zip/StreamCompressor.java
@@ -232,7 +232,7 @@ public abstract class StreamCompressor implements Closeable
{
}
/**
- * Return the number of bytes read from the source stream
+ * Gets the number of bytes read from the source stream
*
* @return The number of bytes read, never negative
*/
diff --git
a/src/main/java/org/apache/commons/compress/compressors/bzip2/Rand.java
b/src/main/java/org/apache/commons/compress/compressors/bzip2/Rand.java
index ec673b517..ed9a7a3bb 100644
--- a/src/main/java/org/apache/commons/compress/compressors/bzip2/Rand.java
+++ b/src/main/java/org/apache/commons/compress/compressors/bzip2/Rand.java
@@ -44,7 +44,7 @@ final class Rand {
197, 510, 357, 358, 850, 858, 364, 936, 638 };
/**
- * Return the random number at a specific index.
+ * Gets the random number at a specific index.
*
* @param i the index
* @return the random number
