|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.hadoop.hbase.types.RawString
@InterfaceAudience.Public @InterfaceStability.Evolving public class RawString
An DataType for interacting with values encoded using
Bytes.toBytes(String). Intended to make it easier to transition
away from direct use of Bytes.
Bytes.toBytes(String),
Bytes.toString(byte[]),
RawStringTerminated| Field Summary | |
|---|---|
static RawString |
ASCENDING
|
static RawString |
DESCENDING
|
protected Order |
order
|
| Constructor Summary | |
|---|---|
protected |
RawString()
|
protected |
RawString(Order order)
|
| Method Summary | |
|---|---|
String |
decode(PositionedByteRange src)
Read an instance of T from the buffer src. |
int |
encode(PositionedByteRange dst,
String val)
Write instance val into buffer dst. |
Class<String> |
encodedClass()
Inform consumers over what type this DataType operates. |
int |
encodedLength(String 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 RawString ASCENDING
public static final RawString DESCENDING
protected final Order order
| Constructor Detail |
|---|
protected RawString()
protected RawString(Order order)
| Method Detail |
|---|
public boolean isOrderPreserving()
DataTypebyte[]'s
which preserve the natural sort order of the unencoded value.
isOrderPreserving in interface DataType<String>true when natural order is preserved,
false otherwise.public Order getOrder()
DataTypeOrder 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<String>public boolean isNullable()
DataTypeDataTypes that support null should treat null as comparing
less than any non-null value for default sort ordering purposes.
isNullable in interface DataType<String>true when null is supported, false otherwise.public boolean isSkippable()
DataTypeDataTypes that are not skippable can only be used as the
right-most field of a Struct.
isSkippable in interface DataType<String>public int skip(PositionedByteRange src)
DataTypesrc's position forward over one encoded value.
skip in interface DataType<String>src - the buffer containing the encoded value.
public int encodedLength(String val)
DataTypebyte[] will be.
encodedLength in interface DataType<String>val - The value to check.
val.apublic Class<String> encodedClass()
DataTypeDataType operates. Useful
when working with bare DataType instances.
encodedClass in interface DataType<String>public String decode(PositionedByteRange src)
DataTypeT from the buffer src.
decode in interface DataType<String>src - the buffer containing the encoded value.
public int encode(PositionedByteRange dst,
String val)
DataTypeval into buffer dst.
encode in interface DataType<String>dst - the buffer containing the encoded value.val - the value to encode onto dst.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||