jaroslav@557
|
1 |
/*
|
jaroslav@557
|
2 |
* Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
|
jaroslav@557
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
jaroslav@557
|
4 |
*
|
jaroslav@557
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
jaroslav@557
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
jaroslav@557
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
jaroslav@557
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
jaroslav@557
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
jaroslav@557
|
10 |
*
|
jaroslav@557
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
jaroslav@557
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
jaroslav@557
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
jaroslav@557
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
jaroslav@557
|
15 |
* accompanied this code).
|
jaroslav@557
|
16 |
*
|
jaroslav@557
|
17 |
* You should have received a copy of the GNU General Public License version
|
jaroslav@557
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
jaroslav@557
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
jaroslav@557
|
20 |
*
|
jaroslav@557
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
jaroslav@557
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
jaroslav@557
|
23 |
* questions.
|
jaroslav@557
|
24 |
*/
|
jaroslav@557
|
25 |
|
jaroslav@557
|
26 |
package java.util;
|
jaroslav@557
|
27 |
|
jaroslav@557
|
28 |
/**
|
jaroslav@557
|
29 |
* An iterator over a collection. {@code Iterator} takes the place of
|
jaroslav@557
|
30 |
* {@link Enumeration} in the Java Collections Framework. Iterators
|
jaroslav@557
|
31 |
* differ from enumerations in two ways:
|
jaroslav@557
|
32 |
*
|
jaroslav@557
|
33 |
* <ul>
|
jaroslav@557
|
34 |
* <li> Iterators allow the caller to remove elements from the
|
jaroslav@557
|
35 |
* underlying collection during the iteration with well-defined
|
jaroslav@557
|
36 |
* semantics.
|
jaroslav@557
|
37 |
* <li> Method names have been improved.
|
jaroslav@557
|
38 |
* </ul>
|
jaroslav@557
|
39 |
*
|
jaroslav@557
|
40 |
* <p>This interface is a member of the
|
jaroslav@557
|
41 |
* <a href="{@docRoot}/../technotes/guides/collections/index.html">
|
jaroslav@557
|
42 |
* Java Collections Framework</a>.
|
jaroslav@557
|
43 |
*
|
jaroslav@557
|
44 |
* @param <E> the type of elements returned by this iterator
|
jaroslav@557
|
45 |
*
|
jaroslav@557
|
46 |
* @author Josh Bloch
|
jaroslav@557
|
47 |
* @see Collection
|
jaroslav@557
|
48 |
* @see ListIterator
|
jaroslav@557
|
49 |
* @see Iterable
|
jaroslav@557
|
50 |
* @since 1.2
|
jaroslav@557
|
51 |
*/
|
jaroslav@557
|
52 |
public interface Iterator<E> {
|
jaroslav@557
|
53 |
/**
|
jaroslav@557
|
54 |
* Returns {@code true} if the iteration has more elements.
|
jaroslav@557
|
55 |
* (In other words, returns {@code true} if {@link #next} would
|
jaroslav@557
|
56 |
* return an element rather than throwing an exception.)
|
jaroslav@557
|
57 |
*
|
jaroslav@557
|
58 |
* @return {@code true} if the iteration has more elements
|
jaroslav@557
|
59 |
*/
|
jaroslav@557
|
60 |
boolean hasNext();
|
jaroslav@557
|
61 |
|
jaroslav@557
|
62 |
/**
|
jaroslav@557
|
63 |
* Returns the next element in the iteration.
|
jaroslav@557
|
64 |
*
|
jaroslav@557
|
65 |
* @return the next element in the iteration
|
jaroslav@557
|
66 |
* @throws NoSuchElementException if the iteration has no more elements
|
jaroslav@557
|
67 |
*/
|
jaroslav@557
|
68 |
E next();
|
jaroslav@557
|
69 |
|
jaroslav@557
|
70 |
/**
|
jaroslav@557
|
71 |
* Removes from the underlying collection the last element returned
|
jaroslav@557
|
72 |
* by this iterator (optional operation). This method can be called
|
jaroslav@557
|
73 |
* only once per call to {@link #next}. The behavior of an iterator
|
jaroslav@557
|
74 |
* is unspecified if the underlying collection is modified while the
|
jaroslav@557
|
75 |
* iteration is in progress in any way other than by calling this
|
jaroslav@557
|
76 |
* method.
|
jaroslav@557
|
77 |
*
|
jaroslav@557
|
78 |
* @throws UnsupportedOperationException if the {@code remove}
|
jaroslav@557
|
79 |
* operation is not supported by this iterator
|
jaroslav@557
|
80 |
*
|
jaroslav@557
|
81 |
* @throws IllegalStateException if the {@code next} method has not
|
jaroslav@557
|
82 |
* yet been called, or the {@code remove} method has already
|
jaroslav@557
|
83 |
* been called after the last call to the {@code next}
|
jaroslav@557
|
84 |
* method
|
jaroslav@557
|
85 |
*/
|
jaroslav@557
|
86 |
void remove();
|
jaroslav@557
|
87 |
}
|