Class ASTReference
java.lang.Object
org.apache.velocity.runtime.parser.node.SimpleNode
org.apache.velocity.runtime.parser.node.ASTReference
- All Implemented Interfaces:
Node
,Renderable
This class is responsible for handling the references in
VTL ($foo).
Please look at the Parser.jjt file which is
what controls the generation of this class.
- Version:
- $Id$
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private ASTExpression
non null Indicates that an alternate value has been providedprivate ASTIndex
non null Indicates if we are setting an index reference e.g, $foo[2], which basically means that the last syntax of the reference are brackets.private boolean
private boolean
private boolean
private String
private static final int
private String
private boolean
private boolean
private String
private static final int
private String
private int
private static final int
private int
private String
private static final int
boolean
Indicates if we are using modified escape behavior in strict mode.boolean
Indicates if we are running in strict reference mode.protected Info
private boolean
Whether to trigger an event for invalid null references, that is when a value is present in the context or parent object but is nullprivate boolean
Whether to trigger an event for invalid quiet referencesprivate boolean
Whether to trigger an event for invalid tested references - as in #if($foo) -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
evaluate
(InternalContextAdapter context) Computes boolean value of this reference Returns the actual value of reference return type boolean, and 'true' if value is not nullexecute
(Object o, InternalContextAdapter context) gets an Object that 'is' the value of the referenceprivate String
getNullString
(InternalContextAdapter context) This method helps to implement the "render literal if null" functionality.private String
getRoot()
Returns the 'root string', the reference keyinit
(InternalContextAdapter context, Object data) jjtAccept
(ParserVisitor visitor, Object data) static String
printClass
(Class<?> clazz) Utility class to handle nulls when printing a class typeboolean
render
(InternalContextAdapter context, Writer writer) gets the value of the reference and outputs it to the writer.boolean
setValue
(InternalContextAdapter context, Object value) Sets the value of a complex reference (something like $foo.bar) Currently used by ASTSetReference()value
(InternalContextAdapter context) Methods inherited from class org.apache.velocity.runtime.parser.node.SimpleNode
childrenAccept, cleanupParserAndTokens, dump, dump, dump, getColumn, getFirstToken, getFirstTokenImage, getInfo, getLastToken, getLastTokenImage, getLine, getLocation, getParser, getRuntimeServices, getTemplate, getTemplateName, getType, isInvalid, jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, literal, saveTokenImages, setFirstToken, setInfo, setInvalid, toString, toString
-
Field Details
-
NORMAL_REFERENCE
private static final int NORMAL_REFERENCE- See Also:
-
FORMAL_REFERENCE
private static final int FORMAL_REFERENCE- See Also:
-
QUIET_REFERENCE
private static final int QUIET_REFERENCE- See Also:
-
RUNT
private static final int RUNT- See Also:
-
referenceType
private int referenceType -
nullString
-
alternateNullStringKey
-
rootString
-
escaped
private boolean escaped -
computableReference
private boolean computableReference -
logOnNull
private boolean logOnNull -
lookupAlternateLiteral
private boolean lookupAlternateLiteral -
escPrefix
-
morePrefix
-
identifier
-
checkEmpty
private boolean checkEmpty -
strictRef
public boolean strictRefIndicates if we are running in strict reference mode. -
astIndex
non null Indicates if we are setting an index reference e.g, $foo[2], which basically means that the last syntax of the reference are brackets. -
astAlternateValue
non null Indicates that an alternate value has been provided -
strictEscape
public boolean strictEscapeIndicates if we are using modified escape behavior in strict mode. mainly we allow \$abc -> to render as $abc -
numChildren
private int numChildren -
warnInvalidQuietReferences
private boolean warnInvalidQuietReferencesWhether to trigger an event for invalid quiet references- Since:
- 2.2
-
warnInvalidNullReferences
private boolean warnInvalidNullReferencesWhether to trigger an event for invalid null references, that is when a value is present in the context or parent object but is null- Since:
- 2.2
-
warnInvalidTestedReferences
private boolean warnInvalidTestedReferencesWhether to trigger an event for invalid tested references - as in #if($foo)- Since:
- 2.2
-
uberInfo
-
-
Constructor Details
-
ASTReference
public ASTReference(int id) - Parameters:
id
-
-
ASTReference
- Parameters:
p
-id
-
-
-
Method Details
-
jjtAccept
- Specified by:
jjtAccept
in interfaceNode
- Overrides:
jjtAccept
in classSimpleNode
- Parameters:
visitor
-data
-- Returns:
- The Node execution result object.
- See Also:
-
init
- Specified by:
init
in interfaceNode
- Overrides:
init
in classSimpleNode
- Parameters:
context
-data
-- Returns:
- The init result.
- Throws:
TemplateInitException
- See Also:
-
getRootString
Returns the 'root string', the reference key- Returns:
- the root string.
-
execute
gets an Object that 'is' the value of the reference- Specified by:
execute
in interfaceNode
- Overrides:
execute
in classSimpleNode
- Parameters:
o
- Object parameter, unused per se, but non-null by convention inside an #if/#elseif evaluationcontext
- context used to generate value- Returns:
- The execution result.
- Throws:
MethodInvocationException
- See Also:
-
render
public boolean render(InternalContextAdapter context, Writer writer) throws IOException, MethodInvocationException gets the value of the reference and outputs it to the writer.- Specified by:
render
in interfaceNode
- Specified by:
render
in interfaceRenderable
- Overrides:
render
in classSimpleNode
- Parameters:
context
- context of data to use in getting valuewriter
- writer to render to- Returns:
- True if rendering was successful.
- Throws:
IOException
MethodInvocationException
- See Also:
-
getNullString
This method helps to implement the "render literal if null" functionality. VelocimacroProxy saves references to macro arguments (AST nodes) so that if we have a macro #foobar($a $b) then there is key "$a.literal" which points to the literal presentation of the argument provided to variable $a. If the value of $a is null, we render the string that was provided as the argument.- Parameters:
context
-- Returns:
-
evaluate
Computes boolean value of this reference Returns the actual value of reference return type boolean, and 'true' if value is not null- Specified by:
evaluate
in interfaceNode
- Overrides:
evaluate
in classSimpleNode
- Parameters:
context
- context to compute value with- Returns:
- True if evaluation was ok.
- Throws:
MethodInvocationException
- See Also:
-
value
- Specified by:
value
in interfaceNode
- Overrides:
value
in classSimpleNode
- Parameters:
context
-- Returns:
- The node value.
- Throws:
MethodInvocationException
- See Also:
-
printClass
Utility class to handle nulls when printing a class type- Parameters:
clazz
-- Returns:
- class name, or the string "null"
-
setValue
public boolean setValue(InternalContextAdapter context, Object value) throws MethodInvocationException Sets the value of a complex reference (something like $foo.bar) Currently used by ASTSetReference()- Parameters:
context
- context object containing this referencevalue
- Object to set as value- Returns:
- true if successful, false otherwise
- Throws:
MethodInvocationException
- See Also:
-
getRoot
-
getRootVariableValue
- Parameters:
context
-- Returns:
- The evaluated value of the variable.
- Throws:
MethodInvocationException
-