PolicyOperator (Direct Project policy enablement engine 7.0 API)

java.lang.Object
- java.lang.Enum<PolicyOperator>
- - org.nhindirect.policy.PolicyOperator

All Implemented Interfaces:

Serializable, Comparable<PolicyOperator>
```
public enum PolicyOperator
extends Enum<PolicyOperator>
```
Enumeration of operators supported by the policy engine. Each operator has equal precedence and are evaluated in the order they are encountered.

Since:

1.0

Author:

Greg Meyer

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BITWISE_AND` Performs a bitwise and operation against two operands.
`BITWISE_OR` Performs a bitwise or operation against two operands.
`CONTAINS` Performs a search for the existence of an object within a collection.
`CONTAINS_REG_EX` Performs a regular expressions match on a collection of strings.
`EMPTY` Performs an evaluation of the number of elements within a collection and determines if the collection is empty.
`EQUALS` Performs an equality operation against two operands.
`GREATER` Performs a greater than operation against two operands.
`INTERSECTION` Performs an intersection of two sets and returns the resulting set.
`LESS` Performs a less than operation against two operands.
`LOGICAL_AND` Performs a logical and operation against two operands.
`LOGICAL_NOT` Performs a logical not operation against a single boolean value.
`LOGICAL_OR` Performs a logical or operation against two operands.
`NOT_CONTAINS` Performs a search for the non-existence of an object within a collection.
`NOT_EMPTY` Performs an evaluation of the number of elements within a collection and determines if the collection is non-empty.
`NOT_EQUALS` Performs a non-equality operation against two operands.
`REG_EX` Performs a regular expression match on a string.
`SIZE` Performs an evaluation of the number of elements within a collection.
`URI_VALIDATE` Performs a URL validation operation against a URL.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PolicyOperator`	`fromToken(String token)` Gets the policy operator associated with a specific token string.
`Class<?>`	`getExecutorClass()` Gets the `PolicyOperator` class that performs the actual execution logic of the operator.
`String`	`getOperatorText()` Gets the plain English representation of the operator.
`String`	`getOperatorToken()` Gets the token of the operator used in a lexicon parser.
`PolicyOperatorParamsType`	`getParamsType()` Gets the `PolicyOperatorParamsType` of the operator.
`static PolicyOperator`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PolicyOperator[]`	`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
  - EQUALS
```
public static final PolicyOperator EQUALS
```
    Performs an equality operation against two operands. Equality semantics are specific the operands types.
  - NOT_EQUALS
```
public static final PolicyOperator NOT_EQUALS
```
    Performs a non-equality operation against two operands. Equality semantics are specific the operands types.
  - GREATER
```
public static final PolicyOperator GREATER
```
    Performs a greater than operation against two operands. This operation can only be performed on numeric operands.
  - LESS
```
public static final PolicyOperator LESS
```
    Performs a less than operation against two operands. This operation can only be performed on numeric operands.
  - REG_EX
```
public static final PolicyOperator REG_EX
```
    Performs a regular expression match on a string. This operation returns true if the regular expression is found in the given string and can only be performed on two strings.
  - CONTAINS
```
public static final PolicyOperator CONTAINS
```
    Performs a search for the existence of an object within a collection. This operation returns true if the object exists within the collection. One of the operands MUST be a collection of arbitrary types that will be searched.
  - NOT_CONTAINS
```
public static final PolicyOperator NOT_CONTAINS
```
    Performs a search for the non-existence of an object within a collection. This operation returns true if the object does not exist within the collection. One of the operands MUST be a collection of arbitrary types that will be searched.
  - CONTAINS_REG_EX
```
public static final PolicyOperator CONTAINS_REG_EX
```
    Performs a regular expressions match on a collection of strings. This operations returns true if one of the elements within collection matches the regular expressions. The operation can only be performed on a string a collection arbitrary types. Non string types are converted to strings using the object's toString method.
  - SIZE
```
public static final PolicyOperator SIZE
```
    Performs an evaluation of the number of elements within a collection. This operation is only performed on a single collection of arbitrary objects.
  - EMPTY
```
public static final PolicyOperator EMPTY
```
    Performs an evaluation of the number of elements within a collection and determines if the collection is empty. This operation is only performed on a single collection of arbitrary objects.
  - NOT_EMPTY
```
public static final PolicyOperator NOT_EMPTY
```
    Performs an evaluation of the number of elements within a collection and determines if the collection is non-empty. This operation is only performed on a single collection of arbitrary objects.
  - INTERSECTION
```
public static final PolicyOperator INTERSECTION
```
    Performs an intersection of two sets and returns the resulting set. This operation can only be performed on collection operands.
  - LOGICAL_OR
```
public static final PolicyOperator LOGICAL_OR
```
    Performs a logical or operation against two operands. This operation can only be performed on two boolean values. Boolean values may be the result of another boolean expression.
  - LOGICAL_AND
```
public static final PolicyOperator LOGICAL_AND
```
    Performs a logical and operation against two operands. This operation can only be performed on two boolean values. Boolean values may be the result of another boolean expression.
  - LOGICAL_NOT
```
public static final PolicyOperator LOGICAL_NOT
```
    Performs a logical not operation against a single boolean value. The boolean values may be the result of another boolean expression.
  - BITWISE_AND
```
public static final PolicyOperator BITWISE_AND
```
    Performs a bitwise and operation against two operands. This operation can only be performed on two numeric values.
  - BITWISE_OR
```
public static final PolicyOperator BITWISE_OR
```
    Performs a bitwise or operation against two operands. This operation can only be performed on two numeric values.
  - URI_VALIDATE
```
public static final PolicyOperator URI_VALIDATE
```
    Performs a URL validation operation against a URL. The URL is provided as a string, and valid indicates that the URL is syntactically correct and that it is accessible from the application performing the validation.
- Method Detail
  - values
```
public static PolicyOperator[] 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 (PolicyOperator c : PolicyOperator.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PolicyOperator 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
  - getOperatorToken
```
public String getOperatorToken()
```
    Gets the token of the operator used in a lexicon parser.
    
    Returns:
    
    The token of the operator used in a lexicon parser.
  - getOperatorText
```
public String getOperatorText()
```
    Gets the plain English representation of the operator.
    
    Returns:
    
    The plain English representation of the operator.
  - getExecutorClass
```
public Class<?> getExecutorClass()
```
    Gets the PolicyOperator class that performs the actual execution logic of the operator.
    
    Returns:
    
    The PolicyOperator class that performs the actual execution logic of the operator.
  - getParamsType
```
public PolicyOperatorParamsType getParamsType()
```
    Gets the PolicyOperatorParamsType of the operator.
    
    Returns:
    
    The PolicyOperatorParamsType of the operator.
  - fromToken
```
public static PolicyOperator fromToken(String token)
```
    Gets the policy operator associated with a specific token string.
    
    Parameters:
    
    token - The token used to look up the PolicyOperator.
    
    Returns:
    
    The PolicyOperator associated with the token. If the token does not represent a known operator, then null is returned,.

Enum PolicyOperator

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EQUALS

NOT_EQUALS

GREATER

LESS

REG_EX

CONTAINS

NOT_CONTAINS

CONTAINS_REG_EX

SIZE

EMPTY

NOT_EMPTY

INTERSECTION

LOGICAL_OR

LOGICAL_AND

LOGICAL_NOT

BITWISE_AND

BITWISE_OR

URI_VALIDATE

Method Detail

values

valueOf

getOperatorToken

getOperatorText

getExecutorClass

getParamsType

fromToken