Operator (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.policy.operator.Operator

All Implemented Interfaces:

Serializable, Comparable<Operator>

Direct Known Subclasses:

ConditionOperator
```
public abstract class Operator
extends Object
implements Serializable, Comparable<Operator>
```
An XDI operator, represented as a relation.

Author:

markus

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Operator.MappingRelationOperatorIterator

Nested Classes
Modifier and Type	Class and Description
`static class`	`Operator.MappingRelationOperatorIterator`

Field Summary

Fields
Modifier and Type Field and Description

protected Relation relation

Fields
Modifier and Type	Field and Description
`protected Relation`	`relation`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Operator(Relation relation)

Constructors
Modifier	Constructor and Description
`protected`	`Operator(Relation relation)`

Method Summary

Methods
Modifier and Type	Method and Description
`static Operator`	`castOperator(Operator operator)` Factory method that casts an Operator to the right subclass, e.g. to a TruePolicyStatement.
`int`	`compareTo(Operator other)`
`boolean`	`equals(Object object)`
`Boolean[]`	`evaluate(PolicyEvaluationContext policyEvaluationContext)` Checks if the XDI policy statement evaluates to true or false.
`protected abstract Boolean[]`	`evaluateInternal(PolicyEvaluationContext policyEvaluationContext)`
`static Operator`	`fromRelation(Relation relation)` Factory method that creates an XDI operator bound to a given relation.
`Relation`	`getRelation()` Returns the underlying relation to which this XDI policy statement is bound.
`int`	`hashCode()`
`static boolean`	`isValid(Relation relation)` Checks if a relation is a valid XDI policy statement.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - relation
```
protected Relation relation
```
- Constructor Detail
  - Operator
```
protected Operator(Relation relation)
```
- Method Detail
  - isValid
```
public static boolean isValid(Relation relation)
```
    Checks if a relation is a valid XDI policy statement.
    
    Parameters:
    relation - The relation to check.
    
    Returns:
    True if the relation is a valid XDI policy statement.
  - fromRelation
```
public static Operator fromRelation(Relation relation)
```
    Factory method that creates an XDI operator bound to a given relation.
    
    Parameters:
    relation - The relation that is an XDI operator.
    
    Returns:
    The XDI operator.
  - castOperator
```
public static Operator castOperator(Operator operator)
```
    Factory method that casts an Operator to the right subclass, e.g. to a TruePolicyStatement.
    
    Parameters:
    operator - The Operator to be cast.
    
    Returns:
    The casted Operator.
  - getRelation
```
public Relation getRelation()
```
    Returns the underlying relation to which this XDI policy statement is bound.
    
    Returns:
    A relation that represents the XDI policy statement.
  - evaluate
```
public final Boolean[] evaluate(PolicyEvaluationContext policyEvaluationContext)
```
    Checks if the XDI policy statement evaluates to true or false.
    
    Parameters:
    policyEvaluationContext - An object that can locate context nodes.
    
    Returns:
    True or false.
  - evaluateInternal
```
protected abstract Boolean[] evaluateInternal(PolicyEvaluationContext policyEvaluationContext)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Operator other)
```
    Specified by:
    
    compareTo in interface Comparable<Operator>

Class Operator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

relation

Constructor Detail

Operator

Method Detail

isValid

fromRelation

castOperator

getRelation

evaluate

evaluateInternal

toString

equals

hashCode

compareTo