Policy (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.features.policy.Policy

All Implemented Interfaces:

Serializable, Comparable<Policy>

Direct Known Subclasses:

PolicyAnd, PolicyNot, PolicyOr, PolicyRoot
```
public abstract class Policy
extends Object
implements Serializable, Comparable<Policy>
```
An XDI policy, represented as a context node.

Author:

markus

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Policy.MappingXdiEntityPolicyAndIterator`
`static class`	`Policy.MappingXdiEntityPolicyIterator`
`static class`	`Policy.MappingXdiEntityPolicyNotIterator`
`static class`	`Policy.MappingXdiEntityPolicyOrIterator`
`static class`	`Policy.MappingXdiEntityPolicyRootIterator`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Policy(XdiEntity xdiEntity)

Constructors
Modifier	Constructor and Description
`protected`	`Policy(XdiEntity xdiEntity)`

Method Summary

Methods
Modifier and Type	Method and Description
`static Policy`	`castCondition(Policy policy)` Factory method that casts a Policy to the right subclass, e.g. to a PolicyAnd.
`int`	`compareTo(Policy other)`
`PolicyAnd`	`createAndPolicy(boolean singleton)` Creates an XDI $and policy.
`PolicyNot`	`createNotPolicy(boolean singleton)` Creates an XDI $not policy.
`PolicyOr`	`createOrPolicy(boolean singleton)` Creates an XDI $or policy.
`boolean`	`equals(Object object)`
`Boolean`	`evaluate(PolicyEvaluationContext policyEvaluationContext)` Checks if the XDI policy evaluates to true or false.
`protected abstract Boolean`	`evaluateInternal(PolicyEvaluationContext policyEvaluationContext)`
`static Policy`	`fromXdiEntity(XdiEntity xdiEntity)` Factory method that creates an XDI policy bound to a given XDI entity.
`ContextNode`	`getContextNode()` Returns the underlying context node to which this XDI policy is bound.
`ReadOnlyIterator<Operator>`	`getOperators()` Returns the XDI operators underneath this XDI policy.
`ReadOnlyIterator<Policy>`	`getPolicies()` Returns the XDI policies underneath this XDI policy.
`XDIArc`	`getPolicyXDIArc()` Returns the policy arc of the XDI policy (e.g.
`XdiEntity`	`getXdiEntity()` Returns the underlying XDI entity to which this XDI policy is bound.
`int`	`hashCode()`
`static boolean`	`isValid(XdiEntity xdiEntity)` Checks if an XDI entity is a valid XDI policy.
`String`	`toString()`

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

- Constructor Detail
  - Policy
```
protected Policy(XdiEntity xdiEntity)
```
- Method Detail
  - isValid
```
public static boolean isValid(XdiEntity xdiEntity)
```
    Checks if an XDI entity is a valid XDI policy.
    
    Parameters:
    xdiEntity - The XDI entity to check.
    
    Returns:
    True if the XDI entity is a valid XDI policy.
  - fromXdiEntity
```
public static Policy fromXdiEntity(XdiEntity xdiEntity)
```
    Factory method that creates an XDI policy bound to a given XDI entity.
    
    Parameters:
    xdiEntity - The XDI entity that is an XDI policy.
    
    Returns:
    The XDI entity.
  - castCondition
```
public static Policy castCondition(Policy policy)
```
    Factory method that casts a Policy to the right subclass, e.g. to a PolicyAnd.
    
    Parameters:
    policy - The Policy to be cast.
    
    Returns:
    The casted Policy.
  - getXdiEntity
```
public XdiEntity getXdiEntity()
```
    Returns the underlying XDI entity to which this XDI policy is bound.
    
    Returns:
    An XDI entity that represents the XDI policy.
  - getContextNode
```
public ContextNode getContextNode()
```
    Returns the underlying context node to which this XDI policy is bound.
    
    Returns:
    A context node that represents the XDI policy.
  - getPolicyXDIArc
```
public XDIArc getPolicyXDIArc()
```
    Returns the policy arc of the XDI policy (e.g. $and, $or).
    
    Returns:
    The policy arc of the XDI policy.
  - createAndPolicy
```
public PolicyAnd createAndPolicy(boolean singleton)
```
    Creates an XDI $and policy.
  - createOrPolicy
```
public PolicyOr createOrPolicy(boolean singleton)
```
    Creates an XDI $or policy.
  - createNotPolicy
```
public PolicyNot createNotPolicy(boolean singleton)
```
    Creates an XDI $not policy.
  - getPolicies
```
public ReadOnlyIterator<Policy> getPolicies()
```
    Returns the XDI policies underneath this XDI policy.
  - getOperators
```
public ReadOnlyIterator<Operator> getOperators()
```
    Returns the XDI operators underneath this XDI policy.
  - evaluate
```
public final Boolean evaluate(PolicyEvaluationContext policyEvaluationContext)
```
    Checks if the XDI policy 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(Policy other)
```
    Specified by:
    
    compareTo in interface Comparable<Policy>

Class Policy

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Policy

Method Detail

isValid

fromXdiEntity

castCondition

getXdiEntity

getContextNode

getPolicyXDIArc

createAndPolicy

createOrPolicy

createNotPolicy

getPolicies

getOperators

evaluate

evaluateInternal

toString

equals

hashCode

compareTo