AbstractPositionedByteRange (Apache HBase 2.1.0-cdh6.3.2 API)

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
```
@InterfaceAudience.Private
 @InterfaceStability.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 and 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

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

Constructor Summary

Constructors
Constructor and Description

AbstractPositionedByteRange()

Constructors
Constructor and Description
`AbstractPositionedByteRange()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract PositionedByteRange`	`deepCopy()` Create a new `ByteRange` with new backing byte[] containing a copy of the content from `this` range's window.
`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.
`abstract PositionedByteRange`	`put(byte val)` Store `val` at the next position in this range.
`abstract PositionedByteRange`	`put(byte[] val)` Store the content of `val` in this range, starting at the next position.
`abstract PositionedByteRange`	`put(byte[] val, int offset, int length)` Store `length` bytes from `val` into this range.
`abstract PositionedByteRange`	`put(int index, byte val)` Store `val` at `index`.
`abstract PositionedByteRange`	`put(int index, byte[] val)` Store `val` at `index`.
`abstract PositionedByteRange`	`put(int index, byte[] val, int offset, int length)` Store `length` bytes from `val` into this range, starting at `index`.
`abstract PositionedByteRange`	`putInt(int val)` Store int `val` at the next position in this range.
`abstract PositionedByteRange`	`putInt(int index, int val)` Store the int value at `index`
`abstract PositionedByteRange`	`putLong(int index, long val)` Store the long value at `index`
`abstract PositionedByteRange`	`putLong(long val)` Store long `val` at the next position in this range.
`abstract PositionedByteRange`	`putShort(int index, short val)` Store the short value at `index`
`abstract PositionedByteRange`	`putShort(short val)` Store short `val` at the next position in this range.
`abstract int`	`putVLong(int index, long val)` Store the long value at `index` as a VLong
`abstract int`	`putVLong(long val)` Store the long `val` at the next position as a VLong
`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.
`abstract PositionedByteRange`	`shallowCopy()` Create a new `ByteRange` that points at this range's byte[].
`abstract PositionedByteRange`	`shallowCopySubRange(int innerOffset, int copyLength)` Create a new `ByteRange` that points at this range's byte[].
`abstract PositionedByteRange`	`unset()` Nullifies this ByteRange.

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

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - 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 Detail
  - AbstractPositionedByteRange
```
public AbstractPositionedByteRange()
```
- Method Detail
  - unset
```
public abstract PositionedByteRange unset()
```
    Description copied from interface: ByteRange
    
    Nullifies this ByteRange. That is, it becomes a husk, being a range over no byte[] whatsoever.
    
    Specified by:
    
    unset in interface ByteRange
    
    Specified by:
    
    unset in interface PositionedByteRange
    
    Specified by:
    
    unset in class AbstractByteRange
    
    Returns:
    
    this
  - 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[].
    
    Returns:
    
    this
  - 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.
    
    Returns:
    
    this
  - 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.
    
    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.
    
    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.
  - put
```
public abstract PositionedByteRange put(byte val)
```
    Description copied from interface: PositionedByteRange
    
    Store val at the next position in this range.
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Parameters:
    
    val - the new value.
    
    Returns:
    
    this.
  - put
```
public abstract PositionedByteRange put(byte[] val)
```
    Description copied from interface: PositionedByteRange
    
    Store the content of val in this range, starting at the next position.
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Parameters:
    
    val - the new value.
    
    Returns:
    
    this.
  - put
```
public abstract PositionedByteRange put(byte[] val,
                                        int offset,
                                        int length)
```
    Description copied from interface: PositionedByteRange
    
    Store length bytes from val into this range. Bytes from val are copied starting at offset into the range, starting at the current position.
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Parameters:
    
    val - the new value.
    
    offset - the offset in val from which to start copying.
    
    length - the number of bytes to copy from val.
    
    Returns:
    
    this.
  - putInt
```
public abstract PositionedByteRange putInt(int index,
                                           int val)
```
    Description copied from interface: ByteRange
    
    Store the int value at index
    
    Specified by:
    
    putInt in interface ByteRange
    
    Specified by:
    
    putInt in interface PositionedByteRange
    
    Specified by:
    
    putInt in class AbstractByteRange
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store
    
    Returns:
    
    this
  - putLong
```
public abstract PositionedByteRange putLong(int index,
                                            long val)
```
    Description copied from interface: ByteRange
    
    Store the long value at index
    
    Specified by:
    
    putLong in interface ByteRange
    
    Specified by:
    
    putLong in interface PositionedByteRange
    
    Specified by:
    
    putLong in class AbstractByteRange
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store
    
    Returns:
    
    this
  - putShort
```
public abstract PositionedByteRange putShort(int index,
                                             short val)
