SimpleMutableByteRange (Apache HBase 2.5.0 API)

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

All Implemented Interfaces:: Comparable<ByteRange>, ByteRange

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

A basic mutable ByteRange implementation.

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
`SimpleMutableByteRange()` Create a new `ByteRange` lacking a backing array and with an undefined viewport.
`SimpleMutableByteRange(byte[] bytes)` Create a new `ByteRange` over the provided `bytes`.
`SimpleMutableByteRange(byte[] bytes, int offset, int length)` Create a new `ByteRange` over the provided `bytes`.
`SimpleMutableByteRange(int capacity)` Create a new `ByteRange` over a new backing array of size `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`	`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, set, set, set, setLength, setOffset, toString

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

- Constructor Detail
  - SimpleMutableByteRange
```
public SimpleMutableByteRange()
```
    Create a new ByteRange lacking a backing array and with an undefined viewport.
  - SimpleMutableByteRange
```
public SimpleMutableByteRange(int capacity)
```
    Create a new ByteRange over a new backing array of size capacity. The range's offset and length are 0 and capacity, respectively. n * the size of the backing array.
  - SimpleMutableByteRange
```
public SimpleMutableByteRange(byte[] bytes)
```
    Create a new ByteRange over the provided bytes. n * The array to wrap.
  - SimpleMutableByteRange
```
public SimpleMutableByteRange(byte[] bytes,
                              int offset,
                              int length)
```
    Create a new ByteRange over the provided bytes. n * The array to wrap. n * The offset into bytes considered the beginning of this range. n * 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
  - 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.
  - 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
  - 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
  - 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
  - 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
  - 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

Class SimpleMutableByteRange

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

SimpleMutableByteRange

SimpleMutableByteRange

SimpleMutableByteRange

SimpleMutableByteRange

Method Detail

unset

put

put

put

putShort

putInt

putLong

putVLong

deepCopy

shallowCopy

shallowCopySubRange

equals