org.stekikun.dolmen.codegen

Enum Config.Keys

java.lang.Object

java.lang.Enum<Config.Keys>

org.stekikun.dolmen.codegen.Config.Keys

All Implemented Interfaces:

Serializable, Comparable<Config.Keys>

Enclosing class:

Config

public static enum Config.Keys
extends Enum<Config.Keys>

Enumeration of the keys for configurable options.

Each option is characterized by its key name, which is the name that can be used in grammar descriptions to specify the option's value, and by a parser function used to interpret the associated string value. The parser function must either return an object of a type suitable for the option, or must throw an IllegalArgumentException.

Author:

Stéphane Lescuyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ClassAnnotations
Positions
TokenAnnotations

Field Summary

Fields

Modifier and Type	Field and Description
Object	defaultValue Default value of the option associated to that key
static Map<String,Config.Keys>	fromName
String	key Name of the key
Function<String,Object>	parser Parser function for the option value
Config.Relevance	relevance Relevance of the option associated to that key

Method Summary

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

Positions

public static final Config.Keys Positions

TokenAnnotations

public static final Config.Keys TokenAnnotations

ClassAnnotations

public static final Config.Keys ClassAnnotations

Field Detail

relevance

public final Config.Relevance relevance

Relevance of the option associated to that key

key

public final String key

Name of the key

defaultValue

public final Object defaultValue

Default value of the option associated to that key

parser

public final Function<String,Object> parser

Parser function for the option value

fromName

public static final Map<String,Config.Keys> fromName

Method Detail

values

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

Returns:

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

valueOf

public static Config.Keys 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