```
    Description copied from interface: ByteRange
    
    Store the short value at index
    
    Specified by:
    
    putShort in interface ByteRange
    
    Specified by:
    
    putShort in interface PositionedByteRange
    
    Specified by:
    
    putShort in class AbstractByteRange
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store
    
    Returns:
    
    this
  - putInt
```
public abstract PositionedByteRange putInt(int val)
```
    Description copied from interface: PositionedByteRange
    
    Store int val at the next position in this range.
    
    Specified by:
    
    putInt in interface PositionedByteRange
    
    Parameters:
    
    val - the new value.
    
    Returns:
    
    this.
  - putLong
```
public abstract PositionedByteRange putLong(long val)
```
    Description copied from interface: PositionedByteRange
    
    Store long val at the next position in this range.
    
    Specified by:
    
    putLong in interface PositionedByteRange
    
    Parameters:
    
    val - the new value.
    
    Returns:
    
    this.
  - putShort
```
public abstract PositionedByteRange putShort(short val)
```
    Description copied from interface: PositionedByteRange
    
    Store short val at the next position in this range.
    
    Specified by:
    
    putShort in interface PositionedByteRange
    
    Parameters:
    
    val - the new value.
    
    Returns:
    
    this.
  - putVLong
```
public abstract int putVLong(int index,
                             long val)
```
    Description copied from interface: ByteRange
    
    Store the long value at index as a VLong
    
    Specified by:
    
    putVLong in interface ByteRange
    
    Specified by:
    
    putVLong in class AbstractByteRange
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store
    
    Returns:
    
    number of bytes written
  - putVLong
```
public abstract int putVLong(long val)
```
    Description copied from interface: PositionedByteRange
    
    Store the long val at the next position as a VLong
    
    Specified by:
    
    putVLong in interface PositionedByteRange
    
    Parameters:
    
    val - the value to store
    
    Returns:
    
    number of bytes written
  - 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
  - put
```
public abstract PositionedByteRange put(int index,
                                        byte val)
```
    Description copied from interface: ByteRange
    
    Store val at index.
    
    Specified by:
    
    put in interface ByteRange
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Specified by:
    
    put in class AbstractByteRange
    
    Parameters:
    
    index - the index in the range where val is stored.
    
    val - the value to store.
    
    Returns:
    
    this.
  - put
```
public abstract PositionedByteRange put(int index,
                                        byte[] val)
```
    Description copied from interface: ByteRange
    
    Store val at index.
    
    Specified by:
    
    put in interface ByteRange
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Specified by:
    
    put in class AbstractByteRange
    
    Parameters:
    
    index - the index in the range where val is stored.
    
    val - the value to store.
    
    Returns:
    
    this.
  - put
```
public abstract PositionedByteRange put(int index,
                                        byte[] val,
                                        int offset,
                                        int length)
```
    Description copied from interface: ByteRange
    
    Store length bytes from val into this range, starting at index. Bytes from val are copied starting at offset into the range.
    
    Specified by:
    
    put in interface ByteRange
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Specified by:
    
    put in class AbstractByteRange
    
    Parameters:
    
    index - position in this range to start the copy.
    
    val - the value to store.
    
    offset - the offset in val from which to start copying.
    
    length - the number of bytes to copy from val.
    
    Returns:
    
    this.
  - deepCopy
```
public abstract PositionedByteRange deepCopy()
```
    Description copied from interface: ByteRange
    
    Create a new ByteRange with new backing byte[] containing a copy of the content from this range's window.
    
    Specified by:
    
    deepCopy in interface ByteRange
    
    Specified by:
    
    deepCopy in interface PositionedByteRange
    
    Returns:
    
    Deep copy
  - shallowCopy
```
public abstract PositionedByteRange shallowCopy()
```
    Description copied from interface: ByteRange
    
    Create a new ByteRange that points at this range's byte[]. Modifying the shallowCopy will modify the bytes in this range's array. Pass over the hash code if it is already cached.
    
    Specified by:
    
    shallowCopy in interface ByteRange
    
    Specified by:
    
    shallowCopy in interface PositionedByteRange
    
    Returns:
    
    new ByteRange object referencing this range's byte[].
  - shallowCopySubRange
```
public abstract PositionedByteRange shallowCopySubRange(int innerOffset,
                                                        int copyLength)
```
    Description copied from interface: ByteRange
    
    Create a new ByteRange that points at this range's byte[]. The new range can have different values for offset and length, but modifying the shallowCopy will modify the bytes in this range's array. Pass over the hash code if it is already cached.
    
    Specified by:
    
    shallowCopySubRange in interface ByteRange
    
    Specified by:
    
    shallowCopySubRange in interface PositionedByteRange
    
    Parameters:
    
    innerOffset - First byte of clone will be this.offset + copyOffset.
    
    copyLength - Number of bytes in the clone.
    
    Returns:
    
    new ByteRange object referencing this range's byte[].
  - 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
    
    Returns:
    
    PositionedByteRange
  - getLimit
```
public int getLimit()
```
    Description copied from interface: PositionedByteRange
    
    Return the current limit
    
    Specified by:
    
    getLimit in interface PositionedByteRange
    
    Returns:
    
    limit

Class AbstractPositionedByteRange

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

Field Detail

position

limit

Constructor Detail

AbstractPositionedByteRange

Method Detail

unset

set

set

set

setOffset

setLength

getPosition

setPosition

getRemaining

peek

get

get

get

put

put

put

putInt

putLong

putShort

putInt

putLong

putShort

putVLong

putVLong

get

get

getShort

getInt

getLong

getVLong

put

put

put

deepCopy

shallowCopy

shallowCopySubRange

setLimit

getLimit