Package org.apache.hadoop.hbase.util

Class AbstractPositionedByteRange

java.lang.Object

org.apache.hadoop.hbase.util.AbstractByteRange

org.apache.hadoop.hbase.util.AbstractPositionedByteRange

All Implemented Interfaces:

Comparable<ByteRange>, ByteRange, PositionedByteRange

Direct Known Subclasses:

SimplePositionedByteRange, SimplePositionedMutableByteRange

@Private
@Evolving
public abstract class AbstractPositionedByteRange
extends AbstractByteRange
implements PositionedByteRange

Extends the basic SimpleByteRange implementation with position support. position is considered transient, not fundamental to the definition of the range, and does not participate in AbstractByteRange.compareTo(ByteRange), AbstractByteRange.hashCode(), or AbstractByteRange.equals(Object). Position is retained by copy operations.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	limit
protected int	position	The current index into the range.

Fields inherited from class org.apache.hadoop.hbase.util.AbstractByteRange

bytes, hash, length, offset, UNSET_HASH_VALUE

Constructor Summary

Constructors

Constructor	Description
AbstractPositionedByteRange()

Method Summary

Modifier and Type	Method	Description
byte	get()	Retrieve the next byte from this range.
PositionedByteRange	get(byte[] dst)	Fill dst with bytes from the range, starting from position.
PositionedByteRange	get(byte[] dst, int offset, int length)	Fill dst with bytes from the range, starting from the current position.
PositionedByteRange	get(int index, byte[] dst)	Fill dst with bytes from the range, starting from index.
PositionedByteRange	get(int index, byte[] dst, int offset, int length)	Fill dst with bytes from the range, starting from index.
int	getInt()	Retrieve the next int value from this range.
int	getLimit()	Return the current limit
long	getLong()	Retrieve the next long value from this range.
int	getPosition()	The current position marker.
int	getRemaining()	The number of bytes remaining between position and the end of the range.
short	getShort()	Retrieve the next short value from this range.
long	getVLong()	Retrieve the next long value, which is stored as VLong, from this range
byte	peek()	Retrieve the next byte from this range without incrementing position.
PositionedByteRange	set(byte[] bytes)	Reuse this ByteRange over a new byte[].
PositionedByteRange	set(byte[] bytes, int offset, int length)	Reuse this ByteRange over a new byte[].
PositionedByteRange	set(int capacity)	Reuse this ByteRange over a new byte[].
PositionedByteRange	setLength(int length)	Update the length of this range.
PositionedByteRange	setLimit(int limit)	Limits the byte range upto a specified value.
PositionedByteRange	setOffset(int offset)	Update the beginning of this range.
PositionedByteRange	setPosition(int position)	Update the position index.

Methods inherited from class org.apache.hadoop.hbase.util.AbstractByteRange

clearHashCache, compareTo, deepCopySubRangeTo, deepCopyTo, deepCopyToNewArray, equals, get, getBytes, getInt, getLength, getLong, getOffset, getShort, getVLong, getVLongSize, hashCode, isEmpty, isEmpty, isHashCached, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.util.ByteRange

deepCopySubRangeTo, deepCopyTo, deepCopyToNewArray, get, getBytes, getInt, getLength, getLong, getOffset, getShort, getVLong, isEmpty, putVLong

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apache.hadoop.hbase.util.PositionedByteRange

deepCopy, put, put, put, put, put, put, putInt, putInt, putLong, putLong, putShort, putShort, putVLong, shallowCopy, shallowCopySubRange, unset

Field Details

position

protected int position

The current index into the range. Like ByteBuffer position, it points to the next value that will be read/written in the array. It provides the appearance of being 0-indexed, even though its value is calculated according to offset.

Position is considered transient and does not participate in AbstractByteRange.equals(Object) or AbstractByteRange.hashCode() comparisons.

limit

protected int limit

Constructor Details

AbstractPositionedByteRange

public AbstractPositionedByteRange()

Method Details

set

public PositionedByteRange set(int capacity)

Description copied from interface: ByteRange

Reuse this ByteRange over a new byte[]. offset is set to 0 and length is set to capacity.

Specified by:

set in interface ByteRange

Specified by:

set in interface PositionedByteRange

Overrides:

set in class AbstractByteRange

Parameters:

capacity - the size of a new byte[].

set

public PositionedByteRange set(byte[] bytes)

Description copied from interface: ByteRange

Reuse this ByteRange over a new byte[]. offset is set to 0 and length is set to bytes.length. A null bytes IS supported, in which case this method will behave equivalently to ByteRange.unset().

Specified by:

set in interface ByteRange

Specified by:

set in interface PositionedByteRange

Overrides:

set in class AbstractByteRange

Parameters:

bytes - the array to wrap.

set

public PositionedByteRange set(byte[] bytes,
 int offset,
 int length)

Description copied from interface: ByteRange

