1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/rt/emul/compact/src/main/java/java/util/Iterator.java Tue Feb 26 16:54:16 2013 +0100
1.3 @@ -0,0 +1,87 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package java.util;
1.30 +
1.31 +/**
1.32 + * An iterator over a collection. {@code Iterator} takes the place of
1.33 + * {@link Enumeration} in the Java Collections Framework. Iterators
1.34 + * differ from enumerations in two ways:
1.35 + *
1.36 + * <ul>
1.37 + * <li> Iterators allow the caller to remove elements from the
1.38 + * underlying collection during the iteration with well-defined
1.39 + * semantics.
1.40 + * <li> Method names have been improved.
1.41 + * </ul>
1.42 + *
1.43 + * <p>This interface is a member of the
1.44 + * <a href="{@docRoot}/../technotes/guides/collections/index.html">
1.45 + * Java Collections Framework</a>.
1.46 + *
1.47 + * @param <E> the type of elements returned by this iterator
1.48 + *
1.49 + * @author Josh Bloch
1.50 + * @see Collection
1.51 + * @see ListIterator
1.52 + * @see Iterable
1.53 + * @since 1.2
1.54 + */
1.55 +public interface Iterator<E> {
1.56 + /**
1.57 + * Returns {@code true} if the iteration has more elements.
1.58 + * (In other words, returns {@code true} if {@link #next} would
1.59 + * return an element rather than throwing an exception.)
1.60 + *
1.61 + * @return {@code true} if the iteration has more elements
1.62 + */
1.63 + boolean hasNext();
1.64 +
1.65 + /**
1.66 + * Returns the next element in the iteration.
1.67 + *
1.68 + * @return the next element in the iteration
1.69 + * @throws NoSuchElementException if the iteration has no more elements
1.70 + */
1.71 + E next();
1.72 +
1.73 + /**
1.74 + * Removes from the underlying collection the last element returned
1.75 + * by this iterator (optional operation). This method can be called
1.76 + * only once per call to {@link #next}. The behavior of an iterator
1.77 + * is unspecified if the underlying collection is modified while the
1.78 + * iteration is in progress in any way other than by calling this
1.79 + * method.
1.80 + *
1.81 + * @throws UnsupportedOperationException if the {@code remove}
1.82 + * operation is not supported by this iterator
1.83 + *
1.84 + * @throws IllegalStateException if the {@code next} method has not
1.85 + * yet been called, or the {@code remove} method has already
1.86 + * been called after the last call to the {@code next}
1.87 + * method
1.88 + */
1.89 + void remove();
1.90 +}