bt.data.range

Interface Range<T extends Range<T>>

All Known Subinterfaces:

DataRange

All Known Implementing Classes:

BlockRange, ByteRange, DelegatingDataRange, SynchronizedDataRange, SynchronizedRange

public interface Range<T extends Range<T>>

Represents a range of binary data.

Since:

1.3

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Get all data in this range
boolean	getBytes(ByteBuffer buffer) Read all data in this range to the provided buffer.
Range<T>	getSubrange(long offset) Build a subrange of this data range.
Range<T>	getSubrange(long offset, long length) Build a subrange of this data range.
long	length()
void	putBytes(byte[] block) Put data at the beginning of this range.
void	putBytes(ByteBufferView buffer) Put data from the provided buffer at the beginning of this range.

Method Detail

length

long length()

Returns:

Length of this data range

Since:

1.3

getSubrange

Range<T> getSubrange(long offset,
                     long length)

Build a subrange of this data range.

Parameters:

offset - Offset from the beginning of the original data range in bytes, inclusive

length - Length of the new data range

Returns:

Subrange of the original data range

Since:

1.3

getSubrange

Range<T> getSubrange(long offset)

Build a subrange of this data range.

Parameters:

offset - Offset from the beginning of the original data range in bytes, inclusive

Returns:

Subrange of the original data range

Since:

1.3

getBytes

byte[] getBytes()

Get all data in this range

Returns:

Data in this range

Since:

1.3

getBytes

boolean getBytes(ByteBuffer buffer)

Read all data in this range to the provided buffer. If there is not enough space in the buffer, then no bytes will be read.

Returns:

true, if all data in the range has been read into the buffer

Since:

1.9

putBytes

void putBytes(byte[] block)

Put data at the beginning of this range.

Parameters:

block - Block of data with length less than or equal to length() of this range

Throws:

IllegalArgumentException - if data does not fit in this range

Since:

1.3

putBytes

void putBytes(ByteBufferView buffer)

Put data from the provided buffer at the beginning of this range.

Since:

1.9