(commons-compress) 05/06: Javadoc

[ggregory]

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 987c0c47015d7d3a287ffa783185398be3eef964
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Apr 9 10:13:23 2025 -0400

    Javadoc
---
 .../archivers/tar/TarArchiveStructSparse.java      | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git 
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
 
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
index 0fbb06fca..d7e5008dd 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveStructSparse.java
@@ -38,15 +38,21 @@ public final class TarArchiveStructSparse {
     private final long offset;
     private final long numbytes;
 
-    public TarArchiveStructSparse(final long offset, final long numbytes) {
+    /**
+     * Constructs a new instance.
+     *
+     * @param offset An offset greater or equal to zero.
+     * @param numBytes An count greater or equal to zero.
+     */
+    public TarArchiveStructSparse(final long offset, final long numBytes) {
         if (offset < 0) {
             throw new IllegalArgumentException("offset must not be negative");
         }
-        if (numbytes < 0) {
+        if (numBytes < 0) {
             throw new IllegalArgumentException("numbytes must not be 
negative");
         }
         this.offset = offset;
-        this.numbytes = numbytes;
+        this.numbytes = numBytes;
     }
 
     @Override
@@ -61,10 +67,20 @@ public boolean equals(final Object o) {
         return offset == that.offset && numbytes == that.numbytes;
     }
 
+    /**
+     * Gets the byte count.
+     *
+     * @return the byte count.
+     */
     public long getNumbytes() {
         return numbytes;
     }
 
+    /**
+     * Gets the offset.
+     *
+     * @return the offset.
+     */
     public long getOffset() {
         return offset;
     }