org.apache.hadoop.hbase

Interface Tag

All Known Implementing Classes:

ArrayBackedTag, ByteBufferTag

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public interface Tag

Tags are part of cells and helps to add metadata about them. Metadata could be ACLs, visibility labels, etc.

Each Tag is having a type (one byte) and value part. The max value length for a Tag is 65533.

See TagType for reserved tag types.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFRASTRUCTURE_SIZE
static int	MAX_TAG_LENGTH
static int	TAG_LENGTH_SIZE
static int	TYPE_LENGTH_SIZE

Method Summary

Modifier and Type	Method and Description
byte	getType()
byte[]	getValueArray()
ByteBuffer	getValueByteBuffer()
int	getValueLength()
int	getValueOffset()
boolean	hasArray() Tells whether or not this Tag is backed by a byte array.

Field Detail

TYPE_LENGTH_SIZE

static final int TYPE_LENGTH_SIZE

See Also:

Constant Field Values

TAG_LENGTH_SIZE

static final int TAG_LENGTH_SIZE

See Also:

Constant Field Values

INFRASTRUCTURE_SIZE

static final int INFRASTRUCTURE_SIZE

See Also:

Constant Field Values

MAX_TAG_LENGTH

static final int MAX_TAG_LENGTH

See Also:

Constant Field Values

Method Detail

getType

byte getType()

Returns:

the tag type

getValueOffset

int getValueOffset()

Returns:

Offset of tag value within the backed buffer

getValueLength

int getValueLength()

Returns:

Length of tag value within the backed buffer

hasArray

boolean hasArray()

Tells whether or not this Tag is backed by a byte array.

Returns:

true when this Tag is backed by byte array

getValueArray

byte[] getValueArray()

Returns:

The array containing the value bytes.

Throws:

UnsupportedOperationException - when hasArray() return false. Use getValueByteBuffer() in such situation

getValueByteBuffer

ByteBuffer getValueByteBuffer()

Returns:

The ByteBuffer containing the value bytes.