1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107 | /*
* Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package Torello.Java.ReadOnly;
import java.util.ListIterator;
/**
* Immutable variant of Java Collections Framework interface
* <CODE>java.util.ListIterator<E></CODE>.
*
* <EMBED CLASS='external-html' DATA-JDK=ReadOnlyListIterator DATA-FILE-ID=INTERFACES>
*
* @param <E> the type of elements returned by this list iterator
*/
@Torello.JavaDoc.JDHeaderBackgroundImg(EmbedTagFileID="JDHBI_INTERFACE")
public interface ReadOnlyListIterator<E>
{
// ********************************************************************************************
// ********************************************************************************************
// Original Methods
// ********************************************************************************************
// ********************************************************************************************
/**
* Returns {@code TRUE} if this list iterator has more elements when traversing the list in the
* forward direction. (In other words, returns {@code TRUE} if {@link #next} would return an
* element rather than throwing an exception.)
*
* @return {@code TRUE} if the list iterator has more elements when traversing the list in the
* forward direction
*/
boolean hasNext();
/**
* Returns the next element in the list and advances the cursor position. This method may be
* called repeatedly to iterate through the list, or intermixed with calls to {@link #previous}
* to go back and forth. (Note that alternating calls to {@code next} and {@code previous}
* will return the same element repeatedly.)
*
* @return the next element in the list
* @throws NoSuchElementException if the iteration has no next element
*/
E next();
/**
* Returns {@code TRUE} if this list iterator has more elements when traversing the list in the
* reverse direction. (In other words, returns {@code TRUE} if {@link #previous} would return
* an element rather than throwing an exception.)
*
* @return {@code TRUE} if the list iterator has more elements when traversing the list in the
* reverse direction
*/
boolean hasPrevious();
/**
* Returns the previous element in the list and moves the cursor position backwards. This
* method may be called repeatedly to iterate through the list backwards, or intermixed with
* calls to {@link #next} to go back and forth. (Note that alternating calls to {@code next}
* and {@code previous} will return the same element repeatedly.)
*
* @return the previous element in the list
* @throws NoSuchElementException if the iteration has no previous element
*/
E previous();
/**
* Returns the index of the element that would be returned by a subsequent call to
* {@link #next}. (Returns list size if the list iterator is at the end of the list.)
*
* @return the index of the element that would be returned by a subsequent call to
* {@code next}, or list size if the list iterator is at the end of the list
*/
int nextIndex();
/**
* Returns the index of the element that would be returned by a subsequent call to
* {@link #previous}. (Returns -1 if the list iterator is at the beginning of the list.)
*
* @return the index of the element that would be returned by a subsequent call to
* {@code previous}, or -1 if the list iterator is at the beginning of the list
*/
int previousIndex();
}
|