org.nhindirect.policy

Enum PolicyLexicon

java.lang.Object

java.lang.Enum<PolicyLexicon>

org.nhindirect.policy.PolicyLexicon

All Implemented Interfaces:

Serializable, Comparable<PolicyLexicon>

public enum PolicyLexicon
extends Enum<PolicyLexicon>

Lexicons are canonical formats of a PolicyExpression represented by a defined set of tokens and a grammar. Expressions written in a given lexicon are parsed by a PolicyLexiconParser and translated into PolicyExpression. The PolicyExpression can be thought of an intermediate state of the policy in the overall policy engine process.
This enumeration lists the supported lexicons by the policy engine.

Since:

1.0

Author:

Greg Meyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
JAVA_SER Java serialized object format of a PolicyExpression.
SIMPLE_TEXT_V1 Simple text version 1 lexicon
XML XML Serialized format of a PolicyExpression.

Method Summary

Modifier and Type	Method and Description
Class<? extends PolicyLexiconParser>	getParserClass() Gets the PolicyLexiconParser class that will be used to parse the specific lexicon.
static PolicyLexicon	valueOf(String name) Returns the enum constant of this type with the specified name.
static PolicyLexicon[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final PolicyLexicon XML

XML Serialized format of a PolicyExpression.

JAVA_SER

public static final PolicyLexicon JAVA_SER

Java serialized object format of a PolicyExpression.

SIMPLE_TEXT_V1

public static final PolicyLexicon SIMPLE_TEXT_V1

Simple text version 1 lexicon

Method Detail

values

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

Returns:

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

valueOf

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

getParserClass

public Class<? extends PolicyLexiconParser> getParserClass()

Gets the PolicyLexiconParser class that will be used to parse the specific lexicon.

Returns:

The PolicyLexiconParser class that will be used to parse the specific lexicon.