Apache Commons Compress 1.26.0 · org.apache.commons.compress.utils.SeekableInMemoryByteChannel

Modifier and Type	Field and Description
private final AtomicBoolean	closed
private byte[]	data
private static final int	NAIVE_RESIZE_LIMIT
private int	position
private int	size

Access	Constructor and Description
public	SeekableInMemoryByteChannel() Constructs a new instance using a default empty buffer.
public	SeekableInMemoryByteChannel(final byte[] input data or pre-allocated array. data) Constructs a new instance from a byte array.
public	SeekableInMemoryByteChannel(final int size of internal buffer to allocate, in bytes. size) Constructs a new instance from a size of storage to be allocated.

Method Summary

Modifier and Type	Method and Description
public byte[]	Returns: internal byte array. array() Obtains the array backing this channel.
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
private void	ensureOpen()
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public long	position() Implements java.nio.channels.SeekableByteChannel.position. Returns this channel's position.
public SeekableByteChannel	position(final long The new position, a non-negative integer counting the number of bytes from the beginning of the entity newPosition) Implements java.nio.channels.SeekableByteChannel.position. Sets this channel's position.
public int	read(final ByteBuffer The buffer into which bytes are to be transferred buf) Implements java.nio.channels.SeekableByteChannel.read. Reads a sequence of bytes from this channel into the given buffer.
private void	resize(final int newLength)
public long	size() Implements java.nio.channels.SeekableByteChannel.size. Returns the current size of entity to which this channel is connected.
public SeekableByteChannel	truncate(final long The new size, a non-negative byte count newSize) Implements java.nio.channels.SeekableByteChannel.truncate. Truncates the entity, to which this channel is connected, to the given size.
public int	write(final ByteBuffer The buffer from which bytes are to be retrieved b) Implements java.nio.channels.SeekableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

closed	back to summary
private final AtomicBoolean closed

data	back to summary
private byte[] data

NAIVE_RESIZE_LIMIT	back to summary
private static final int NAIVE_RESIZE_LIMIT

position	back to summary
private int position

size	back to summary
private int size

SeekableInMemoryByteChannel	back to summary
public SeekableInMemoryByteChannel() Constructs a new instance using a default empty buffer.

SeekableInMemoryByteChannel	back to summary
public SeekableInMemoryByteChannel(final byte[] data) Constructs a new instance from a byte array. This constructor is intended to be used with pre-allocated buffer or when reading from a given byte array. Parameters data:byte[] input data or pre-allocated array.

SeekableInMemoryByteChannel	back to summary
public SeekableInMemoryByteChannel(final int size) Constructs a new instance from a size of storage to be allocated. Creates a channel and allocates internal storage of a given size. Parameters size:int size of internal buffer to allocate, in bytes.

Method Detail

array back to summary

array	back to summary
public byte[] array() Obtains the array backing this channel. Note The returned buffer is not aligned with containing data, use `size()` to obtain the size of data stored in the buffer. Returns:byte[] internal byte array.

public byte[] array()

Obtains the array backing this channel.

Note

The returned buffer is not aligned with containing data, use size() to obtain the size of data stored in the buffer.

Returns:byte[]: internal byte array.

close back to summary

close	back to summary
public void close() Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override

public void close()

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

ensureOpen	back to summary
private void ensureOpen() throws ClosedChannelException

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

position back to summary

position	back to summary
public long position() Implements java.nio.channels.SeekableByteChannel.position. Returns this channel's position. This method violates the contract of `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. Returns:long Doc from java.nio.channels.SeekableByteChannel.position. This channel's position, a non-negative integer counting the number of bytes from the beginning of the entity to the current position Annotations @Override

public long position()

Implements java.nio.channels.SeekableByteChannel.position.

Returns this channel's position.

This method violates the contract of 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.

Returns:long

Doc from java.nio.channels.SeekableByteChannel.position.

This channel's position, a non-negative integer counting the number of bytes from the beginning of the entity to the current position

Annotations

@Override

position back to summary

position	back to summary
public SeekableByteChannel position(final long newPosition) throws IOException Implements java.nio.channels.SeekableByteChannel.position. Doc from java.nio.channels.SeekableByteChannel.position. Sets this channel's position. Setting the position to a value that is greater than the current size is legal but does not change the size of the entity. A later attempt to read bytes at such a position will immediately return an end-of-file indication. A later attempt to write bytes at such a position will cause the entity to grow to accommodate the new bytes; the values of any bytes between the previous end-of-file and the newly-written bytes are unspecified. Setting the channel's position is not recommended when connected to an entity, typically a file, that is opened with the `APPEND` option. When opened for append, the position is first advanced to the end before writing. Parameters newPosition:long The new position, a non-negative integer counting the number of bytes from the beginning of the entity Returns:SeekableByteChannel This channel Annotations @Override Exceptions IOException: If some other I/O error occurs

public SeekableByteChannel position(final long newPosition) throws IOException

Implements java.nio.channels.SeekableByteChannel.position.

Doc from java.nio.channels.SeekableByteChannel.position.

Sets this channel's position.

Setting the position to a value that is greater than the current size is legal but does not change the size of the entity. A later attempt to read bytes at such a position will immediately return an end-of-file indication. A later attempt to write bytes at such a position will cause the entity to grow to accommodate the new bytes; the values of any bytes between the previous end-of-file and the newly-written bytes are unspecified.

Setting the channel's position is not recommended when connected to an entity, typically a file, that is opened with the APPEND option. When opened for append, the position is first advanced to the end before writing.

