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 acd8ffccd Javadoc acd8ffccd is described below commit acd8ffccdc9b416d58a496c9feb550353a92ea91 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sun Jan 14 15:38:32 2024 -0500 Javadoc --- .../commons/compress/utils/SeekableInMemoryByteChannel.java | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java b/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java index c993d433a..1f7496e2e 100644 --- a/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java +++ b/src/main/java/org/apache/commons/compress/utils/SeekableInMemoryByteChannel.java @@ -26,7 +26,6 @@ import java.util.concurrent.atomic.AtomicBoolean; /** * A {@link SeekableByteChannel} implementation that wraps a byte[]. - * * <p> * When this channel is used for writing an internal buffer grows to accommodate incoming data. The natural size limit is the value of {@link Integer#MAX_VALUE} * and it is not possible to {@link #position(long) set the position} or {@link #truncate truncate} to a value bigger than that. Internal buffer can be accessed @@ -45,15 +44,14 @@ public class SeekableInMemoryByteChannel implements SeekableByteChannel { private int position, size; /** - * Parameterless constructor - allocates internal buffer by itself. + * Constructs a new instance using a default empty buffer. */ public SeekableInMemoryByteChannel() { this(ByteUtils.EMPTY_BYTE_ARRAY); } /** - * Constructor taking a byte array. - * + * Constructs a new instance from a byte array. * <p> * This constructor is intended to be used with pre-allocated buffer or when reading from a given byte array. * </p> @@ -66,8 +64,7 @@ public class SeekableInMemoryByteChannel implements SeekableByteChannel { } /** - * Constructor taking a size of storage to be allocated. - * + * Constructs a new instance from a size of storage to be allocated. * <p> * Creates a channel and allocates internal storage of a given size. * </p> @@ -80,7 +77,6 @@ public class SeekableInMemoryByteChannel implements SeekableByteChannel { /** * Obtains the array backing this channel. - * * <p> * NOTE: The returned buffer is not aligned with containing data, use {@link #size()} to obtain the size of data stored in the buffer. * </p> @@ -109,7 +105,6 @@ public class SeekableInMemoryByteChannel implements SeekableByteChannel { /** * Returns 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 called. @@ -163,7 +158,6 @@ public class SeekableInMemoryByteChannel implements SeekableByteChannel { /** * Returns the current size of entity to which this channel is connected. - * * <p> * This method violates the contract of {@link SeekableByteChannel#size} as it will not throw any exception when invoked on a closed channel. Instead it * will return the size the channel had when close has been called. @@ -176,7 +170,6 @@ public class SeekableInMemoryByteChannel implements SeekableByteChannel { /** * Truncates the entity, to which this channel is connected, to the given size. - * * <p> * This method violates the contract of {@link SeekableByteChannel#truncate} as it will not throw any exception when invoked on a closed channel. * </p>