|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.hadoop.hbase.util.SimpleByteRange
@InterfaceAudience.Public @InterfaceStability.Evolving public class SimpleByteRange
A basic ByteRange implementation.
| Field Summary | |
|---|---|
protected byte[] |
bytes
The array containing the bytes in this range. |
protected int |
length
The number of bytes in the range. |
protected int |
offset
The index of the first byte in this range. |
| Constructor Summary | |
|---|---|
SimpleByteRange()
Create a new ByteRange lacking a backing array and with an
undefined viewport. |
|
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)
Create a new ByteRange over a new backing array of size
capacity. |
|
| Method Summary | |
|---|---|
protected void |
clearHashCache()
|
int |
compareTo(ByteRange other)
Bitwise comparison of each byte in the array. |
ByteRange |
deepCopy()
Create a new ByteRange with new backing byte[] containing a copy
of the content from this range's window. |
void |
deepCopySubRangeTo(int innerOffset,
int copyLength,
byte[] destination,
int destinationOffset)
Wrapper for System.arraycopy. |
void |
deepCopyTo(byte[] destination,
int destinationOffset)
Wrapper for System.arraycopy. |
byte[] |
deepCopyToNewArray()
Instantiate a new byte[] with exact length, which is at least 24 bytes + length. |
boolean |
equals(Object thatObject)
|
byte |
get(int index)
Retrieve the byte at index. |
ByteRange |
get(int index,
byte[] dst)
Fill dst with bytes from the range, starting from index. |
ByteRange |
get(int index,
byte[] dst,
int offset,
int length)
Fill dst with bytes from the range, starting from index. |
byte[] |
getBytes()
The underlying byte[]. |
int |
getLength()
The length of the range. |
int |
getOffset()
The offset, the index into the underlying byte[] at which this range begins. |
int |
hashCode()
|
boolean |
isEmpty()
|
static boolean |
isEmpty(ByteRange range)
|
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 |
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 |
setLength(int length)
Update the length of this range. |
ByteRange |
setOffset(int offset)
Update the beginning of this range. |
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[]. |
String |
toString()
|
ByteRange |
unset()
Nullifies this ByteRange. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected byte[] bytes
protected int offset
ByteRange.get(0) will
return bytes[offset].
protected int length
| Constructor Detail |
|---|
public SimpleByteRange()
ByteRange lacking a backing array and with an
undefined viewport.
public SimpleByteRange(int capacity)
ByteRange over a new backing array of size
capacity. The range's offset and length are 0 and capacity,
respectively.
capacity - the size of the backing array.public SimpleByteRange(byte[] bytes)
ByteRange over the provided bytes.
bytes - The array to wrap.
public SimpleByteRange(byte[] bytes,
int offset,
int length)
ByteRange over the provided bytes.
bytes - The array to wrap.offset - The offset into bytes considered the beginning
of this range.length - The length of this range.| Method Detail |
|---|
public byte[] getBytes()
ByteRange
getBytes in interface ByteRangepublic ByteRange unset()
ByteRange
unset in interface ByteRangepublic ByteRange set(int capacity)
ByteRangeByteRange over a new byte[]. offset is set to
0 and length is set to capacity.
set in interface ByteRangecapacity - the size of a new byte[].
public ByteRange set(byte[] bytes)
ByteRangeByteRange 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().
set in interface ByteRangebytes - the array to wrap.
public ByteRange set(byte[] bytes,
int offset,
int length)
ByteRangeByteRange 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.
set in interface ByteRangebytes - The array to wrap.offset - The offset into bytes considered the beginning of
this range.length - The length of this range.
public int getOffset()
ByteRange
getOffset in interface ByteRangeByteRange.getBytes()public ByteRange setOffset(int offset)
ByteRangeoffset + length may not be
greater than bytes.length.
setOffset in interface ByteRangeoffset - the new start of this range.
public int getLength()
ByteRange
getLength in interface ByteRangepublic ByteRange setLength(int length)
ByteRangeoffset + length should not be
greater than bytes.length.
setLength in interface ByteRangelength - The new length of this range.
public boolean isEmpty()
isEmpty in interface ByteRangepublic static boolean isEmpty(ByteRange range)
range is of zero length, false otherwise.public byte get(int index)
ByteRangeindex.
get in interface ByteRangeindex - zero-based index into this range.
public ByteRange get(int index,
byte[] dst)
ByteRangedst with bytes from the range, starting from index.
get in interface ByteRangeindex - zero-based index into this range.dst - the destination of the copy.
public ByteRange get(int index,
byte[] dst,
int offset,
int length)
ByteRangedst with bytes from the range, starting from index.
length bytes are copied into dst, starting at offset.
get in interface ByteRangeindex - 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.
public ByteRange put(int index,
byte val)
ByteRangeval at index.
put in interface ByteRangeindex - the index in the range where val is stored.val - the value to store.
public ByteRange put(int index,
byte[] val)
ByteRangeval at index.
put in interface ByteRangeindex - the index in the range where val is stored.val - the value to store.
public ByteRange put(int index,
byte[] val,
int offset,
int length)
ByteRangelength bytes from val into this range, starting at
index. Bytes from val are copied starting at offset
into the range.
put in interface ByteRangeindex - 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.
public byte[] deepCopyToNewArray()
ByteRange
deepCopyToNewArray in interface ByteRangepublic ByteRange deepCopy()
ByteRangeByteRange with new backing byte[] containing a copy
of the content from this range's window.
deepCopy in interface ByteRange
public void deepCopyTo(byte[] destination,
int destinationOffset)
ByteRange
deepCopyTo in interface ByteRangedestination - Copy to this arraydestinationOffset - First index in the destination array.
public void deepCopySubRangeTo(int innerOffset,
int copyLength,
byte[] destination,
int destinationOffset)
ByteRange
deepCopySubRangeTo in interface ByteRangeinnerOffset - Start copying from this index in this source
ByteRange. First byte copied is bytes[offset + innerOffset]copyLength - Copy this many bytesdestination - Copy to this arraydestinationOffset - First index in the destination array.public ByteRange shallowCopy()
ByteRangeByteRange 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.
shallowCopy in interface ByteRangeByteRange object referencing this range's byte[].
public ByteRange shallowCopySubRange(int innerOffset,
int copyLength)
ByteRangeByteRange 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.
shallowCopySubRange in interface ByteRangeinnerOffset - First byte of clone will be this.offset + copyOffset.copyLength - Number of bytes in the clone.
ByteRange object referencing this range's byte[].public boolean equals(Object thatObject)
equals in class Objectpublic int hashCode()
hashCode in class Objectprotected void clearHashCache()
public int compareTo(ByteRange other)
compareTo in interface Comparable<ByteRange>public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||