org.apache.hadoop.hbase.types

Class RawBytes

java.lang.Object

org.apache.hadoop.hbase.types.RawBytes

All Implemented Interfaces:

DataType<byte[]>

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class RawBytes
extends Object
implements DataType<byte[]>

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.

See Also:

Bytes.putBytes(byte[], int, byte[], int, int), RawBytesTerminated, RawBytesFixedLength, OrderedBlob, OrderedBlobVar

Field Summary

Fields

Modifier and Type	Field and Description
static RawBytes	ASCENDING
static RawBytes	DESCENDING
protected Order	order

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RawBytes()
protected	RawBytes(Order order)

Method Summary

Methods

Modifier and Type	Method and Description
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

ASCENDING

public static final RawBytes ASCENDING

DESCENDING

public static final RawBytes DESCENDING

order

protected final Order order

Constructor Detail

RawBytes

protected RawBytes()

RawBytes

protected RawBytes(Order order)

Method Detail

isOrderPreserving

public boolean isOrderPreserving()

Description copied from interface: DataType

Indicates whether this instance writes encoded byte[]'s which preserve the natural sort order of the unencoded value.

Specified by:

isOrderPreserving in interface DataType<byte[]>

Returns:

true when natural order is preserved, false otherwise.

getOrder

public Order getOrder()

Description copied from interface: DataType

Retrieve the sort 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.

Specified by:

getOrder in interface DataType<byte[]>

isNullable

public boolean isNullable()

Description copied from interface: DataType

Indicates whether this instance supports encoding null values. This depends on the implementation details of the encoding format. All DataTypes that support null should treat null as comparing less than any non-null value for default sort ordering purposes.

Specified by:

isNullable in interface DataType<byte[]>

Returns:

true when null is supported, false otherwise.

isSkippable

public boolean isSkippable()

Description copied from interface: DataType

Indicates whether this instance is able to skip over it's encoded value. DataTypes that are not skippable can only be used as the right-most field of a Struct.

Specified by:

isSkippable in interface DataType<byte[]>

skip

public int skip(PositionedByteRange src)

Description copied from interface: DataType

Skip src's position forward over one encoded value.

Specified by:

skip in interface DataType<byte[]>

Parameters:

src - the buffer containing the encoded value.

Returns:

number of bytes skipped.

encodedLength

public int encodedLength(byte[] val)

Description copied from interface: DataType

Inform consumers how long the encoded byte[] will be.

Specified by:

encodedLength in interface DataType<byte[]>

Parameters:

val - The value to check.

Returns:

the number of bytes required to encode val.a

encodedClass

public Class<byte[]> encodedClass()

Description copied from interface: DataType

Inform consumers over what type this DataType operates. Useful when working with bare DataType instances.

Specified by:

encodedClass in interface DataType<byte[]>

decode

public byte[] decode(PositionedByteRange src)

Description copied from interface: DataType

Read an instance of T from the buffer src.

Specified by:

decode in interface DataType<byte[]>

Parameters:

src - the buffer containing the encoded value.

encode

public int encode(PositionedByteRange dst,
         byte[] val)

Description copied from interface: DataType

Write instance val into buffer dst.

Specified by:

encode in interface DataType<byte[]>

Parameters:

dst - the buffer containing the encoded value.

val - the value to encode onto dst.

Returns:

number of bytes written.

decode

public byte[] decode(PositionedByteRange src,
            int length)

Read a byte[] from the buffer src.

encode

public int encode(PositionedByteRange dst,
         byte[] val,
         int voff,
         int vlen)

Write val into dst, respecting voff and vlen.

Returns:

number of bytes written.