Module org.refcodes.data

Package org.refcodes.data

Enum Annotator

java.lang.Object

java.lang.Enum<Annotator>

org.refcodes.data.Annotator

All Implemented Interfaces:

Serializable, Comparable<Annotator>, org.refcodes.mixin.CharAccessor

public enum Annotator
extends Enum<Annotator>
implements org.refcodes.mixin.CharAccessor

Commonly used characters to be prefixed to annotations' names to distinguish them form element names and the like.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.CharAccessor

org.refcodes.mixin.CharAccessor.CharBuilder<B extends org.refcodes.mixin.CharAccessor.CharBuilder<B>>, org.refcodes.mixin.CharAccessor.CharMutator, org.refcodes.mixin.CharAccessor.CharProperty

Enum Constant Summary

Enum Constants

Enum Constant	Description
JAVA	The annotation prefix used by the Java language ('@').

Method Summary

Modifier and Type	Method	Description
char	getChar()
static Annotator	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Annotator[]	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

JAVA

public static final Annotator JAVA

The annotation prefix used by the Java language ('@').

Method Detail

values

public static Annotator[] 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 (Annotator c : Annotator.values())
    System.out.println(c);

Returns:

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

valueOf

public static Annotator 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

getChar

public char getChar()

Specified by:

getChar in interface org.refcodes.mixin.CharAccessor