SimplePositionedMutableByteRange (Apache HBase 1.1.7 API)

java.lang.Object
- org.apache.hadoop.hbase.util.AbstractByteRange
- - org.apache.hadoop.hbase.util.AbstractPositionedByteRange
  - - org.apache.hadoop.hbase.util.SimplePositionedMutableByteRange

All Implemented Interfaces:

Comparable<ByteRange>, ByteRange, PositionedByteRange
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public class SimplePositionedMutableByteRange
extends org.apache.hadoop.hbase.util.AbstractPositionedByteRange
```
Extends the basic AbstractPositionedByteRange implementation with position support and it is a mutable version. position is considered transient, not fundamental to the definition of the range, and does not participate in AbstractByteRange.compareTo(ByteRange), AbstractByteRange.hashCode(), or Object.equals(Object). Position is retained by copy operations.

Field Summary
- Fields inherited from class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
  limit, position
- Fields inherited from class org.apache.hadoop.hbase.util.AbstractByteRange
  bytes, hash, length, offset, UNSET_HASH_VALUE

Constructor Summary

Constructors
Constructor and Description
`SimplePositionedMutableByteRange()` Create a new `PositionedByteRange` lacking a backing array and with an undefined viewport.
`SimplePositionedMutableByteRange(byte[] bytes)` Create a new `PositionedByteRange` over the provided `bytes`.
`SimplePositionedMutableByteRange(byte[] bytes, int offset, int length)` Create a new `PositionedByteRange` over the provided `bytes`.
`SimplePositionedMutableByteRange(int capacity)` Create a new `PositionedByteRange` over a new backing array of size `capacity`.

Method Summary

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

Methods inherited from class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
get, get, get, getInt, getLimit, getLong, getPosition, getRemaining, getShort, getVLong, peek, setLimit, setPosition

Methods inherited from class org.apache.hadoop.hbase.util.AbstractByteRange
clearHashCache, compareTo, deepCopySubRangeTo, deepCopyTo, deepCopyToNewArray, get, getBytes, getInt, getLength, getLong, getOffset, getShort, getVLong, getVLongSize, hashCode, isEmpty, isEmpty, isHashCached, toString

Methods inherited from class java.lang.Object
clone, equals, 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

- Constructor Detail
  - SimplePositionedMutableByteRange
```
public SimplePositionedMutableByteRange()
```
    Create a new PositionedByteRange lacking a backing array and with an undefined viewport.
  - SimplePositionedMutableByteRange
```
public SimplePositionedMutableByteRange(int capacity)
```
    Create a new PositionedByteRange over a new backing array of size capacity. The range's offset and length are 0 and capacity, respectively.
    
    Parameters:
    capacity - the size of the backing array.
  - SimplePositionedMutableByteRange
```
public SimplePositionedMutableByteRange(byte[] bytes)
```
    Create a new PositionedByteRange over the provided bytes.
    
    Parameters:
    bytes - The array to wrap.
  - SimplePositionedMutableByteRange
```
public SimplePositionedMutableByteRange(byte[] bytes,
                                int offset,
                                int length)
```
    Create a new PositionedByteRange over the provided bytes.
    
    Parameters:
    bytes - The array to wrap.
    offset - The offset into bytes considered the beginning of this range.
    length - The length of this range.
- Method Detail
  - unset
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    length - The new length of this range.
    
    Returns:
    this.
  - put
```
public PositionedByteRange put(byte val)
```
    Description copied from interface: PositionedByteRange
    
    Store val at the next position in this range.
    
    Specified by:
    
    put in interface PositionedByteRange
    
    Specified by:
    
    put in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    val - the new value.
    
    Returns:
    this.
  - put
```
public 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
    
    Specified by:
    
    put in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    val - the new value.
    
    Returns:
    this.
  - put
```
public 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
    
    Specified by:
    
    put in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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.
  - 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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.
  - put
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    index - the index in the range where val is stored.
    val - the value to store.
    
    Returns:
    this.
  - put
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    index - the index in the range where val is stored.
    val - the value to store.
    
    Returns:
    this.
  - put
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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 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
    
    Specified by:
    
    deepCopy in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Returns:
    Deep copy
  - shallowCopy
```
public 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
    
    Specified by:
    
    shallowCopy in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Returns:
    new ByteRange object referencing this range's byte[].
  - shallowCopySubRange
```
public 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
    
    Specified by:
    
    shallowCopySubRange in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    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[].
  - putShort
```
public 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
    
    Specified by:
    
    putShort in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    val - the new value.
    
    Returns:
    this.
  - putInt
```
public 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
    
    Specified by:
    
    putInt in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    val - the new value.
    
    Returns:
    this.
  - putLong
```
public 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
    
    Specified by:
    
    putLong in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    val - the new value.
    
    Returns:
    this.
  - putVLong
```
public 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
    
    Specified by:
    
    putVLong in class org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    val - the value to store
    
    Returns:
    number of bytes written
  - putShort
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    index - the index in the range where val is stored
    val - the value to store
    
    Returns:
    this
  - putInt
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    index - the index in the range where val is stored
    val - the value to store
    
    Returns:
    this
  - putLong
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    index - the index in the range where val is stored
    val - the value to store
    
    Returns:
    this
  - putVLong
```
public 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 org.apache.hadoop.hbase.util.AbstractPositionedByteRange
    
    Parameters:
    index - the index in the range where val is stored
    val - the value to store
    
    Returns:
    number of bytes written

Class SimplePositionedMutableByteRange

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Constructor Detail

SimplePositionedMutableByteRange

SimplePositionedMutableByteRange

SimplePositionedMutableByteRange

SimplePositionedMutableByteRange

Method Detail

unset

set

set

set

setOffset

setLength

put

put

put

get

get

put

put

put

deepCopy

shallowCopy

shallowCopySubRange

putShort

putInt

putLong

putVLong

putShort

putInt

putLong

putVLong