org.apache.james.mailbox.hbase

Class FlagConvertor

java.lang.Object

org.apache.james.mailbox.hbase.FlagConvertor

public class FlagConvertor
extends Object

Class used for converting message flags to and from byte arrays for use as HBase column qualifiers.

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	FLAGS_ANSWERED
static byte[]	FLAGS_DELETED
static byte[]	FLAGS_DRAFT
static byte[]	FLAGS_FLAGGED
static byte[]	FLAGS_RECENT
static byte[]	FLAGS_SEEN
static byte[]	FLAGS_USER
static String	PREFIX_SFLAGS
static byte[]	PREFIX_SFLAGS_B
static String	PREFIX_UFLAGS
static byte[]	PREFIX_UFLAGS_B

Constructor Summary

Constructors

Constructor and Description
FlagConvertor()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.mail.Flags.Flag	systemFlagFromBytes(byte[] bytes) Returns a Flags.Flag coresponding to the supplyed byte array.
static byte[]	systemFlagToBytes(javax.mail.Flags.Flag flag) Converts a Flags.Flag to a byte array representation used for storing in HBase (as a column qualifier).
static String	userFlagFromBytes(byte[] bytes) Converts a byte array to a user flag.
static byte[]	userFlagToBytes(String flag) Converts a user flag to a byte array for use as a HBase column qualifier.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_SFLAGS

public static final String PREFIX_SFLAGS

See Also:

Constant Field Values

PREFIX_SFLAGS_B

public static final byte[] PREFIX_SFLAGS_B

PREFIX_UFLAGS

public static final String PREFIX_UFLAGS

See Also:

Constant Field Values

PREFIX_UFLAGS_B

public static final byte[] PREFIX_UFLAGS_B

FLAGS_ANSWERED

public static final byte[] FLAGS_ANSWERED

FLAGS_DELETED

public static final byte[] FLAGS_DELETED

FLAGS_DRAFT

public static final byte[] FLAGS_DRAFT

FLAGS_FLAGGED

public static final byte[] FLAGS_FLAGGED

FLAGS_RECENT

public static final byte[] FLAGS_RECENT

FLAGS_SEEN

public static final byte[] FLAGS_SEEN

FLAGS_USER

public static final byte[] FLAGS_USER

Constructor Detail

FlagConvertor

public FlagConvertor()

Method Detail

systemFlagToBytes

public static byte[] systemFlagToBytes(javax.mail.Flags.Flag flag)

Converts a Flags.Flag to a byte array representation used for storing in HBase (as a column qualifier).

Parameters:

flag -

Returns:

a byte representation of the flag. Throws RuntimeException if Flag is not recognized.

systemFlagFromBytes

public static javax.mail.Flags.Flag systemFlagFromBytes(byte[] bytes)

Returns a Flags.Flag coresponding to the supplyed byte array.

Parameters:

bytes - byte array representation

Returns:

one of Flags.Flag

Throws:

RuntimeException - if the byte array does not match a suitable represetnation.

userFlagToBytes

public static byte[] userFlagToBytes(String flag)

Converts a user flag to a byte array for use as a HBase column qualifier.

Parameters:

flag - user flag to convert

Returns:

a byte array representation of the user flag

userFlagFromBytes

public static String userFlagFromBytes(byte[] bytes)

Converts a byte array to a user flag.

Parameters:

bytes - the user flag byte representation

Returns:

a String representaion of the user flag

Throws:

RuntimeException - if the user flag prefix is not found.