org.trimou.engine.segment

Class ImmutableIterationMeta

java.lang.Object

org.trimou.engine.segment.ImmutableIterationMeta

All Implemented Interfaces:

Mapper

public final class ImmutableIterationMeta
extends Object
implements Mapper

An immutable iteration metadata.

Author:

Martin Kouba

Constructor Summary

Constructors

Constructor and Description
ImmutableIterationMeta(String alias, int size, int index)
ImmutableIterationMeta(String alias, int size, int index, String valueAlias, Object value)

Method Summary

Modifier and Type	Method and Description
Object	get(String key)
int	getIndex() The first element is at index 1.
String	getIndexParity()
int	getPosition() The name for getIndex() was poorly chosen.
Object	getValue()
String	getValueAlias()
boolean	hasNext()
boolean	isEven()
boolean	isFirst()
boolean	isLast()
boolean	isOdd()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableIterationMeta

public ImmutableIterationMeta(String alias,
                              int size,
                              int index)

Parameters:

alias -

size -

index -

ImmutableIterationMeta

public ImmutableIterationMeta(String alias,
                              int size,
                              int index,
                              String valueAlias,
                              Object value)

Parameters:

alias -

size -

index -

valueAlias -

value -

Method Detail

getIndex

public int getIndex()

The first element is at index 1.

Returns:

the current iteration index

getPosition

public int getPosition()

The name for getIndex() was poorly chosen. We should have used getCount() instead. But we can't change it now - it would break backward compatibility.

Returns:

the position of the current element, the first element has position 0

hasNext

public boolean hasNext()

Returns:

true if the iteration has more elements, false otherwise

isFirst

public boolean isFirst()

Returns:

true for the first iteration, false otherwise

isLast

public boolean isLast()

Returns:

true for the last iteration, false otherwise

isOdd

public boolean isOdd()

Returns:

true if the current index is odd, false otherwise

isEven

public boolean isEven()

Returns:

true if the current index is even, false otherwise

getIndexParity

public String getIndexParity()

Returns:

the current index parity, e.g. either "odd" or "even"

See Also:

isEven(), isOdd()

getValueAlias

public String getValueAlias()

Returns:

the value alias or null if not set

getValue

public Object getValue()

Returns:

the current value or null if not set

get

public Object get(String key)

Specified by:

get in interface Mapper

Returns:

the value to which the specified key is mapped, or null