ilog.views.util.time

Class IlvTimeIterator

java.lang.Object

ilog.views.util.time.IlvTimeIterator

All Implemented Interfaces:

Iterator<Date>

public class IlvTimeIterator
extends Object
implements Iterator<Date>

IlvTimeIterator traverses over time increments that are defined by an IlvTimeIncrementPolicy. The first time returned by the iterator will be the time increment ceiling of the iterator's start time. In other words, the first time value will be the smallest time increment boundary that is greater than or equal to the iterator's start time. Time iterators can have an upper bound or they can be open-ended. In this case, the hasNext() method will always return true.

Since:

JViews 7.5

Constructor Summary

Constructors

Constructor and Description
IlvTimeIterator(IlvTimeIncrementPolicy timeIncrementPolicy, Calendar start) Creates an open-ended iterator that traverses over time increments.
IlvTimeIterator(IlvTimeIncrementPolicy timeIncrementPolicy, Calendar start, Calendar end) Creates a new iterator that traverses over time increments.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns whether the iteration has more elements.
Date	next() Returns the next Date in the iteration.
void	remove() Removes from the underlying collection the last time returned by the iterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IlvTimeIterator

public IlvTimeIterator(IlvTimeIncrementPolicy timeIncrementPolicy,
                       Calendar start,
                       Calendar end)

Creates a new iterator that traverses over time increments.

Parameters:

timeIncrementPolicy - The time increment policy of the iterator.

start - The start time of the iterator. The first time returned by the next() method will be the time increment ceiling of start. In other words, the first time value of the iterator will be the smallest time increment boundary that is greater than or equal to start.

end - The end time of the iterator, or null if the iterator is open-ended.

IlvTimeIterator

public IlvTimeIterator(IlvTimeIncrementPolicy timeIncrementPolicy,
                       Calendar start)

Creates an open-ended iterator that traverses over time increments.

Parameters:

timeIncrementPolicy - The time increment policy of the iterator.

start - The start time of the iterator. The first time returned by the next() method will be the time increment ceiling of start. In other words, the first time value of the iterator will be the smallest time increment boundary that is greater than or equal to start.

Method Detail

hasNext

public boolean hasNext()

Returns whether the iteration has more elements.

Specified by:

hasNext in interface Iterator<Date>

Returns:

true if the iterator has more elements, false otherwise.

next

public Date next()

Returns the next Date in the iteration.

Specified by:

next in interface Iterator<Date>

Returns:

The next Date in the iteration.

Throws:

NoSuchElementException - if the iteration has no more elements.

Since:

JViews 8.5

remove

public void remove()

Removes from the underlying collection the last time returned by the iterator. Because a time iterator is not backed by a true collection, this optional method throws an unconditional UnsupportedOperationException.

Specified by:

remove in interface Iterator<Date>