SimpleByteRange (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.util.AbstractByteRange
- - org.apache.hadoop.hbase.util.SimpleByteRange

All Implemented Interfaces:: Comparable<ByteRange>, ByteRange

@InterfaceAudience.Public
public class SimpleByteRange
extends org.apache.hadoop.hbase.util.AbstractByteRange

A read only version of the ByteRange.

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

Constructor Summary

Constructors
Constructor and Description
`SimpleByteRange()`
`SimpleByteRange(byte[] bytes)` Create a new `ByteRange` over the provided `bytes`.
`SimpleByteRange(byte[] bytes, int offset, int length)` Create a new `ByteRange` over the provided `bytes`.
`SimpleByteRange(int capacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteRange`	`deepCopy()` Create a new `ByteRange` with new backing byte[] containing a copy of the content from `this` range's window.
`boolean`	`equals(Object thatObject)`
`ByteRange`	`put(int index, byte val)` Store `val` at `index`.
`ByteRange`	`put(int index, byte[] val)` Store `val` at `index`.
`ByteRange`	`put(int index, byte[] val, int offset, int length)` Store `length` bytes from `val` into this range, starting at `index`.
`ByteRange`	`putInt(int index, int val)` Store the int value at `index`
`ByteRange`	`putLong(int index, long val)` Store the long value at `index`
`ByteRange`	`putShort(int index, short val)` Store the short value at `index`
`int`	`putVLong(int index, long val)` Store the long value at `index` as a VLong
`ByteRange`	`set(byte[] bytes)` Reuse this `ByteRange` over a new byte[].
`ByteRange`	`set(byte[] bytes, int offset, int length)` Reuse this `ByteRange` over a new byte[].
`ByteRange`	`set(int capacity)` Reuse this `ByteRange` over a new byte[].
`ByteRange`	`shallowCopy()` Create a new `ByteRange` that points at this range's byte[].
`ByteRange`	`shallowCopySubRange(int innerOffset, int copyLength)` Create a new `ByteRange` that points at this range's byte[].
`ByteRange`	`unset()` Nullifies this ByteRange.

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleByteRange
```
public SimpleByteRange()
```
  - SimpleByteRange
```
public SimpleByteRange(int capacity)
```
  - SimpleByteRange
```
public SimpleByteRange(byte[] bytes)
```
    Create a new ByteRange over the provided bytes.
    
    Parameters:
    
    bytes - The array to wrap.
  - SimpleByteRange
```
public SimpleByteRange(byte[] bytes,
                       int offset,
                       int length)
```
    Create a new ByteRange 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 ByteRange unset()
```
    Description copied from interface: ByteRange
    
    Nullifies this ByteRange. That is, it becomes a husk, being a range over no byte[] whatsoever. n
  - set
```
public ByteRange 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
    
    Overrides:
    
    set in class org.apache.hadoop.hbase.util.AbstractByteRange
    
    Parameters:
    
    capacity - the size of a new byte[]. n
  - set
```
public ByteRange 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
    
    Overrides:
    
    set in class org.apache.hadoop.hbase.util.AbstractByteRange
    
    Parameters:
    
    bytes - the array to wrap. n
  - set
```
public ByteRange 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
    
    Overrides:
    
    set in class org.apache.hadoop.hbase.util.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.
  - put
```
public ByteRange put(int index,
                     byte val)
```
    Description copied from interface: ByteRange
    
    Store val at index.
    
    Parameters:
    
    index - the index in the range where val is stored.
    
    val - the value to store.
    
    Returns:
    
    this.
  - put
```
public ByteRange put(int index,
                     byte[] val)
```
    Description copied from interface: ByteRange
    
    Store val at index.
    
    Parameters:
    
    index - the index in the range where val is stored.
    
    val - the value to store.
    
    Returns:
    
    this.
  - put
```
public ByteRange 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.
    
    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.
  - shallowCopy
```
public ByteRange 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.
    
    Returns:
    
    new ByteRange object referencing this range's byte[].
  - shallowCopySubRange
```
public ByteRange 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.
    
    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[].
  - equals
```
public boolean equals(Object thatObject)
```
    Overrides:
    
    equals in class org.apache.hadoop.hbase.util.AbstractByteRange
  - deepCopy
```
public ByteRange 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.
    
    Returns:
    
    Deep copy
  - putInt
```
public ByteRange putInt(int index,
                        int val)
```
    Description copied from interface: ByteRange
    
    Store the int value at index
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store n
  - putLong
```
public ByteRange putLong(int index,
                         long val)
```
    Description copied from interface: ByteRange
    
    Store the long value at index
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store n
  - putShort
```
public ByteRange putShort(int index,
                          short val)
```
    Description copied from interface: ByteRange
    
    Store the short value at index
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store n
  - putVLong
```
public int putVLong(int index,
                    long val)
```
    Description copied from interface: ByteRange
    
    Store the long value at index as a VLong
    
    Parameters:
    
    index - the index in the range where val is stored
    
    val - the value to store
    
    Returns:
    
    number of bytes written

Class SimpleByteRange

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

Constructor Detail

SimpleByteRange

SimpleByteRange

SimpleByteRange

SimpleByteRange

Method Detail

unset

set

set

set

put

put

put

shallowCopy

shallowCopySubRange

equals

deepCopy

putInt

putLong

putShort

putVLong