org.stekikun.dolmen.codegen

Enum Config.Relevance

java.lang.Object

java.lang.Enum<Config.Relevance>

org.stekikun.dolmen.codegen.Config.Relevance

All Implemented Interfaces:

Serializable, Comparable<Config.Relevance>

Enclosing class:

Config

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

Enumeration representing the relevance of a configuration: it can be usable only within a lexer description, a parser description, or both.

Relevance values form a semi-lattice with BOTH as a bottom element for the includes(Config.Relevance) relation.

Author:

Stéphane Lescuyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Relevant for both lexical and syntax analyzers
LEXER Only relevant to generation of lexical analyzers
PARSER Only relevant to generation of syntax analyzers

Method Summary

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

LEXER

public static final Config.Relevance LEXER

Only relevant to generation of lexical analyzers

PARSER

public static final Config.Relevance PARSER

Only relevant to generation of syntax analyzers

BOTH

public static final Config.Relevance BOTH

Relevant for both lexical and syntax analyzers

Method Detail

values

public static Config.Relevance[] 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.Relevance c : Config.Relevance.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.Relevance 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

includes

public boolean includes(Config.Relevance r)

Parameters:

r -

Returns:

whether this relevance value is more permissive than r, i.e. whether all options relevant in r are also relevant in this