org.wso2.balana.cond

Class GeneralSetFunction

java.lang.Object

org.wso2.balana.cond.FunctionBase

org.wso2.balana.cond.SetFunction

org.wso2.balana.cond.GeneralSetFunction

All Implemented Interfaces:

Expression, Function

public class GeneralSetFunction
extends SetFunction

Specific SetFunction class that supports all of the general-purpose set functions: type-intersection and type-union.

Since:

1.2

Author:

Seth Proctor

Field Summary

Fields inherited from class org.wso2.balana.cond.SetFunction

baseTypes, baseTypes2, NAME_BASE_AT_LEAST_ONE_MEMBER_OF, NAME_BASE_INTERSECTION, NAME_BASE_SET_EQUALS, NAME_BASE_SUBSET, NAME_BASE_UNION, simpleTypes, simpleTypes2

Fields inherited from class org.wso2.balana.cond.FunctionBase

FUNCTION_NS, FUNCTION_NS_2, FUNCTION_NS_3

Constructor Summary

Constructors

Constructor and Description
GeneralSetFunction(String functionName) Constructor that is used to create one of the general-purpose standard set functions.
GeneralSetFunction(String functionName, String datatype, String functionType) Constructor that is used to create instances of general-purpose set functions for new (non-standard) datatypes.

Method Summary

Modifier and Type	Method and Description
EvaluationResult	evaluate(List inputs, EvaluationCtx context) Evaluates the function, using the specified parameters.
static Set	getSupportedIdentifiers() Returns a Set containing all the function identifiers supported by this class.

Methods inherited from class org.wso2.balana.cond.SetFunction

getAtLeastOneInstance, getIntersectionInstance, getSetEqualsInstance, getSubsetInstance, getUnionInstance

Methods inherited from class org.wso2.balana.cond.FunctionBase

checkInputs, checkInputsNoBag, encode, encode, evalArgs, getFunctionId, getFunctionName, getIdentifier, getReturnType, getReturnTypeAsString, getType, makeProcessingError, returnsBag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeneralSetFunction

public GeneralSetFunction(String functionName)

Constructor that is used to create one of the general-purpose standard set functions. The name supplied must be one of the standard XACML functions supported by this class, including the full namespace, otherwise an exception is thrown. Look in SetFunction for details about the supported names.

Parameters:

functionName - the name of the function to create

Throws:

IllegalArgumentException - if the function is unknown

GeneralSetFunction

public GeneralSetFunction(String functionName,
                          String datatype,
                          String functionType)

Constructor that is used to create instances of general-purpose set functions for new (non-standard) datatypes. This is equivalent to using the getInstance methods in SetFunction and is generally only used by the run-time configuration code.

Parameters:

functionName - the name of the new function

datatype - the full identifier for the supported datatype

functionType - which kind of Set function, based on the NAME_BASE_* fields

Method Detail

getSupportedIdentifiers

public static Set getSupportedIdentifiers()

Returns a Set containing all the function identifiers supported by this class.

Returns:

a Set of Strings

evaluate

public EvaluationResult evaluate(List inputs,
                                 EvaluationCtx context)

Evaluates the function, using the specified parameters.

Parameters:

inputs - a List of Evaluatable objects representing the arguments passed to the function

context - an EvaluationCtx so that the Evaluatable objects can be evaluated

Returns:

an EvaluationResult representing the function's result