Package net.sf.jett.model

Class BaseLoopTagStatus

java.lang.Object

net.sf.jett.model.BaseLoopTagStatus

All Implemented Interfaces:

LoopTagStatus

Direct Known Subclasses:

ForLoopTagStatus

public class BaseLoopTagStatus
extends java.lang.Object
implements LoopTagStatus

A BaseLoopTagStatus represents information about the current iteration of a looping tag.

Since:

0.9.1

Author:

Randy Gettman

Constructor Summary

Constructors

Constructor	Description
BaseLoopTagStatus(int currIteration, int numIterations)	Constructs a BaseLoopTagStatus with the given number of iterations and the current iteration number.
BaseLoopTagStatus(Tag tag, int numIterations)	Constructs a BaseLoopTagStatus with the given number of iterations and a current index of 0.

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Returns the current index.
int	getNumIterations()	Returns the number of iterations.
void	incrementIndex(Tag tag)	Increments the current index, if the given tag is this object's parent tag.
boolean	isFirst()	Returns whether the current iteration is the first iteration.
boolean	isLast()	Returns whether the current iteration is the last iteration.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseLoopTagStatus

public BaseLoopTagStatus(Tag tag,
                         int numIterations)

Constructs a BaseLoopTagStatus with the given number of iterations and a current index of 0.

Parameters:

tag - The parent Tag. This is only used to protect the incrementIndex(net.sf.jett.tag.Tag) method so only the parent tag can call it, not code in templates.

numIterations - The total number of iterations.

BaseLoopTagStatus

public BaseLoopTagStatus(int currIteration,
                         int numIterations)

Constructs a BaseLoopTagStatus with the given number of iterations and the current iteration number. Because there is no parent tag, the current iteration number cannot be changed.

Parameters:

currIteration - The current iteration number. This must be at least 0 and it must be less than numIterations.

numIterations - The total number of iterations.

Method Detail

getIndex

public int getIndex()

Returns the current index.

Specified by:

getIndex in interface LoopTagStatus

Returns:

The current index.

isFirst

public boolean isFirst()

Returns whether the current iteration is the first iteration.

Specified by:

isFirst in interface LoopTagStatus

Returns:

Whether the current iteration is the first iteration.

isLast

public boolean isLast()

Returns whether the current iteration is the last iteration.

Specified by:

isLast in interface LoopTagStatus

Returns:

Whether the current iteration is the last iteration.

getNumIterations

public int getNumIterations()

Returns the number of iterations.

Returns:

The number of iterations.

incrementIndex

public void incrementIndex(Tag tag)

Increments the current index, if the given tag is this object's parent tag. This check is so only the Tag that owns this object can change the current iteration number, and not some code in a template.

Parameters:

tag - The parent tag.