org.ujac.util.template
Class ForeachToken

java.lang.Object
  org.ujac.util.template.TemplateToken
      org.ujac.util.template.TemplateTokenContainer
          org.ujac.util.template.ForeachToken

All Implemented Interfaces:

Serializable, Cloneable

public class ForeachToken
extends TemplateTokenContainer

Name: ForeachToken
Description: Represents a _foreach_ statement.

Author:

lauerc

See Also:

Serialized Form

Field Summary

static TokenAncestor[]

ancestorRules The ancestor rules.

Fields inherited from class org.ujac.util.template.TemplateTokenContainer

procedureRegistry

Fields inherited from class org.ujac.util.template.TemplateToken

interpreter, nextLegalAncestor, parent, position, source

Constructor Summary

ForeachToken()
Constructs a ForeachToken instance with no specific attributes.

Method Summary

Object	clone()
protected TemplateToken	cloneToken(BaseTemplateInterpreter interpreter, TemplateTokenContainer parent) Clones the token for caching reasons.
void	execute(Writer writer, TemplateContext ctx) Excecutes the statement token.
TokenAncestor[]	getAncestorRules() Gets the ancestor rules for this template.
protected String	getArgumentsAsString() Gets the argument list as string.
String	getTokenName() Gets the token name.
void	initialize(BaseTemplateInterpreter interpreter, char[] source, int position, int length) Initializes the token.
void	setArgument(Operand argument, int idx) Sets an argument.
String	toString()

Methods inherited from class org.ujac.util.template.TemplateTokenContainer

addToken, clearTokens, cloneChildTokens, close, getBodyEnd, getBodyStart, getProcedureRegistry, getToken, getTokenCount, isBodyToken, isClosed, setBodyStart, setProcedureRegistry

Methods inherited from class org.ujac.util.template.TemplateToken

checkContainer, getEndPosition, getIndention, getLength, getLevel, getParent, getPosition, getSource, isLegalAncestor, isLegalAncestor, parseArguments, parseArguments, setLength, setLevel, setParent

Methods inherited from class java.lang.Object

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

Field Detail

ancestorRules

public static final TokenAncestor[] ancestorRules

The ancestor rules.

Constructor Detail

ForeachToken

public ForeachToken()

Constructs a ForeachToken instance with no specific attributes.

Method Detail

getTokenName

public String getTokenName()

Gets the token name.

Overrides:

getTokenName in class TemplateToken

Returns:

The token name.

getAncestorRules

public TokenAncestor[] getAncestorRules()

Gets the ancestor rules for this template.

Overrides:

getAncestorRules in class TemplateToken

Returns:

An array of template ancestors.

initialize

public void initialize(BaseTemplateInterpreter interpreter,
                       char[] source,
                       int position,
                       int length)
                throws TemplateException

Initializes the token.

Overrides:

initialize in class TemplateToken

Parameters:

interpreter - The template interpreter.

source - The source code.

position - The start position.

length - The length of the interresting area.

Throws:

TemplateException - In case the initialization failed.

setArgument

public void setArgument(Operand argument,
                        int idx)
                 throws StatementException

Sets an argument.

Specified by:

setArgument in class TemplateToken

Parameters:

argument - The argument to set.

idx - The argument index.

Throws:

StatementException - In case the given argument is not valid.

execute

public void execute(Writer writer,
                    TemplateContext ctx)
             throws TemplateException,
                    IOException

Excecutes the statement token.

Specified by:

execute in class TemplateToken

Parameters:

writer - The writer to write to.

ctx - The template context.

Throws:

TemplateException - If the token could not be successfuly executed.

IOException - In case an output failure occurred.

toString

public String toString()

Overrides:

toString in class TemplateTokenContainer

See Also:

Object.toString()

getArgumentsAsString

protected String getArgumentsAsString()

Description copied from class: TemplateToken

Gets the argument list as string.

Overrides:

getArgumentsAsString in class TemplateToken

Returns:

The arguements as a comma separated text.

See Also:

TemplateToken.getArgumentsAsString()

cloneToken

protected TemplateToken cloneToken(BaseTemplateInterpreter interpreter,
                                   TemplateTokenContainer parent)

Clones the token for caching reasons.

Specified by:

cloneToken in class TemplateToken

Parameters:

interpreter - The interpreter to use.

parent - The actual parent in the cloned object tree.

Returns:

The clone.

clone

public Object clone()

Overrides:

clone in class Object

See Also:

Object.clone()