com.mapr.db.impl

Class IdCodec

java.lang.Object

com.mapr.db.impl.IdCodec

@API.Internal
public class IdCodec
extends Object

Constructor Summary

Constructors

Constructor and Description
IdCodec()

Method Summary

Methods

Modifier and Type	Method and Description
static String	asString(org.ojai.Value in) Returns the String representation of the Value.
static org.ojai.Value	decode(byte[] in) Decodes a Value from the provided byte array.
static org.ojai.Value	decode(ByteBuffer in) Decodes a Value from the provided ByteBuffer.
static ByteBuffer	decodeBinary(ByteBuffer in) Decodes a BINARY value from the provided ByteBuffer.
static byte[]	decodeBytes(byte[] in) Decodes a BINARY value from the provided byte array.
static String	decodeString(byte[] in) Decodes a STRING from the provided byte array.
static String	decodeString(ByteBuffer in) Decodes a STRING value from the provided ByteBuffer.
static ByteBuffer	encode(ByteBuffer in) Encodes a BINARY value into a ByteBuffer using the _id encoding scheme.
static ByteBuffer	encode(String in) Encodes a String into a ByteBuffer using the _id encoding scheme.
static ByteBuffer	encode(org.ojai.Value in) Encodes a Value into a ByteBuffer using the _id encoding scheme.
static byte[]	encodeAsBytes(byte[] in) Encodes a BINARY value into a byte array using the _id encoding scheme.
static byte[]	encodeAsBytes(ByteBuffer in) Encodes a BINARY value into a byte array using the _id encoding scheme.
static byte[]	encodeAsBytes(String in) Encodes a String into a ByteBuffer using the _id encoding scheme.
static byte[]	encodeAsBytes(org.ojai.Value in) Encodes a Value into a byte array using the _id encoding scheme.
static byte[]	encodeStringBinary(String in) Encode a binary encoded string using the _id encoding scheme.
static boolean	isSupportedType(org.ojai.Value.Type type)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdCodec

public IdCodec()

Method Detail

isSupportedType

public static boolean isSupportedType(org.ojai.Value.Type type)

Parameters:

type - the Type to test

Returns:

true if the specified type is a supported Type for '_id' field, otherwise, false.

asString

public static String asString(org.ojai.Value in)

Returns the String representation of the Value.

Parameters:

in -

Returns:

encodeStringBinary

public static byte[] encodeStringBinary(String in)

Encode a binary encoded string using the _id encoding scheme.

Parameters:

in - the binary encoded string to encode

Returns:

the byte array containing the encoded Value

encode

public static ByteBuffer encode(org.ojai.Value in)

Encodes a Value into a ByteBuffer using the _id encoding scheme.

Parameters:

in - the Value to encode

Returns:

the ByteBuffer containing the encoded Value

Throws:

org.ojai.exceptions.EncodingException - if the input Value is not a supported type

encodeAsBytes

public static byte[] encodeAsBytes(org.ojai.Value in)

Encodes a Value into a byte array using the _id encoding scheme.

Parameters:

in - the Value to encode

Returns:

the byte array containing the encoded Value

Throws:

org.ojai.exceptions.EncodingException - if the input Value is not a supported type

decode

public static org.ojai.Value decode(byte[] in)

Decodes a Value from the provided byte array. If the byte array is of Zero length, a NULL type Value is returned.

Parameters:

in - byte array containing the encoded Value

Returns:

decoded Value

Throws:

org.ojai.exceptions.DecodingException - if the input byte array does not contain a supported type

decode

public static org.ojai.Value decode(ByteBuffer in)

Decodes a Value from the provided ByteBuffer. If the ByteBuffer has zero remaining bytes, a NULL type Value is returned.

Parameters:

in - ByteBuffer containing the encoded Value

Returns:

decoded Value

Throws:

org.ojai.exceptions.DecodingException - if the input ByteBuffer does not contain a supported type

encode

public static ByteBuffer encode(String in)

Encodes a String into a ByteBuffer using the _id encoding scheme.

Parameters:

in - the String to encode

Returns:

the ByteBuffer containing the encoded String

encodeAsBytes

public static byte[] encodeAsBytes(String in)

Encodes a String into a ByteBuffer using the _id encoding scheme.

Parameters:

in - the String to encode

Returns:

the ByteBuffer containing the encoded String

decodeString

public static String decodeString(byte[] in)

Decodes a STRING from the provided byte array.

Parameters:

in - byte array containing the encoded String

Returns:

the decoded String

Throws:

org.ojai.exceptions.DecodingException - if the input byte array does not contain a STRING value

decodeString

public static String decodeString(ByteBuffer in)

Decodes a STRING value from the provided ByteBuffer.

Parameters:

in - ByteBuffer containing the encoded String

Returns:

the decoded String

Throws:

org.ojai.exceptions.DecodingException - if the input ByteBuffer does not contain a STRING value

encodeAsBytes

public static byte[] encodeAsBytes(byte[] in)

Encodes a BINARY value into a byte array using the _id encoding scheme.

Parameters:

in - the byte array containing the BINARY data

Returns:

the byte array containing the encoded BINARY value

decodeBytes

public static byte[] decodeBytes(byte[] in)

Decodes a BINARY value from the provided byte array.

Parameters:

in - byte array containing the encoded BINARY Value

Returns:

a byte array containing BINARY value

Throws:

org.ojai.exceptions.DecodingException - if the input byte array does not contain a BINARY value

encode

public static ByteBuffer encode(ByteBuffer in)

Encodes a BINARY value into a ByteBuffer using the _id encoding scheme.

Parameters:

in - the ByteBuffer containing the BINARY data

Returns:

the ByteBuffer containing the encoded BINARY value

encodeAsBytes

public static byte[] encodeAsBytes(ByteBuffer in)

Encodes a BINARY value into a byte array using the _id encoding scheme.

Parameters:

in - the ByteBuffer containing the BINARY data

Returns:

the byte array containing the encoded BINARY value

decodeBinary

public static ByteBuffer decodeBinary(ByteBuffer in)

Decodes a BINARY value from the provided ByteBuffer. The returned ByteBuffer does not share its content with the input ByteBuffer.

Parameters:

in - ByteBuffer containing the encoded BINARY Value

Returns:

a ByteBuffer containing BINARY value

Throws:

org.ojai.exceptions.DecodingException - if the input ByteBuffer does not contain a BINARY value.