sirius.tagliatelle.emitter

Class LoopState

java.lang.Object

sirius.tagliatelle.emitter.LoopState

public class LoopState
extends Object

Determines the state of a loop emitter.

An instance of this can be obtained by providing a variable name for "state" in a ForTag.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LoopState(Iterable<?> items) Creates a new instance for the base collection.

Method Summary

Modifier and Type	Method and Description
int	getRowIndex() Returns the index of the current row.
boolean	isEven() Determines if the an even row is currently being rendered.
boolean	isFirst() Determines if the first row is currently being rendered.
boolean	isLast() Determines if the last row is currently being rendered.
boolean	isNth(int n) Determines if the n-th even row is currently being rendered.
boolean	isOdd() Determines if the an odd row is currently being rendered.
boolean	isSuccessive() Determines if a successive row is currently being rendered.
protected void	nextRow() Used by the LoopEmitter to indicate that a new row is rendered.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoopState

protected LoopState(Iterable<?> items)

Creates a new instance for the base collection.

If the given collection is a list, we can also determine if the current row is the last one.

Parameters:

items - the collection to iterate over

Method Detail

nextRow

protected void nextRow()

Used by the LoopEmitter to indicate that a new row is rendered.

getRowIndex

public int getRowIndex()

Returns the index of the current row.

Note that this is one-based and therefore counts 1, 2, 3, ...

Returns:

the one-based index of the current row

isFirst

public boolean isFirst()

Determines if the first row is currently being rendered.

Returns:

true if the first row is currently rendered, false otherwise.

isSuccessive

public boolean isSuccessive()

Determines if a successive row is currently being rendered.

This is the inverse to isFirst().

Returns:

true if a successive row is currently rendered, false otherwise.

isLast

public boolean isLast()

Determines if the last row is currently being rendered.

Returns:

true if the last row is currently rendered, false otherwise.

Throws:

UnsupportedOperationException - if the total number of items is not known in advance

isEven

public boolean isEven()

Determines if the an even row is currently being rendered.

Returns:

true if an even row is currently rendered, false otherwise.

isOdd

public boolean isOdd()

Determines if the an odd row is currently being rendered.

Returns:

true if an odd row is currently rendered, false otherwise.

isNth

public boolean isNth(int n)

Determines if the n-th even row is currently being rendered.

Parameters:

n - the modulo to check for

Returns:

true if the current row index modulo n is zero, false otherwise.