|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.types.RawBytes
@InterfaceAudience.Public @InterfaceStability.Evolving public class RawBytes
An DataType
for interacting with variable-length values
encoded using Bytes.putBytes(byte[], int, byte[], int, int)
.
Intended to make it easier to transition away from direct use of
Bytes
.
Bytes.putBytes(byte[], int, byte[], int, int)
,
RawBytesTerminated
,
RawBytesFixedLength
,
OrderedBlob
,
OrderedBlobVar
Field Summary | |
---|---|
static RawBytes |
ASCENDING
|
static RawBytes |
DESCENDING
|
protected Order |
order
|
Constructor Summary | |
---|---|
protected |
RawBytes()
|
protected |
RawBytes(Order order)
|
Method Summary | |
---|---|
byte[] |
decode(PositionedByteRange src)
Read an instance of T from the buffer src . |
byte[] |
decode(PositionedByteRange src,
int length)
Read a byte[] from the buffer src . |
int |
encode(PositionedByteRange dst,
byte[] val)
Write instance val into buffer dst . |
int |
encode(PositionedByteRange dst,
byte[] val,
int voff,
int vlen)
Write val into dst , respecting voff and vlen . |
Class<byte[]> |
encodedClass()
Inform consumers over what type this DataType operates. |
int |
encodedLength(byte[] val)
Inform consumers how long the encoded byte[] will be. |
Order |
getOrder()
Retrieve the sort Order imposed by this data type, or null when
natural ordering is not preserved. |
boolean |
isNullable()
Indicates whether this instance supports encoding null values. |
boolean |
isOrderPreserving()
Indicates whether this instance writes encoded byte[] 's
which preserve the natural sort order of the unencoded value. |
boolean |
isSkippable()
Indicates whether this instance is able to skip over it's encoded value. |
int |
skip(PositionedByteRange src)
Skip src 's position forward over one encoded value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final RawBytes ASCENDING
public static final RawBytes DESCENDING
protected final Order order
Constructor Detail |
---|
protected RawBytes()
protected RawBytes(Order order)
Method Detail |
---|
public boolean isOrderPreserving()
DataType
byte[]
's
which preserve the natural sort order of the unencoded value.
isOrderPreserving
in interface DataType<byte[]>
true
when natural order is preserved,
false
otherwise.public Order getOrder()
DataType
Order
imposed by this data type, or null when
natural ordering is not preserved. Value is either ascending or
descending. Default is assumed to be Order.ASCENDING
.
getOrder
in interface DataType<byte[]>
public boolean isNullable()
DataType
DataType
s that support null should treat null as comparing
less than any non-null value for default sort ordering purposes.
isNullable
in interface DataType<byte[]>
true
when null is supported, false
otherwise.public boolean isSkippable()
DataType
DataType
s that are not skippable can only be used as the
right-most field of a Struct
.
isSkippable
in interface DataType<byte[]>
public int skip(PositionedByteRange src)
DataType
src
's position forward over one encoded value.
skip
in interface DataType<byte[]>
src
- the buffer containing the encoded value.
public int encodedLength(byte[] val)
DataType
byte[]
will be.
encodedLength
in interface DataType<byte[]>
val
- The value to check.
val
.apublic Class<byte[]> encodedClass()
DataType
DataType
operates. Useful
when working with bare DataType
instances.
encodedClass
in interface DataType<byte[]>
public byte[] decode(PositionedByteRange src)
DataType
T
from the buffer src
.
decode
in interface DataType<byte[]>
src
- the buffer containing the encoded value.public int encode(PositionedByteRange dst, byte[] val)
DataType
val
into buffer dst
.
encode
in interface DataType<byte[]>
dst
- the buffer containing the encoded value.val
- the value to encode onto dst
.
public byte[] decode(PositionedByteRange src, int length)
byte[]
from the buffer src
.
public int encode(PositionedByteRange dst, byte[] val, int voff, int vlen)
val
into dst
, respecting voff
and vlen
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |