org.apache.hadoop.hbase.types

Class OrderedString

java.lang.Object

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

org.apache.hadoop.hbase.types.OrderedString

All Implemented Interfaces:

DataType<String>

@InterfaceAudience.Public
public class OrderedString
extends OrderedBytesBase<String>

A String of variable-length. Built on OrderedBytes.encodeString(PositionedByteRange, String, Order).

Field Summary

Fields

Modifier and Type	Field and Description
static OrderedString	ASCENDING Deprecated. since 3.0.0 and will be removed in 4.0.0
static OrderedString	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
OrderedString(Order order) Creates a new variable-length String.

Method Summary

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

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

getOrder, isNullable, 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 OrderedString ASCENDING

Deprecated. since 3.0.0 and will be removed in 4.0.0

DESCENDING

@Deprecated
public static final OrderedString DESCENDING

Deprecated. since 3.0.0 and will be removed in 4.0.0

Constructor Detail

OrderedString

public OrderedString(Order order)

Creates a new variable-length String.

Parameters:

order - the Order to use

Method Detail

encodedLength

public int encodedLength(String 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<String> encodedClass()

Description copied from interface: DataType

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

decode

public String 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,
                  String 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.