org.apache.hadoop.hbase

Class TagUtil

java.lang.Object

org.apache.hadoop.hbase.TagUtil

@InterfaceAudience.Private
public final class TagUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static List<Tag>	asList(byte[] b, int offset, int length) Creates list of tags from given byte array, expected that it is in the expected tag format.
static List<Tag>	asList(ByteBuffer b, int offset, int length) Creates list of tags from given ByteBuffer, expected that it is in the expected tag format.
static List<Tag>	carryForwardTags(Cell cell)
static List<Tag>	carryForwardTags(List<Tag> tagsOrNull, Cell cell) Add to tagsOrNull any Tags cell is carrying or null if none.
static List<Tag>	carryForwardTTLTag(List<Tag> tagsOrNull, long ttl)
static void	checkForTagsLength(int tagsLength) Check the length of tags.
static byte[]	cloneValue(Tag tag) Returns tag value in a new byte array.
static byte[]	concatTags(byte[] tags, Cell cell)
static void	copyValueTo(Tag tag, byte[] out, int offset) Copies the tag's value bytes to the given byte array
static byte[]	fromList(List<Tag> tags) Write a list of tags into a byte array
static byte	getValueAsByte(Tag tag) Converts the value bytes of the given tag into a byte value
static long	getValueAsLong(Tag tag) Converts the value bytes of the given tag into a long value
static String	getValueAsString(Tag tag) Converts the value bytes of the given tag into a String value
static boolean	matchingValue(Tag t1, Tag t2) Matches the value part of given tags
static Pair<Integer,Integer>	readVIntValuePart(Tag tag, int offset) Reads an int value stored as a VInt at tag's given offset.

Methods inherited from class java.lang.Object

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

Method Detail

cloneValue

public static byte[] cloneValue(Tag tag)

Returns tag value in a new byte array. Primarily for use client-side. If server-side, use Tag.getValueArray() with appropriate Tag.getValueOffset() and Tag.getValueLength() instead to save on allocations.

Parameters:

tag - The Tag whose value to be returned

Returns:

tag value in a new byte array.

asList

public static List<Tag> asList(byte[] b,
                               int offset,
                               int length)

Creates list of tags from given byte array, expected that it is in the expected tag format.

Parameters:

b - The byte array

offset - The offset in array where tag bytes begin

length - Total length of all tags bytes

Returns:

List of tags

asList

public static List<Tag> asList(ByteBuffer b,
                               int offset,
                               int length)

Creates list of tags from given ByteBuffer, expected that it is in the expected tag format.

Parameters:

b - The ByteBuffer

offset - The offset in ByteBuffer where tag bytes begin

length - Total length of all tags bytes

Returns:

List of tags

fromList

public static byte[] fromList(List<Tag> tags)

Write a list of tags into a byte array

Parameters:

tags - The list of tags

Returns:

the serialized tag data as bytes

getValueAsLong

public static long getValueAsLong(Tag tag)

Converts the value bytes of the given tag into a long value

Parameters:

tag - The Tag

Returns:

value as long

getValueAsByte

public static byte getValueAsByte(Tag tag)

Converts the value bytes of the given tag into a byte value

Parameters:

tag - The Tag

Returns:

value as byte

getValueAsString

public static String getValueAsString(Tag tag)

Converts the value bytes of the given tag into a String value

Parameters:

tag - The Tag

Returns:

value as String

matchingValue

public static boolean matchingValue(Tag t1,
                                    Tag t2)

Matches the value part of given tags

Parameters:

t1 - Tag to match the value

t2 - Tag to match the value

Returns:

True if values of both tags are same.

copyValueTo

public static void copyValueTo(Tag tag,
                               byte[] out,
                               int offset)

Copies the tag's value bytes to the given byte array

Parameters:

tag - The Tag

out - The byte array where to copy the Tag value.

offset - The offset within 'out' array where to copy the Tag value.

readVIntValuePart

public static Pair<Integer,Integer> readVIntValuePart(Tag tag,
                                                      int offset)
                                               throws IOException

Reads an int value stored as a VInt at tag's given offset.

Parameters:

tag - The Tag

offset - The offset where VInt bytes begin

Returns:

A pair of the int value and number of bytes taken to store VInt

Throws:

IOException - When varint is malformed and not able to be read correctly

carryForwardTags

public static List<Tag> carryForwardTags(Cell cell)

Returns:

A List<Tag> of any Tags found in cell else null.

carryForwardTags

public static List<Tag> carryForwardTags(List<Tag> tagsOrNull,
                                         Cell cell)

Add to tagsOrNull any Tags cell is carrying or null if none.

concatTags

public static byte[] concatTags(byte[] tags,
                                Cell cell)

carryForwardTTLTag

public static List<Tag> carryForwardTTLTag(List<Tag> tagsOrNull,
                                           long ttl)

Returns:

Carry forward the TTL tag.

checkForTagsLength

public static void checkForTagsLength(int tagsLength)

Check the length of tags. If it is invalid, throw IllegalArgumentException

Parameters:

tagsLength -

Throws:

IllegalArgumentException - if tagslength is invalid