com.google.ical.iter

Interface RecurrenceIterator

All Superinterfaces:

java.util.Iterator<DateValue>

public interface RecurrenceIterator
extends java.util.Iterator<DateValue>

an iterator over date values in order. Does not support the remove operation.

Method Summary

Modifier and Type	Method and Description
void	advanceTo(DateValue newStartUtc) skips all dates in the series before the given date.
boolean	hasNext() true iff there are more dates in the series.
DateValue	next() returns the next date in the series, in UTC.
void	remove() unsupported.

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Detail

hasNext

boolean hasNext()

true iff there are more dates in the series.

Specified by:

hasNext in interface java.util.Iterator<DateValue>

next

DateValue next()

returns the next date in the series, in UTC. If !hasNext(), then behavior is undefined.

Specified by:

next in interface java.util.Iterator<DateValue>

Returns:

a DateValue that is strictly later than any date previously returned by this iterator.

advanceTo

void advanceTo(DateValue newStartUtc)

skips all dates in the series before the given date.

Parameters:

newStartUtc - non null.

remove

void remove()

unsupported.

Specified by:

remove in interface java.util.Iterator<DateValue>

Throws:

java.lang.UnsupportedOperationException - always