Reuse this ByteRange over a new byte[]. A null bytes IS supported, in which case this method will behave equivalently to ByteRange.unset(), regardless of the values of offset and length.

Specified by:

set in interface ByteRange

Specified by:

set in interface PositionedByteRange

Overrides:

set in class AbstractByteRange

Parameters:

bytes - The array to wrap.

offset - The offset into bytes considered the beginning of this range.

length - The length of this range.

Returns:

this.

setOffset

public PositionedByteRange setOffset(int offset)

Update the beginning of this range. offset + length may not be greater than bytes.length. Resets position to 0. the new start of this range.

Specified by:

setOffset in interface ByteRange

Specified by:

setOffset in interface PositionedByteRange

Overrides:

setOffset in class AbstractByteRange

Parameters:

offset - the new start of this range.

Returns:

this.

setLength

public PositionedByteRange setLength(int length)

Update the length of this range. offset + length should not be greater than bytes.length. If position is greater than the new length, sets position to length. The new length of this range.

Specified by:

setLength in interface ByteRange

Specified by:

setLength in interface PositionedByteRange

Overrides:

setLength in class AbstractByteRange

Parameters:

length - The new length of this range.

Returns:

this.

getPosition

public int getPosition()

Description copied from interface: PositionedByteRange

The current position marker. This valuae is 0-indexed, relative to the beginning of the range.

Specified by:

getPosition in interface PositionedByteRange

setPosition

public PositionedByteRange setPosition(int position)

Description copied from interface: PositionedByteRange

Update the position index. May not be greater than length.

Specified by:

setPosition in interface PositionedByteRange

Parameters:

position - the new position in this range.

Returns:

this.

getRemaining

public int getRemaining()

Description copied from interface: PositionedByteRange

The number of bytes remaining between position and the end of the range.

Specified by:

getRemaining in interface PositionedByteRange

peek

public byte peek()

Description copied from interface: PositionedByteRange

Retrieve the next byte from this range without incrementing position.

Specified by:

peek in interface PositionedByteRange

get

public byte get()

Description copied from interface: PositionedByteRange

Retrieve the next byte from this range.

Specified by:

get in interface PositionedByteRange

get

public PositionedByteRange get(byte[] dst)

Description copied from interface: PositionedByteRange

Fill dst with bytes from the range, starting from position. This range's position is incremented by the length of dst, the number of bytes copied.

Specified by:

get in interface PositionedByteRange

Parameters:

dst - the destination of the copy.

Returns:

this.

get

public PositionedByteRange get(byte[] dst,
 int offset,
 int length)

Description copied from interface: PositionedByteRange

Fill dst with bytes from the range, starting from the current position. length bytes are copied into dst, starting at offset. This range's position is incremented by the number of bytes copied.

Specified by:

get in interface PositionedByteRange

Parameters:

dst - the destination of the copy.

offset - the offset into dst to start the copy.

length - the number of bytes to copy into dst.

Returns:

this.

get

public PositionedByteRange get(int index,
 byte[] dst)

Description copied from interface: ByteRange

Fill dst with bytes from the range, starting from index.

Specified by:

get in interface ByteRange

Specified by:

get in interface PositionedByteRange

Overrides:

get in class AbstractByteRange

Parameters:

index - zero-based index into this range.

dst - the destination of the copy.

Returns:

this.

get

public PositionedByteRange get(int index,
 byte[] dst,
 int offset,
 int length)

Description copied from interface: ByteRange

Fill dst with bytes from the range, starting from index. length bytes are copied into dst, starting at offset.

Specified by:

get in interface ByteRange

Specified by:

get in interface PositionedByteRange

Overrides:

get in class AbstractByteRange

Parameters:

index - zero-based index into this range.

dst - the destination of the copy.

offset - the offset into dst to start the copy.

length - the number of bytes to copy into dst.

Returns:

this.

getShort

public short getShort()

Description copied from interface: PositionedByteRange

Retrieve the next short value from this range.

Specified by:

getShort in interface PositionedByteRange

getInt

public int getInt()

Description copied from interface: PositionedByteRange

Retrieve the next int value from this range.

Specified by:

getInt in interface PositionedByteRange

getLong

public long getLong()

Description copied from interface: PositionedByteRange

Retrieve the next long value from this range.

Specified by:

getLong in interface PositionedByteRange

getVLong

public long getVLong()

Description copied from interface: PositionedByteRange

Retrieve the next long value, which is stored as VLong, from this range

Specified by:

getVLong in interface PositionedByteRange

Returns:

the long value which is stored as VLong

setLimit

public PositionedByteRange setLimit(int limit)

Description copied from interface: PositionedByteRange

Limits the byte range upto a specified value. Limit cannot be greater than capacity

Specified by:

setLimit in interface PositionedByteRange

getLimit

public int getLimit()

Description copied from interface: PositionedByteRange

Return the current limit

Specified by:

getLimit in interface PositionedByteRange