org.apache.hadoop.hbase.types

Class OrderedInt16

java.lang.Object

org.apache.hadoop.hbase.types.OrderedBytesBase<Short>

org.apache.hadoop.hbase.types.OrderedInt16

All Implemented Interfaces:

DataType<Short>

@InterfaceAudience.Public
public class OrderedInt16
extends OrderedBytesBase<Short>

A short of 16-bits using a fixed-length encoding. Built on OrderedBytes.encodeInt16(PositionedByteRange, short, Order).

Field Summary

Fields

Modifier and Type	Field and Description
static OrderedInt16	ASCENDING Deprecated. since 3.0.0 and will be removed in 4.0.0
static OrderedInt16	DESCENDING Deprecated. since 3.0.0 and will be removed in 4.0.0

Fields inherited from class org.apache.hadoop.hbase.types.OrderedBytesBase

order

Constructor Summary

Constructors

Constructor and Description
OrderedInt16(Order order) Creates a new 16-bit short with a fixed-length encoding.

Method Summary

Modifier and Type	Method and Description
Short	decode(PositionedByteRange src) Read an instance of T from the buffer src.
short	decodeShort(PositionedByteRange src) Read a short value from the buffer src.
int	encode(PositionedByteRange dst, Short val) Write instance val into buffer dst.
Class<Short>	encodedClass() Inform consumers over what type this DataType operates.
int	encodedLength(Short val) Inform consumers how long the encoded byte[] will be.
int	encodeShort(PositionedByteRange dst, short val) Write instance val into buffer dst.
boolean	isNullable() Indicates whether this instance supports encoding null values.

Methods inherited from class org.apache.hadoop.hbase.types.OrderedBytesBase

getOrder, isOrderPreserving, isSkippable, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASCENDING

@Deprecated
public static final OrderedInt16 ASCENDING

Deprecated. since 3.0.0 and will be removed in 4.0.0

DESCENDING

@Deprecated
public static final OrderedInt16 DESCENDING

Deprecated. since 3.0.0 and will be removed in 4.0.0

Constructor Detail

OrderedInt16

public OrderedInt16(Order order)

Creates a new 16-bit short with a fixed-length encoding.

Parameters:

order - the Order to use

Method Detail

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<Short>

Overrides:

isNullable in class OrderedBytesBase<Short>

Returns:

true when null is supported, false otherwise.

encodedLength

public int encodedLength(Short val)

Description copied from interface: DataType

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

Parameters:

val - The value to check.

Returns:

the number of bytes required to encode val.a

encodedClass

public Class<Short> encodedClass()

Description copied from interface: DataType

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

decode

public Short decode(PositionedByteRange src)

Description copied from interface: DataType

Read an instance of T from the buffer src.

Parameters:

src - the buffer containing the encoded value.

encode

public int encode(PositionedByteRange dst,
                  Short val)

Description copied from interface: DataType

Write instance val into buffer dst.

Parameters:

dst - the buffer containing the encoded value.

val - the value to encode onto dst.

Returns:

number of bytes written.

decodeShort

public short decodeShort(PositionedByteRange src)

Read a short value from the buffer src.

Parameters:

src - the PositionedByteRange to read the float from

Returns:

the short read from buffer

encodeShort

public int encodeShort(PositionedByteRange dst,
                       short val)

Write instance val into buffer dst.

Parameters:

dst - the PositionedByteRange to write to

val - the value to write to dst

Returns:

the number of bytes written