Class Foreach
- java.lang.Object
-
- org.apache.velocity.runtime.directive.Directive
-
- org.apache.velocity.runtime.directive.Foreach
-
- All Implemented Interfaces:
java.lang.Cloneable
,DirectiveConstants
public class Foreach extends Directive
Foreach directive used for moving through arrays, or objects that provide an Iterator.- Version:
- $Id: Foreach.java 945927 2010-05-18 22:21:41Z nbubna $
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
Foreach.NullHolderContext
A special context to use when the foreach iterator returns a null.
-
Field Summary
Fields Modifier and Type Field Description private int
counterInitialValue
What value to start the loop counter at.private java.lang.String
counterName
The name of the variable to use when placing the counter value into the context.private java.lang.String
elementKey
The reference name used to access each of the elements in the list object.private java.lang.String
hasNextName
The name of the variable to use when placing iterator hasNext() value into the context.Right now the defailt is $velocityHasNextprivate int
maxNbrLoops
The maximum number of times we're allowed to loop.private boolean
skipInvalidIterator
Whether or not to throw an Exception if the iterator is null.protected Info
uberInfo
immutable, so create in initprivate boolean
warned
-
Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants
BLOCK, LINE
-
-
Constructor Summary
Constructors Constructor Description Foreach()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
clean(InternalContextAdapter context, java.lang.Object o, java.lang.Object savedCounter, java.lang.Object nextFlag)
java.lang.String
getName()
Return name of this directive.int
getType()
Return type of this directive.void
init(RuntimeServices rs, InternalContextAdapter context, Node node)
simple init - init the tree and get the elementKey from the ASTprotected void
put(InternalContextAdapter context, java.lang.String key, java.lang.Object value)
Extension hook to allow subclasses to control whether loop vars are set locally or not.boolean
render(InternalContextAdapter context, java.io.Writer writer, Node node)
renders the #foreach() block-
Methods inherited from class org.apache.velocity.runtime.directive.Directive
getColumn, getLine, getScopeName, getTemplateName, isScopeProvided, makeScope, postRender, preRender, setLocation, setLocation
-
-
-
-
Field Detail
-
counterName
private java.lang.String counterName
The name of the variable to use when placing the counter value into the context. Right now the default is $velocityCount.
-
hasNextName
private java.lang.String hasNextName
The name of the variable to use when placing iterator hasNext() value into the context.Right now the defailt is $velocityHasNext
-
counterInitialValue
private int counterInitialValue
What value to start the loop counter at.
-
maxNbrLoops
private int maxNbrLoops
The maximum number of times we're allowed to loop.
-
skipInvalidIterator
private boolean skipInvalidIterator
Whether or not to throw an Exception if the iterator is null.
-
elementKey
private java.lang.String elementKey
The reference name used to access each of the elements in the list object. It is the $item in the following: #foreach ($item in $list) This can be used class wide because it is immutable.
-
warned
private boolean warned
-
uberInfo
protected Info uberInfo
immutable, so create in init
-
-
Method Detail
-
getName
public java.lang.String getName()
Return name of this directive.
-
getType
public int getType()
Return type of this directive.
-
init
public void init(RuntimeServices rs, InternalContextAdapter context, Node node) throws TemplateInitException
simple init - init the tree and get the elementKey from the AST- Overrides:
init
in classDirective
- Parameters:
rs
-context
-node
-- Throws:
TemplateInitException
-
put
protected void put(InternalContextAdapter context, java.lang.String key, java.lang.Object value)
Extension hook to allow subclasses to control whether loop vars are set locally or not. So, those in favor of VELOCITY-285, can make that happen easily by overriding this and having it use context.localPut(k,v). See VELOCITY-630 for more on this.
-
render
public boolean render(InternalContextAdapter context, java.io.Writer writer, Node node) throws java.io.IOException, MethodInvocationException, ResourceNotFoundException, ParseErrorException
renders the #foreach() block- Specified by:
render
in classDirective
- Parameters:
context
-writer
-node
-- Returns:
- True if the directive rendered successfully.
- Throws:
java.io.IOException
MethodInvocationException
ResourceNotFoundException
ParseErrorException
-
clean
protected void clean(InternalContextAdapter context, java.lang.Object o, java.lang.Object savedCounter, java.lang.Object nextFlag)
-
-