1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * this work for additional information regarding copyright ownership. 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * (the "License"); you may not use this file except in compliance with 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the License. You may obtain a copy of the License at 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage java.util; 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * An ListIterator is used to sequence over a List of objects. ListIterator can 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * move backwards or forwards through the list. 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpublic interface ListIterator<E> extends Iterator<E> { 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Inserts the specified object into the list between {@code next} and 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * {@code previous}. The object inserted will be the previous object. 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param object 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the object to insert. 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws UnsupportedOperationException 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if adding is not supported by the list being iterated. 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws ClassCastException 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if the class of the object is inappropriate for the list. 37f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalArgumentException 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if the object cannot be added to the list. 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project void add(E object); 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns whether there are more elements to iterate. 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return {@code true} if there are more elements, {@code false} otherwise. 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @see #next 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public boolean hasNext(); 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns whether there are previous elements to iterate. 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return {@code true} if there are previous elements, {@code false} 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * otherwise. 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @see #previous 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public boolean hasPrevious(); 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns the next object in the iteration. 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the next object. 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws NoSuchElementException 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if there are no more elements. 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @see #hasNext 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 67f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public E next(); 68f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns the index of the next object in the iteration. 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the index of the next object, or the size of the list if the 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * iterator is at the end. 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws NoSuchElementException 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if there are no more elements. 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @see #next 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int nextIndex(); 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns the previous object in the iteration. 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the previous object. 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws NoSuchElementException 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if there are no previous elements. 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @see #hasPrevious 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public E previous(); 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns the index of the previous object in the iteration. 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the index of the previous object, or -1 if the iterator is at the 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * beginning. 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws NoSuchElementException 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if there are no previous elements. 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @see #previous 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int previousIndex(); 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Removes the last object returned by {@code next} or {@code previous} from 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the list. 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws UnsupportedOperationException 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if removing is not supported by the list being iterated. 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalStateException 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if {@code next} or {@code previous} have not been called, or 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * {@code remove} or {@code add} have already been called after 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the last call to {@code next} or {@code previous}. 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void remove(); 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Replaces the last object returned by {@code next} or {@code previous} 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * with the specified object. 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param object 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the object to set. 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws UnsupportedOperationException 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if setting is not supported by the list being iterated 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws ClassCastException 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if the class of the object is inappropriate for the list. 124f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalArgumentException 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if the object cannot be added to the list. 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @throws IllegalStateException 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * if {@code next} or {@code previous} have not been called, or 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * {@code remove} or {@code add} have already been called after 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the last call to {@code next} or {@code previous}. 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project void set(E object); 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 133