org.apache.brooklyn.camp.spi.resolve

Class PlanInterpreter.PlanInterpreterAdapter

java.lang.Object

org.apache.brooklyn.camp.spi.resolve.PlanInterpreter.PlanInterpreterAdapter

All Implemented Interfaces:

PlanInterpreter

Enclosing interface:

PlanInterpreter

public abstract static class PlanInterpreter.PlanInterpreterAdapter
extends Object
implements PlanInterpreter

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.camp.spi.resolve.PlanInterpreter

PlanInterpreter.PlanInterpreterAdapter

Constructor Summary

Constructors

Constructor and Description
PlanInterpreter.PlanInterpreterAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyListAfter(PlanInterpretationNode node, List<Object> listIn, List<Object> listOut) as PlanInterpreter.applyMapAfter(PlanInterpretationNode, Map, Map) but for lists
boolean	applyListBefore(PlanInterpretationNode node, List<Object> listIn) as PlanInterpreter.applyMapBefore(PlanInterpretationNode, Map) but for lists
boolean	applyListEntry(PlanInterpretationNode node, List<Object> listIn, List<Object> listOut, PlanInterpretationNode value) as {@link #applyMapEntry(PlanInterpretationNode, Map, Map, PlanInterpretationNode, PlanInterpretationNode) but for lists
void	applyMapAfter(PlanInterpretationNode node, Map<Object,Object> mapIn, Map<Object,Object> mapOut) invoked at a Map node in a YAML tree, after all entries have been passed to all interpreters' PlanInterpreter.applyMapEntry(PlanInterpretationNode, Map, Map, PlanInterpretationNode, PlanInterpretationNode).
boolean	applyMapBefore(PlanInterpretationNode node, Map<Object,Object> mapIn) invoked at a Map node in a YAML tree, before any conversion to mapOut.
boolean	applyMapEntry(PlanInterpretationNode node, Map<Object,Object> mapIn, Map<Object,Object> mapOut, PlanInterpretationNode key, PlanInterpretationNode value) invoked at a Map node in a YAML tree, after PlanInterpreter.applyMapBefore(PlanInterpretationNode, Map), and after recursing into the value and then key arguments supplied here, but before inserting it into the mapOut for this node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.brooklyn.camp.spi.resolve.PlanInterpreter

applyYamlPrimitive, isInterestedIn

Constructor Detail

PlanInterpreter.PlanInterpreterAdapter

public PlanInterpreter.PlanInterpreterAdapter()

Method Detail

applyMapBefore

public boolean applyMapBefore(PlanInterpretationNode node,
                     Map<Object,Object> mapIn)

Description copied from interface: PlanInterpreter

invoked at a Map node in a YAML tree, before any conversion to mapOut. mapIn is initially a copy of PlanInterpretationNode#get(), but it is mutable, and any mutations are passed to subsequent interpreters and used for recursion.

the return value indicates whether to recurse into the item. if any interpreters return false, the node is not recursed. (callers may use PlanInterpretationNode.setNewValue(Object) to set a custom return value.)

Specified by:

applyMapBefore in interface PlanInterpreter

applyMapEntry

public boolean applyMapEntry(PlanInterpretationNode node,
                    Map<Object,Object> mapIn,
                    Map<Object,Object> mapOut,
                    PlanInterpretationNode key,
                    PlanInterpretationNode value)

Description copied from interface: PlanInterpreter

invoked at a Map node in a YAML tree, after PlanInterpreter.applyMapBefore(PlanInterpretationNode, Map), and after recursing into the value and then key arguments supplied here, but before inserting it into the mapOut for this node.

the return value indicates whether to add this key-value to the mapOut. if any interpreters return false, the entry is not added. (callers may modify mapOut to add/change values, or may modify key/value directly.)

Specified by:

applyMapEntry in interface PlanInterpreter

applyMapAfter

public void applyMapAfter(PlanInterpretationNode node,
                 Map<Object,Object> mapIn,
                 Map<Object,Object> mapOut)

Description copied from interface: PlanInterpreter

invoked at a Map node in a YAML tree, after all entries have been passed to all interpreters' PlanInterpreter.applyMapEntry(PlanInterpretationNode, Map, Map, PlanInterpretationNode, PlanInterpretationNode). mapOut can be modified yet further.

Specified by:

applyMapAfter in interface PlanInterpreter

applyListBefore

public boolean applyListBefore(PlanInterpretationNode node,
                      List<Object> listIn)

Description copied from interface: PlanInterpreter

as PlanInterpreter.applyMapBefore(PlanInterpretationNode, Map) but for lists

Specified by:

applyListBefore in interface PlanInterpreter

applyListEntry

public boolean applyListEntry(PlanInterpretationNode node,
                     List<Object> listIn,
                     List<Object> listOut,
                     PlanInterpretationNode value)

Description copied from interface: PlanInterpreter

as {@link #applyMapEntry(PlanInterpretationNode, Map, Map, PlanInterpretationNode, PlanInterpretationNode) but for lists

Specified by:

applyListEntry in interface PlanInterpreter

applyListAfter

public void applyListAfter(PlanInterpretationNode node,
                  List<Object> listIn,
                  List<Object> listOut)

Description copied from interface: PlanInterpreter

as PlanInterpreter.applyMapAfter(PlanInterpretationNode, Map, Map) but for lists

Specified by:

applyListAfter in interface PlanInterpreter