[commons-compress] branch master updated: Javadoc

[gg...@apache.org]

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 b30dc5b9 Javadoc
b30dc5b9 is described below

commit b30dc5b9b1507e9521b9be980a96a19462b8bae8
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Mar 16 16:49:58 2023 -0400

    Javadoc
---
 .../commons/compress/utils/MultiReadOnlySeekableByteChannel.java   | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
index 8dbd9827..487b8e07 100644
--- a/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
+++ b/src/main/java/org/apache/commons/compress/utils/MultiReadOnlySeekableByteChannel.java
@@ -46,6 +46,7 @@ import java.util.Objects;
 public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
 
     private static final Path[] EMPTY_PATH_ARRAY = {};
+
     /**
      * Concatenates the given files.
      *
@@ -62,6 +63,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
 
         return forPaths(paths.toArray(EMPTY_PATH_ARRAY));
     }
+
     /**
      * Concatenates the given file paths.
      * @param paths the file paths to concatenate, note that the LAST FILE of files should be the LAST SEGMENT(.zip)
@@ -83,6 +85,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
         }
         return new MultiReadOnlySeekableByteChannel(channels);
     }
+
     /**
      * Concatenates the given channels.
      *
@@ -137,7 +140,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
     }
 
     /**
-     * Returns this channel's position.
+     * Gets this channel's position.
      *
      * <p>This method violates the contract of {@link SeekableByteChannel#position()} as it will not throw any exception
      * when invoked on a closed channel. Instead it will return the position the channel had when close has been
@@ -190,7 +193,7 @@ public class MultiReadOnlySeekableByteChannel implements SeekableByteChannel {
     }
 
     /**
-     * set the position based on the given channel number and relative offset
+     * Sets the position based on the given channel number and relative offset
      *
      * @param channelNumber  the channel number
      * @param relativeOffset the relative offset in the corresponding channel