com.google.ical.iter.RecurrenceIterator Maven / Gradle / Ivy
The newest version!
// Copyright (C) 2006 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.ical.iter;
import com.google.ical.values.DateValue;
import java.util.Iterator;
/**
* an iterator over date values in order. Does not support the
* remove operation.
*
* @author [email protected] (Mike Samuel)
*/
public interface RecurrenceIterator extends Iterator {
/** true iff there are more dates in the series. */
boolean hasNext();
/**
* returns the next date in the series, in UTC.
* If !hasNext(), then behavior is undefined.
*
* @return a DateValue that is strictly later than any date previously
* returned by this iterator.
*/
DateValue next();
/**
* skips all dates in the series before the given date.
*
* @param newStartUtc non null.
*/
void advanceTo(DateValue newStartUtc);
/**
* unsupported.
* @throws UnsupportedOperationException always
*/
void remove();
}