Parameters

newPosition:long: The new position, a non-negative integer counting the number of bytes from the beginning of the entity

Returns:SeekableByteChannel

This channel

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

read back to summary

read	back to summary
public int read(final ByteBuffer buf) throws IOException Implements java.nio.channels.SeekableByteChannel.read. Doc from java.nio.channels.SeekableByteChannel.read. Reads a sequence of bytes from this channel into the given buffer. Bytes are read starting at this channel's current position, and then the position is updated with the number of bytes actually read. Otherwise this method behaves exactly as specified in the `ReadableByteChannel` interface. Parameters buf:ByteBuffer Doc from java.nio.channels.ReadableByteChannel.read. The buffer into which bytes are to be transferred Returns:int Doc from java.nio.channels.ReadableByteChannel.read. The number of bytes read, possibly zero, or `-1` if the channel has reached end-of-stream Annotations @Override Exceptions IOException: Doc from java.nio.channels.ReadableByteChannel.read. If some other I/O error occurs

public int read(final ByteBuffer buf) throws IOException

Implements java.nio.channels.SeekableByteChannel.read.

Doc from java.nio.channels.SeekableByteChannel.read.

Reads a sequence of bytes from this channel into the given buffer.

Bytes are read starting at this channel's current position, and then the position is updated with the number of bytes actually read. Otherwise this method behaves exactly as specified in the ReadableByteChannel interface.

Parameters

buf:ByteBuffer

Doc from java.nio.channels.ReadableByteChannel.read.

The buffer into which bytes are to be transferred

Returns:int

Doc from java.nio.channels.ReadableByteChannel.read.

The number of bytes read, possibly zero, or -1 if the channel has reached end-of-stream

Annotations

@Override

Exceptions

IOException:

Doc from java.nio.channels.ReadableByteChannel.read.

If some other I/O error occurs

resize	back to summary
private void resize(final int newLength)

size back to summary

size	back to summary
public long size() Implements java.nio.channels.SeekableByteChannel.size. Returns the current size of entity to which this channel is connected. This method violates the contract of `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. Returns:long Doc from java.nio.channels.SeekableByteChannel.size. The current size, measured in bytes Annotations @Override

public long size()

Implements java.nio.channels.SeekableByteChannel.size.

Returns the current size of entity to which this channel is connected.

This method violates the contract of 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.

Returns:long

Doc from java.nio.channels.SeekableByteChannel.size.

The current size, measured in bytes

Annotations

@Override

truncate back to summary

truncate	back to summary
public SeekableByteChannel truncate(final long newSize) Implements java.nio.channels.SeekableByteChannel.truncate. Truncates the entity, to which this channel is connected, to the given size. This method violates the contract of `SeekableByteChannel#truncate` as it will not throw any exception when invoked on a closed channel. Parameters newSize:long Doc from java.nio.channels.SeekableByteChannel.truncate. The new size, a non-negative byte count Returns:SeekableByteChannel Doc from java.nio.channels.SeekableByteChannel.truncate. This channel Annotations @Override Exceptions IllegalArgumentException: if size is negative or bigger than the maximum of a Java integer

public SeekableByteChannel truncate(final long newSize)

Implements java.nio.channels.SeekableByteChannel.truncate.

Truncates the entity, to which this channel is connected, to the given size.

This method violates the contract of SeekableByteChannel#truncate as it will not throw any exception when invoked on a closed channel.

Parameters

newSize:long

Doc from java.nio.channels.SeekableByteChannel.truncate.

The new size, a non-negative byte count

Returns:SeekableByteChannel

Doc from java.nio.channels.SeekableByteChannel.truncate.

This channel

Annotations

@Override

Exceptions

IllegalArgumentException:: if size is negative or bigger than the maximum of a Java integer

write back to summary

write	back to summary
public int write(final ByteBuffer b) throws IOException Implements java.nio.channels.SeekableByteChannel.write. Doc from java.nio.channels.SeekableByteChannel.write. Writes a sequence of bytes to this channel from the given buffer. Bytes are written starting at this channel's current position, unless the channel is connected to an entity such as a file that is opened with the `APPEND` option, in which case the position is first advanced to the end. The entity to which the channel is connected is grown, if necessary, to accommodate the written bytes, and then the position is updated with the number of bytes actually written. Otherwise this method behaves exactly as specified by the `WritableByteChannel` interface. Parameters b:ByteBuffer Doc from java.nio.channels.WritableByteChannel.write. The buffer from which bytes are to be retrieved Returns:int Doc from java.nio.channels.WritableByteChannel.write. The number of bytes written, possibly zero Annotations @Override Exceptions IOException: Doc from java.nio.channels.WritableByteChannel.write. If some other I/O error occurs

public int write(final ByteBuffer b) throws IOException

Implements java.nio.channels.SeekableByteChannel.write.

Doc from java.nio.channels.SeekableByteChannel.write.

Writes a sequence of bytes to this channel from the given buffer.

Bytes are written starting at this channel's current position, unless the channel is connected to an entity such as a file that is opened with the APPEND option, in which case the position is first advanced to the end. The entity to which the channel is connected is grown, if necessary, to accommodate the written bytes, and then the position is updated with the number of bytes actually written. Otherwise this method behaves exactly as specified by the WritableByteChannel interface.

Parameters

b:ByteBuffer

Doc from java.nio.channels.WritableByteChannel.write.

The buffer from which bytes are to be retrieved

Returns:int