Package org.apache.velocity.runtime.parser.node

Class ASTSetDirective

java.lang.Object

org.apache.velocity.runtime.parser.node.SimpleNode

org.apache.velocity.runtime.parser.node.ASTSetDirective

All Implemented Interfaces:

Cloneable, Node, Renderable

public class ASTSetDirective
extends SimpleNode

Node for the #set directive

Version:

$Id$

Author:

Jason van Zyl, Geir Magnusson Jr.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	strictRef	Indicates if we are running in strict reference mode.
protected Info	uberInfo	This is really immutable after the init, so keep one for this node

Fields inherited from class org.apache.velocity.runtime.parser.node.SimpleNode

children, column, first, firstImage, id, info, invalid, last, lastImage, line, literal, log, parent, parser, rsvc, state, template

Constructor Summary

Constructors

Constructor	Description
ASTSetDirective(int id)
ASTSetDirective(Parser p, int id)

Method Summary

Modifier and Type	Method	Description
String	getPostfix()	get indentation postfix
String	getPrefix()	get indentation prefix
Object	init(InternalContextAdapter context, Object data)	simple init.
Object	jjtAccept(StandardParserVisitor visitor, Object data)
String	literal()	Returns the string "#set($reference = ...)".
boolean	render(InternalContextAdapter context, Writer writer)	puts the value of the RHS into the context under the key of the LHS
void	setPostfix(String postfix)	set indentation postfix
void	setPrefix(String prefix)	set indentation prefix

Methods inherited from class org.apache.velocity.runtime.parser.node.SimpleNode

childrenAccept, cleanupParserAndTokens, clone, clone, dump, dump, dump, evaluate, execute, getColumn, getFirstToken, getFirstTokenImage, getInfo, getLastToken, getLastTokenImage, getLine, getLocation, getParser, getRuntimeServices, getTemplate, getTemplateName, getType, isInvalid, jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, saveTokenImages, setFirstToken, setInfo, setInvalid, toString, toString, value

Methods inherited from class java.lang.Object

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

Field Detail

uberInfo

protected Info uberInfo

This is really immutable after the init, so keep one for this node

strictRef

protected boolean strictRef

Indicates if we are running in strict reference mode.

Constructor Detail

ASTSetDirective

public ASTSetDirective(int id)

Parameters:

id -

ASTSetDirective

public ASTSetDirective(Parser p,
                       int id)

Parameters:

p -

id -

Method Detail

jjtAccept

public Object jjtAccept(StandardParserVisitor visitor,
                        Object data)

Specified by:

jjtAccept in interface Node

Overrides:

jjtAccept in class SimpleNode

Returns:

The Node execution result object.

See Also:

SimpleNode.jjtAccept(org.apache.velocity.runtime.parser.node.StandardParserVisitor, java.lang.Object)

init

public Object init(InternalContextAdapter context,
                   Object data)
            throws TemplateInitException

simple init. We can get the RHS and LHS as the the tree structure is static

Specified by:

init in interface Node

Overrides:

init in class SimpleNode

Parameters:

context -

data -

Returns:

Init result.

Throws:

TemplateInitException

See Also:

Node.init(org.apache.velocity.context.InternalContextAdapter, java.lang.Object)

setPrefix

public void setPrefix(String prefix)

set indentation prefix

Parameters:

prefix -

getPrefix

public String getPrefix()

get indentation prefix

Returns:

indentation prefix

setPostfix

public void setPostfix(String postfix)

set indentation postfix

Parameters:

postfix -

getPostfix

public String getPostfix()

get indentation postfix

Returns:

indentation prefix

render

public boolean render(InternalContextAdapter context,
                      Writer writer)
               throws IOException,
                      MethodInvocationException

puts the value of the RHS into the context under the key of the LHS

Specified by:

render in interface Node

Specified by:

render in interface Renderable

Overrides:

render in class SimpleNode

Parameters:

context -

writer -

Returns:

True if rendering was sucessful.

Throws:

IOException

MethodInvocationException

See Also:

Node.render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)

literal

public String literal()

Returns the string "#set($reference = ...)". RHS is not rendered. This method is only used for displaying the VTL stacktrace when a rendering error is encountered when runtime.log.track_location is true.

Specified by:

literal in interface Node

Overrides:

literal in class SimpleNode

Returns:

See Also:

Node.literal()