org.dmfs.rfc5545.recurrenceset

Class CountLimitedRecurrenceRuleIterator

java.lang.Object

org.dmfs.rfc5545.recurrenceset.CountLimitedRecurrenceRuleIterator

public final class CountLimitedRecurrenceRuleIterator
extends java.lang.Object

An AbstractRecurrenceAdapter.InstanceIterator which inserts a start instance.

Constructor Summary

Constructors

Constructor and Description
CountLimitedRecurrenceRuleIterator(org.dmfs.rfc5545.recurrenceset.AbstractRecurrenceAdapter.InstanceIterator delegate, int remaining)

Method Summary

Modifier and Type	Method and Description
void	fastForward(long until) Skip all instances till until.
boolean	hasNext() Check if there is at least one more instance to iterate.
long	next() Get the next instance of this set.
long	peek() Peek at the upcoming instance without actually iterating it.
void	skip(int count) Skip the given number of instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

CountLimitedRecurrenceRuleIterator

public CountLimitedRecurrenceRuleIterator(org.dmfs.rfc5545.recurrenceset.AbstractRecurrenceAdapter.InstanceIterator delegate,
                                          int remaining)

Method Detail

hasNext

public boolean hasNext()

Check if there is at least one more instance to iterate.

Returns:

true if the next call to next() will return another instance, false otherwise.

next

public long next()

Get the next instance of this set. Do not call this if hasNext() returns false.

Returns:

The time in milliseconds since the epoch of the next instance.

peek

public long peek()

Peek at the upcoming instance without actually iterating it. Use hasNext() to check if there are any more instances before calling this method.

Returns:

The next instance of this set of instances.

skip

public void skip(int count)

Skip the given number of instances.

Parameters:

count - The number of instances to skip.

fastForward

public void fastForward(long until)

Skip all instances till until. If until is an instance itself it will be the next iterated instance. If the rule doesn't recur till that date the next call to hasNext() will return false.

Parameters:

until - A time stamp of the date to fast forward to.