|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.types.Union2<A,B>
@InterfaceAudience.Public @InterfaceStability.Evolving public abstract class Union2<A,B>
The Union
family of DataType
s encode one of a fixed
set of Object
s. They provide convenience methods which handle
type casting on your behalf.
Field Summary | |
---|---|
protected DataType<A> |
typeA
|
protected DataType<B> |
typeB
|
Constructor Summary | |
---|---|
Union2(DataType<A> typeA,
DataType<B> typeB)
Create an instance of Union2 over the set of specified
types. |
Method Summary | |
---|---|
A |
decodeA(PositionedByteRange src)
Read an instance of the first type parameter from buffer src . |
B |
decodeB(PositionedByteRange src)
Read an instance of the second type parameter from buffer src . |
Class<Object> |
encodedClass()
Inform consumers over what type this DataType operates. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.hadoop.hbase.types.DataType |
---|
decode, encode, encodedLength, skip |
Field Detail |
---|
protected final DataType<A> typeA
protected final DataType<B> typeB
Constructor Detail |
---|
public Union2(DataType<A> typeA, DataType<B> typeB)
Union2
over the set of specified
types.
Method Detail |
---|
public boolean isOrderPreserving()
DataType
byte[]
's
which preserve the natural sort order of the unencoded value.
isOrderPreserving
in interface DataType<Object>
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<Object>
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<Object>
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<Object>
public Class<Object> encodedClass()
DataType
DataType
operates. Useful
when working with bare DataType
instances.
encodedClass
in interface DataType<Object>
public A decodeA(PositionedByteRange src)
src
.
public B decodeB(PositionedByteRange src)
src
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |