org.kuali.rice.krms.api.repository

Enum LogicalOperator

java.lang.Object

java.lang.Enum<LogicalOperator>

org.kuali.rice.krms.api.repository.LogicalOperator

All Implemented Interfaces:

Serializable, Comparable<LogicalOperator>, Coded

public enum LogicalOperator
extends Enum<LogicalOperator>
implements Coded

Enum for the representation of the Logical Operators AND OR

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND use this flag with the static factory to get a LogicalOperator AND
OR use this flag with the static factory to get a LogicalOperator OR

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	OP_CODE_NAMES Collection OP_CODE_NAMES
static Collection<String>	OP_CODES Collection OP_CODES

Method Summary

Methods

Modifier and Type	Method and Description
static LogicalOperator	fromCode(String code) Create a LogicalOperator from the given code
String	getCode() The code value for this object.
String	toString()
static LogicalOperator	valueOf(String name) Returns the enum constant of this type with the specified name.
static LogicalOperator[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AND

public static final LogicalOperator AND

use this flag with the static factory to get a LogicalOperator AND

OR

public static final LogicalOperator OR

use this flag with the static factory to get a LogicalOperator OR

Field Detail

OP_CODES

public static final Collection<String> OP_CODES

Collection OP_CODES

OP_CODE_NAMES

public static final Collection<String> OP_CODE_NAMES

Collection OP_CODE_NAMES

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

Description copied from interface: Coded

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

fromCode

public static LogicalOperator fromCode(String code)

Create a LogicalOperator from the given code

Parameters:

code - used to type LogicalOperator

Returns:

LogicalOperator whose code is given

Throws:

IllegalArgumentException - if the code does not exist

toString

public String toString()

Overrides:

toString in class Enum<LogicalOperator>