net.morimekta.providence.reflect.util

Enum ThriftAnnotation

java.lang.Object

java.lang.Enum<ThriftAnnotation>

net.morimekta.providence.reflect.util.ThriftAnnotation

All Implemented Interfaces:

Serializable, Comparable<ThriftAnnotation>

public enum ThriftAnnotation
extends Enum<ThriftAnnotation>

Enum containing known "general" thrift annotations.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPACT If a struct can use a compact serialized format.
CONTAINER Whether a set-like container are normal (hash-), ordered (linked-hash-) or sorted (tree-).
DEPRECATED If the field, message, service or method is not supposed to be used any more.
JAVA_EXCEPTION_CLASS
JAVA_IMPLEMENTS Add extra interfaces to
NONE

Field Summary

Fields

Modifier and Type	Field and Description
String	tag

Method Summary

Modifier and Type	Method and Description
static ThriftAnnotation	forTag(String tag)
static ThriftAnnotation	valueOf(String name) Returns the enum constant of this type with the specified name.
static ThriftAnnotation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final ThriftAnnotation NONE

CONTAINER

public static final ThriftAnnotation CONTAINER

Whether a set-like container are normal (hash-), ordered (linked-hash-) or sorted (tree-). Valid for set and map type fields. container = "ORDERED"

DEPRECATED

public static final ThriftAnnotation DEPRECATED

If the field, message, service or method is not supposed to be used any more. Whatever is in the value part may be used as the 'deprecated' reason.

COMPACT

public static final ThriftAnnotation COMPACT

If a struct can use a compact serialized format. Only valid for struct, not for union and exception. compact = ""

JAVA_IMPLEMENTS

public static final ThriftAnnotation JAVA_IMPLEMENTS

Add extra interfaces to

JAVA_EXCEPTION_CLASS

public static final ThriftAnnotation JAVA_EXCEPTION_CLASS

Field Detail

tag

public final String tag

Method Detail

values

public static ThriftAnnotation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ThriftAnnotation c : ThriftAnnotation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ThriftAnnotation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

forTag

public static ThriftAnnotation forTag(String tag)