org.apache.sling.resource.filter.impl

Class DefaultContext

java.lang.Object

org.apache.sling.resource.filter.impl.DefaultContext

All Implemented Interfaces:

Context

public class DefaultContext
extends Object
implements Context

Constructor Summary

Constructors

Constructor and Description
DefaultContext()

Method Summary

Modifier and Type	Method and Description
Context	addFunction(String name, BiFunction<Object[],org.apache.sling.api.resource.Resource,Object> functionImpl) Adds a Function to the script to allow for customization.
Context	addParameter(String name, Object object) Allows an object to be represented in the script for evaluation.
void	addParameters(Map<String,Object> params) Adds the provided Map to the underlying parameter map.
Visitor<Function<org.apache.sling.api.resource.Resource,Object>>	getComparisonVisitor() Retrieve the currently defined Comparison Visitor
Optional<BiFunction<Object[],org.apache.sling.api.resource.Resource,Object>>	getFunction(String text) Used to retrieve the function during script processing
Visitor<Predicate<org.apache.sling.api.resource.Resource>>	getLogicVisitor() Retrieve the currently defined Logic Visitor
Optional<Object>	getParameter(String text) Retrieves the value object associated with the name
Context	removeFunction(String name) Remove the function with the given name from the context.
Context	replaceParameterMap(Map<String,Object> params) Replaces the underlying parameter Map with the one provided
void	setComparionVisitor(Visitor<Function<org.apache.sling.api.resource.Resource,Object>> comparisonVisitor) Replaces the existing Comparison Visitor, if present, with the provided Visitor
void	setLogicVisitor(Visitor<Predicate<org.apache.sling.api.resource.Resource>> logicVisitor) Replaces the existing Logic Visitor, if present, with the provided Visitor

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultContext

public DefaultContext()

Method Detail

addFunction

public Context addFunction(String name,
                           BiFunction<Object[],org.apache.sling.api.resource.Resource,Object> functionImpl)

Description copied from interface: Context

Adds a Function to the script to allow for customization.

Specified by:

addFunction in interface Context

Parameters:

name - of the function as it appears in the script

functionImpl - defines the function in terms of passed in arguments, the resource that is being acted on and the return object

Returns:

this Context

removeFunction

public Context removeFunction(String name)

Description copied from interface: Context

Remove the function with the given name from the context.

Specified by:

removeFunction in interface Context

Returns:

addParameter

public Context addParameter(String name,
                            Object object)

Description copied from interface: Context

Allows an object to be represented in the script for evaluation.

Specified by:

addParameter in interface Context

Parameters:

name - of the argument

object - value that is represented

Returns:

this Context

getLogicVisitor

public Visitor<Predicate<org.apache.sling.api.resource.Resource>> getLogicVisitor()

Description copied from interface: Context

Retrieve the currently defined Logic Visitor

Specified by:

getLogicVisitor in interface Context

Returns:

Visitor

getComparisonVisitor

public Visitor<Function<org.apache.sling.api.resource.Resource,Object>> getComparisonVisitor()

Description copied from interface: Context

Retrieve the currently defined Comparison Visitor

Specified by:

getComparisonVisitor in interface Context

Returns:

Visitor

setLogicVisitor

public void setLogicVisitor(Visitor<Predicate<org.apache.sling.api.resource.Resource>> logicVisitor)

Description copied from interface: Context

Replaces the existing Logic Visitor, if present, with the provided Visitor

Specified by:

setLogicVisitor in interface Context

setComparionVisitor

public void setComparionVisitor(Visitor<Function<org.apache.sling.api.resource.Resource,Object>> comparisonVisitor)

Description copied from interface: Context

Replaces the existing Comparison Visitor, if present, with the provided Visitor

Specified by:

setComparionVisitor in interface Context

getFunction

public Optional<BiFunction<Object[],org.apache.sling.api.resource.Resource,Object>> getFunction(String text)

Description copied from interface: Context

Used to retrieve the function during script processing

Specified by:

getFunction in interface Context

Parameters:

text - of the function in the context

Returns:

Optional BiFunction object representing the name

getParameter

public Optional<Object> getParameter(String text)

Description copied from interface: Context

Retrieves the value object associated with the name

Specified by:

getParameter in interface Context

Parameters:

text - of the argument

Returns:

Optional object represented by the name

addParameters

public void addParameters(Map<String,Object> params)

Description copied from interface: Context

Adds the provided Map to the underlying parameter map.

Specified by:

addParameters in interface Context

replaceParameterMap

public Context replaceParameterMap(Map<String,Object> params)

Description copied from interface: Context

Replaces the underlying parameter Map with the one provided

Specified by:

replaceParameterMap in interface Context

Returns:

this Context