15.62/5.12 YES
15.62/5.14 proof of /export/starexec/sandbox/benchmark/theBenchmark.jar
15.62/5.14 # AProVE Commit ID: 48fb2092695e11cc9f56e44b17a92a5f88ffb256 marcel 20180622 unpublished dirty
15.62/5.14
15.62/5.14
15.62/5.14 termination of the given Bare JBC problem could be proven:
15.62/5.14
15.62/5.14 (0) Bare JBC problem
15.62/5.14 (1) BareJBCToJBCProof [EQUIVALENT, 96 ms]
15.62/5.14 (2) JBC problem
15.62/5.14 (3) JBCToGraph [EQUIVALENT, 2163 ms]
15.62/5.14 (4) JBCTerminationGraph
15.62/5.14 (5) TerminationGraphToSCCProof [SOUND, 0 ms]
15.62/5.14 (6) JBCTerminationSCC
15.62/5.14 (7) SCCToIRSProof [SOUND, 435 ms]
15.62/5.14 (8) IRSwT
15.62/5.14 (9) IRSFormatTransformerProof [EQUIVALENT, 0 ms]
15.62/5.14 (10) IRSwT
15.62/5.14 (11) IRSwTTerminationDigraphProof [EQUIVALENT, 122 ms]
15.62/5.14 (12) IRSwT
15.62/5.14 (13) IntTRSCompressionProof [EQUIVALENT, 0 ms]
15.62/5.14 (14) IRSwT
15.62/5.14 (15) TempFilterProof [SOUND, 137 ms]
15.62/5.14 (16) IntTRS
15.62/5.14 (17) PolynomialOrderProcessor [EQUIVALENT, 27 ms]
15.62/5.14 (18) IntTRS
15.62/5.14 (19) PolynomialOrderProcessor [EQUIVALENT, 0 ms]
15.62/5.14 (20) YES
15.62/5.14
15.62/5.14
15.62/5.14 ----------------------------------------
15.62/5.14
15.62/5.14 (0)
15.62/5.14 Obligation:
15.62/5.14 need to prove termination of the following program:
15.62/5.14 /*
15.62/5.14 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.14 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.14 *
15.62/5.14 * This code is free software; you can redistribute it and/or modify it
15.62/5.14 * under the terms of the GNU General Public License version 2 only, as
15.62/5.14 * published by the Free Software Foundation. Sun designates this
15.62/5.14 * particular file as subject to the "Classpath" exception as provided
15.62/5.14 * by Sun in the LICENSE file that accompanied this code.
15.62/5.14 *
15.62/5.14 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.14 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.14 * accompanied this code).
15.62/5.14 *
15.62/5.14 * You should have received a copy of the GNU General Public License version
15.62/5.14 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.14 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.14 *
15.62/5.14 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.14 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.14 * have any questions.
15.62/5.14 */
15.62/5.14
15.62/5.14 package javaUtilEx;
15.62/5.14
15.62/5.14 /**
15.62/5.14 * This class provides a skeletal implementation of the Collection
15.62/5.14 * interface, to minimize the effort required to implement this interface.
15.62/5.14 *
15.62/5.14 * To implement an unmodifiable collection, the programmer needs only to
15.62/5.14 * extend this class and provide implementations for the iterator and
15.62/5.14 * size methods. (The iterator returned by the iterator
15.62/5.14 * method must implement hasNext and next.)
15.62/5.14 *
15.62/5.14 * To implement a modifiable collection, the programmer must additionally
15.62/5.14 * override this class's add method (which otherwise throws an
15.62/5.14 * UnsupportedOperationException), and the iterator returned by the
15.62/5.14 * iterator method must additionally implement its remove
15.62/5.14 * method.
15.62/5.14 *
15.62/5.14 * The programmer should generally provide a void (no argument) and
15.62/5.14 * Collection constructor, as per the recommendation in the
15.62/5.14 * Collection interface specification.
15.62/5.14 *
15.62/5.14 * The documentation for each non-abstract method in this class describes its
15.62/5.14 * implementation in detail. Each of these methods may be overridden if
15.62/5.14 * the collection being implemented admits a more efficient implementation.
15.62/5.14 *
15.62/5.14 * This class is a member of the
15.62/5.14 *
15.62/5.14 * Java Collections Framework.
15.62/5.14 *
15.62/5.14 * @author Josh Bloch
15.62/5.14 * @author Neal Gafter
15.62/5.14 * @see Collection
15.62/5.14 * @since 1.2
15.62/5.14 */
15.62/5.14
15.62/5.14 public abstract class AbstractCollection implements Collection {
15.62/5.14 /**
15.62/5.14 * Sole constructor. (For invocation by subclass constructors, typically
15.62/5.14 * implicit.)
15.62/5.14 */
15.62/5.14 protected AbstractCollection() {
15.62/5.14 }
15.62/5.14
15.62/5.14 // Query Operations
15.62/5.14
15.62/5.14 /**
15.62/5.14 * Returns an iterator over the elements contained in this collection.
15.62/5.14 *
15.62/5.14 * @return an iterator over the elements contained in this collection
15.62/5.14 */
15.62/5.14 public abstract Iterator iterator();
15.62/5.14
15.62/5.14 public abstract int size();
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 * This implementation returns size() == 0.
15.62/5.14 */
15.62/5.14 public boolean isEmpty() {
15.62/5.14 return size() == 0;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation iterates over the elements in the collection,
15.62/5.14 * checking each element in turn for equality with the specified element.
15.62/5.14 *
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public boolean contains(Object o) {
15.62/5.14 Iterator e = iterator();
15.62/5.14 if (o==null) {
15.62/5.14 while (e.hasNext())
15.62/5.14 if (e.next()==null)
15.62/5.14 return true;
15.62/5.14 } else {
15.62/5.14 while (e.hasNext())
15.62/5.14 if (o.equals(e.next()))
15.62/5.14 return true;
15.62/5.14 }
15.62/5.14 return false;
15.62/5.14 }
15.62/5.14
15.62/5.14 // Modification Operations
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 * This implementation always throws an
15.62/5.14 * UnsupportedOperationException.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.14 * @throws IllegalStateException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public boolean add(E e) {
15.62/5.14 throw new UnsupportedOperationException();
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation iterates over the collection looking for the
15.62/5.14 * specified element. If it finds the element, it removes the element
15.62/5.14 * from the collection using the iterator's remove method.
15.62/5.14 *
15.62/5.14 *
Note that this implementation throws an
15.62/5.14 * UnsupportedOperationException if the iterator returned by this
15.62/5.14 * collection's iterator method does not implement the remove
15.62/5.14 * method and this collection contains the specified object.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public boolean remove(Object o) {
15.62/5.14 Iterator e = iterator();
15.62/5.14 if (o==null) {
15.62/5.14 while (e.hasNext()) {
15.62/5.14 if (e.next()==null) {
15.62/5.14 e.remove();
15.62/5.14 return true;
15.62/5.14 }
15.62/5.14 }
15.62/5.14 } else {
15.62/5.14 while (e.hasNext()) {
15.62/5.14 if (o.equals(e.next())) {
15.62/5.14 e.remove();
15.62/5.14 return true;
15.62/5.14 }
15.62/5.14 }
15.62/5.14 }
15.62/5.14 return false;
15.62/5.14 }
15.62/5.14
15.62/5.14
15.62/5.14 // Bulk Operations
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 * This implementation iterates over the specified collection,
15.62/5.14 * checking each element returned by the iterator in turn to see
15.62/5.14 * if it's contained in this collection. If all elements are so
15.62/5.14 * contained true is returned, otherwise false.
15.62/5.14 *
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 * @see #contains(Object)
15.62/5.14 */
15.62/5.14 public boolean containsAll(Collection c) {
15.62/5.14 Iterator e = c.iterator();
15.62/5.14 while (e.hasNext())
15.62/5.14 if (!contains(e.next()))
15.62/5.14 return false;
15.62/5.14 return true;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation iterates over the specified collection, and adds
15.62/5.14 * each object returned by the iterator to this collection, in turn.
15.62/5.14 *
15.62/5.14 *
Note that this implementation will throw an
15.62/5.14 * UnsupportedOperationException unless add is
15.62/5.14 * overridden (assuming the specified collection is non-empty).
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.14 * @throws IllegalStateException {@inheritDoc}
15.62/5.14 *
15.62/5.14 * @see #add(Object)
15.62/5.14 */
15.62/5.14 public boolean addAll(Collection c) {
15.62/5.14 boolean modified = false;
15.62/5.14 Iterator e = c.iterator();
15.62/5.14 while (e.hasNext()) {
15.62/5.14 if (add(e.next()))
15.62/5.14 modified = true;
15.62/5.14 }
15.62/5.14 return modified;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation iterates over this collection, checking each
15.62/5.14 * element returned by the iterator in turn to see if it's contained
15.62/5.14 * in the specified collection. If it's so contained, it's removed from
15.62/5.14 * this collection with the iterator's remove method.
15.62/5.14 *
15.62/5.14 *
Note that this implementation will throw an
15.62/5.14 * UnsupportedOperationException if the iterator returned by the
15.62/5.14 * iterator method does not implement the remove method
15.62/5.14 * and this collection contains one or more elements in common with the
15.62/5.14 * specified collection.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 *
15.62/5.14 * @see #remove(Object)
15.62/5.14 * @see #contains(Object)
15.62/5.14 */
15.62/5.14 public boolean removeAll(Collection c) {
15.62/5.14 boolean modified = false;
15.62/5.14 Iterator e = iterator();
15.62/5.14 while (e.hasNext()) {
15.62/5.14 if (c.contains(e.next())) {
15.62/5.14 e.remove();
15.62/5.14 modified = true;
15.62/5.14 }
15.62/5.14 }
15.62/5.14 return modified;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation iterates over this collection, checking each
15.62/5.14 * element returned by the iterator in turn to see if it's contained
15.62/5.14 * in the specified collection. If it's not so contained, it's removed
15.62/5.14 * from this collection with the iterator's remove method.
15.62/5.14 *
15.62/5.14 *
Note that this implementation will throw an
15.62/5.14 * UnsupportedOperationException if the iterator returned by the
15.62/5.14 * iterator method does not implement the remove method
15.62/5.14 * and this collection contains one or more elements not present in the
15.62/5.14 * specified collection.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 *
15.62/5.14 * @see #remove(Object)
15.62/5.14 * @see #contains(Object)
15.62/5.14 */
15.62/5.14 public boolean retainAll(Collection c) {
15.62/5.14 boolean modified = false;
15.62/5.14 Iterator e = iterator();
15.62/5.14 while (e.hasNext()) {
15.62/5.14 if (!c.contains(e.next())) {
15.62/5.14 e.remove();
15.62/5.14 modified = true;
15.62/5.14 }
15.62/5.14 }
15.62/5.14 return modified;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 * This implementation iterates over this collection, removing each
15.62/5.14 * element using the Iterator.remove operation. Most
15.62/5.14 * implementations will probably choose to override this method for
15.62/5.14 * efficiency.
15.62/5.14 *
15.62/5.14 *
Note that this implementation will throw an
15.62/5.14 * UnsupportedOperationException if the iterator returned by this
15.62/5.14 * collection's iterator method does not implement the
15.62/5.14 * remove method and this collection is non-empty.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public void clear() {
15.62/5.14 Iterator e = iterator();
15.62/5.14 while (e.hasNext()) {
15.62/5.14 e.next();
15.62/5.14 e.remove();
15.62/5.14 }
15.62/5.14 }
15.62/5.14
15.62/5.14
15.62/5.14 // String conversion
15.62/5.14
15.62/5.14 /**
15.62/5.14 * Returns a string representation of this collection. The string
15.62/5.14 * representation consists of a list of the collection's elements in the
15.62/5.14 * order they are returned by its iterator, enclosed in square brackets
15.62/5.14 * ("[]"). Adjacent elements are separated by the characters
15.62/5.14 * ", " (comma and space). Elements are converted to strings as
15.62/5.14 * by {@link String#valueOf(Object)}.
15.62/5.14 *
15.62/5.14 * @return a string representation of this collection
15.62/5.14 */
15.62/5.14 public String toString() {
15.62/5.14 Iterator i = iterator();
15.62/5.14 if (! i.hasNext())
15.62/5.14 return "[]";
15.62/5.14
15.62/5.14 String sb = "";
15.62/5.14 sb = sb + "[";
15.62/5.14 for (;;) {
15.62/5.14 E e = i.next();
15.62/5.14 sb = sb + (e == this ? "(this Collection)" : e);
15.62/5.14 if (! i.hasNext()) {
15.62/5.14 sb = sb + "]";
15.62/5.14 return sb;
15.62/5.14 }
15.62/5.14 sb = sb + ", ";
15.62/5.14 }
15.62/5.14 }
15.62/5.14
15.62/5.14 }
15.62/5.14
15.62/5.14
15.62/5.14 /*
15.62/5.14 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.14 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.14 *
15.62/5.14 * This code is free software; you can redistribute it and/or modify it
15.62/5.14 * under the terms of the GNU General Public License version 2 only, as
15.62/5.14 * published by the Free Software Foundation. Sun designates this
15.62/5.14 * particular file as subject to the "Classpath" exception as provided
15.62/5.14 * by Sun in the LICENSE file that accompanied this code.
15.62/5.14 *
15.62/5.14 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.14 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.14 * accompanied this code).
15.62/5.14 *
15.62/5.14 * You should have received a copy of the GNU General Public License version
15.62/5.14 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.14 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.14 *
15.62/5.14 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.14 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.14 * have any questions.
15.62/5.14 */
15.62/5.14
15.62/5.14 package javaUtilEx;
15.62/5.14
15.62/5.14 /**
15.62/5.14 * This class provides a skeletal implementation of the {@link List}
15.62/5.14 * interface to minimize the effort required to implement this interface
15.62/5.14 * backed by a "random access" data store (such as an array). For sequential
15.62/5.14 * access data (such as a linked list), {@link AbstractSequentialList} should
15.62/5.14 * be used in preference to this class.
15.62/5.14 *
15.62/5.14 * To implement an unmodifiable list, the programmer needs only to extend
15.62/5.14 * this class and provide implementations for the {@link #get(int)} and
15.62/5.14 * {@link List#size() size()} methods.
15.62/5.14 *
15.62/5.14 *
To implement a modifiable list, the programmer must additionally
15.62/5.14 * override the {@link #set(int, Object) set(int, E)} method (which otherwise
15.62/5.14 * throws an {@code UnsupportedOperationException}). If the list is
15.62/5.14 * variable-size the programmer must additionally override the
15.62/5.14 * {@link #add(int, Object) add(int, E)} and {@link #remove(int)} methods.
15.62/5.14 *
15.62/5.14 *
The programmer should generally provide a void (no argument) and collection
15.62/5.14 * constructor, as per the recommendation in the {@link Collection} interface
15.62/5.14 * specification.
15.62/5.14 *
15.62/5.14 *
Unlike the other abstract collection implementations, the programmer does
15.62/5.14 * not have to provide an iterator implementation; the iterator and
15.62/5.14 * list iterator are implemented by this class, on top of the "random access"
15.62/5.14 * methods:
15.62/5.14 * {@link #get(int)},
15.62/5.14 * {@link #set(int, Object) set(int, E)},
15.62/5.14 * {@link #add(int, Object) add(int, E)} and
15.62/5.14 * {@link #remove(int)}.
15.62/5.14 *
15.62/5.14 *
The documentation for each non-abstract method in this class describes its
15.62/5.14 * implementation in detail. Each of these methods may be overridden if the
15.62/5.14 * collection being implemented admits a more efficient implementation.
15.62/5.14 *
15.62/5.14 *
This class is a member of the
15.62/5.14 *
15.62/5.14 * Java Collections Framework.
15.62/5.14 *
15.62/5.14 * @author Josh Bloch
15.62/5.14 * @author Neal Gafter
15.62/5.14 * @since 1.2
15.62/5.14 */
15.62/5.14
15.62/5.14 public abstract class AbstractList extends AbstractCollection implements List {
15.62/5.14 /**
15.62/5.14 * Sole constructor. (For invocation by subclass constructors, typically
15.62/5.14 * implicit.)
15.62/5.14 */
15.62/5.14 protected AbstractList() {
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * Appends the specified element to the end of this list (optional
15.62/5.14 * operation).
15.62/5.14 *
15.62/5.14 * Lists that support this operation may place limitations on what
15.62/5.14 * elements may be added to this list. In particular, some
15.62/5.14 * lists will refuse to add null elements, and others will impose
15.62/5.14 * restrictions on the type of elements that may be added. List
15.62/5.14 * classes should clearly specify in their documentation any restrictions
15.62/5.14 * on what elements may be added.
15.62/5.14 *
15.62/5.14 *
This implementation calls {@code add(size(), e)}.
15.62/5.14 *
15.62/5.14 *
Note that this implementation throws an
15.62/5.14 * {@code UnsupportedOperationException} unless
15.62/5.14 * {@link #add(int, Object) add(int, E)} is overridden.
15.62/5.14 *
15.62/5.14 * @param e element to be appended to this list
15.62/5.14 * @return {@code true} (as specified by {@link Collection#add})
15.62/5.14 * @throws UnsupportedOperationException if the {@code add} operation
15.62/5.14 * is not supported by this list
15.62/5.14 * @throws ClassCastException if the class of the specified element
15.62/5.14 * prevents it from being added to this list
15.62/5.14 * @throws NullPointerException if the specified element is null and this
15.62/5.14 * list does not permit null elements
15.62/5.14 * @throws IllegalArgumentException if some property of this element
15.62/5.14 * prevents it from being added to this list
15.62/5.14 */
15.62/5.14 public boolean add(E e) {
15.62/5.14 add(size(), e);
15.62/5.14 return true;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.14 */
15.62/5.14 abstract public E get(int index);
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation always throws an
15.62/5.14 * {@code UnsupportedOperationException}.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.14 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public E set(int index, E element) {
15.62/5.14 throw new UnsupportedOperationException();
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation always throws an
15.62/5.14 * {@code UnsupportedOperationException}.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.14 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public void add(int index, E element) {
15.62/5.14 throw new UnsupportedOperationException();
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation always throws an
15.62/5.14 * {@code UnsupportedOperationException}.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.14 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public E remove(int index) {
15.62/5.14 throw new UnsupportedOperationException();
15.62/5.14 }
15.62/5.14
15.62/5.14
15.62/5.14 // Search Operations
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation first gets a list iterator (with
15.62/5.14 * {@code listIterator()}). Then, it iterates over the list until the
15.62/5.14 * specified element is found or the end of the list is reached.
15.62/5.14 *
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public int indexOf(Object o) {
15.62/5.14 ListIterator e = listIterator();
15.62/5.14 if (o==null) {
15.62/5.14 while (e.hasNext())
15.62/5.14 if (e.next()==null)
15.62/5.14 return e.previousIndex();
15.62/5.14 } else {
15.62/5.14 while (e.hasNext())
15.62/5.14 if (o.equals(e.next()))
15.62/5.14 return e.previousIndex();
15.62/5.14 }
15.62/5.14 return -1;
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 * This implementation first gets a list iterator that points to the end
15.62/5.14 * of the list (with {@code listIterator(size())}). Then, it iterates
15.62/5.14 * backwards over the list until the specified element is found, or the
15.62/5.14 * beginning of the list is reached.
15.62/5.14 *
15.62/5.14 * @throws ClassCastException {@inheritDoc}
15.62/5.14 * @throws NullPointerException {@inheritDoc}
15.62/5.14 */
15.62/5.14 public int lastIndexOf(Object o) {
15.62/5.14 ListIterator e = listIterator(size());
15.62/5.14 if (o==null) {
15.62/5.14 while (e.hasPrevious())
15.62/5.14 if (e.previous()==null)
15.62/5.14 return e.nextIndex();
15.62/5.14 } else {
15.62/5.14 while (e.hasPrevious())
15.62/5.14 if (o.equals(e.previous()))
15.62/5.14 return e.nextIndex();
15.62/5.14 }
15.62/5.14 return -1;
15.62/5.14 }
15.62/5.14
15.62/5.14
15.62/5.14 // Bulk Operations
15.62/5.14
15.62/5.14 /**
15.62/5.14 * Removes all of the elements from this list (optional operation).
15.62/5.14 * The list will be empty after this call returns.
15.62/5.14 *
15.62/5.14 * This implementation calls {@code removeRange(0, size())}.
15.62/5.14 *
15.62/5.14 *
Note that this implementation throws an
15.62/5.14 * {@code UnsupportedOperationException} unless {@code remove(int
15.62/5.14 * index)} or {@code removeRange(int fromIndex, int toIndex)} is
15.62/5.14 * overridden.
15.62/5.14 *
15.62/5.14 * @throws UnsupportedOperationException if the {@code clear} operation
15.62/5.14 * is not supported by this list
15.62/5.14 */
15.62/5.14 public void clear() {
15.62/5.14 removeRange(0, size());
15.62/5.14 }
15.62/5.14
15.62/5.14 /**
15.62/5.14 * {@inheritDoc}
15.62/5.14 *
15.62/5.14 *
This implementation gets an iterator over the specified collection
15.62/5.14 * and iterates over it, inserting the elements obtained from the
15.62/5.14 * iterator into this list at the appropriate position, one at a time,
15.62/5.14 * using {@code add(int, E)}.
15.62/5.14 * Many implementations will override this method for efficiency.
15.62/5.15 *
15.62/5.15 *
Note that this implementation throws an
15.62/5.15 * {@code UnsupportedOperationException} unless
15.62/5.15 * {@link #add(int, Object) add(int, E)} is overridden.
15.62/5.15 *
15.62/5.15 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.15 * @throws ClassCastException {@inheritDoc}
15.62/5.15 * @throws NullPointerException {@inheritDoc}
15.62/5.15 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public boolean addAll(int index, Collection c) {
15.62/5.15 rangeCheckForAdd(index);
15.62/5.15 boolean modified = false;
15.62/5.15 Iterator e = c.iterator();
15.62/5.15 while (e.hasNext()) {
15.62/5.15 add(index++, e.next());
15.62/5.15 modified = true;
15.62/5.15 }
15.62/5.15 return modified;
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 // Iterators
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns an iterator over the elements in this list in proper sequence.
15.62/5.15 *
15.62/5.15 *
This implementation returns a straightforward implementation of the
15.62/5.15 * iterator interface, relying on the backing list's {@code size()},
15.62/5.15 * {@code get(int)}, and {@code remove(int)} methods.
15.62/5.15 *
15.62/5.15 *
Note that the iterator returned by this method will throw an
15.62/5.15 * {@link UnsupportedOperationException} in response to its
15.62/5.15 * {@code remove} method unless the list's {@code remove(int)} method is
15.62/5.15 * overridden.
15.62/5.15 *
15.62/5.15 *
This implementation can be made to throw runtime exceptions in the
15.62/5.15 * face of concurrent modification, as described in the specification
15.62/5.15 * for the (protected) {@link #modCount} field.
15.62/5.15 *
15.62/5.15 * @return an iterator over the elements in this list in proper sequence
15.62/5.15 */
15.62/5.15 public Iterator iterator() {
15.62/5.15 return new Itr();
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * {@inheritDoc}
15.62/5.15 *
15.62/5.15 * This implementation returns {@code listIterator(0)}.
15.62/5.15 *
15.62/5.15 * @see #listIterator(int)
15.62/5.15 */
15.62/5.15 public ListIterator listIterator() {
15.62/5.15 return listIterator(0);
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * {@inheritDoc}
15.62/5.15 *
15.62/5.15 * This implementation returns a straightforward implementation of the
15.62/5.15 * {@code ListIterator} interface that extends the implementation of the
15.62/5.15 * {@code Iterator} interface returned by the {@code iterator()} method.
15.62/5.15 * The {@code ListIterator} implementation relies on the backing list's
15.62/5.15 * {@code get(int)}, {@code set(int, E)}, {@code add(int, E)}
15.62/5.15 * and {@code remove(int)} methods.
15.62/5.15 *
15.62/5.15 *
Note that the list iterator returned by this implementation will
15.62/5.15 * throw an {@link UnsupportedOperationException} in response to its
15.62/5.15 * {@code remove}, {@code set} and {@code add} methods unless the
15.62/5.15 * list's {@code remove(int)}, {@code set(int, E)}, and
15.62/5.15 * {@code add(int, E)} methods are overridden.
15.62/5.15 *
15.62/5.15 *
This implementation can be made to throw runtime exceptions in the
15.62/5.15 * face of concurrent modification, as described in the specification for
15.62/5.15 * the (protected) {@link #modCount} field.
15.62/5.15 *
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public ListIterator listIterator(final int index) {
15.62/5.15 rangeCheckForAdd(index);
15.62/5.15
15.62/5.15 return new ListItr(index);
15.62/5.15 }
15.62/5.15
15.62/5.15 private class Itr implements Iterator {
15.62/5.15 /**
15.62/5.15 * Index of element to be returned by subsequent call to next.
15.62/5.15 */
15.62/5.15 int cursor = 0;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Index of element returned by most recent call to next or
15.62/5.15 * previous. Reset to -1 if this element is deleted by a call
15.62/5.15 * to remove.
15.62/5.15 */
15.62/5.15 int lastRet = -1;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * The modCount value that the iterator believes that the backing
15.62/5.15 * List should have. If this expectation is violated, the iterator
15.62/5.15 * has detected concurrent modification.
15.62/5.15 */
15.62/5.15 int expectedModCount = modCount;
15.62/5.15
15.62/5.15 public boolean hasNext() {
15.62/5.15 return cursor != size();
15.62/5.15 }
15.62/5.15
15.62/5.15 public E next() {
15.62/5.15 checkForComodification();
15.62/5.15 try {
15.62/5.15 int i = cursor;
15.62/5.15 E next = get(i);
15.62/5.15 lastRet = i;
15.62/5.15 cursor = i + 1;
15.62/5.15 return next;
15.62/5.15 } catch (IndexOutOfBoundsException e) {
15.62/5.15 checkForComodification();
15.62/5.15 throw new NoSuchElementException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 public void remove() {
15.62/5.15 if (lastRet < 0)
15.62/5.15 throw new IllegalStateException();
15.62/5.15 checkForComodification();
15.62/5.15
15.62/5.15 try {
15.62/5.15 AbstractList.this.remove(lastRet);
15.62/5.15 if (lastRet < cursor)
15.62/5.15 cursor--;
15.62/5.15 lastRet = -1;
15.62/5.15 expectedModCount = modCount;
15.62/5.15 } catch (IndexOutOfBoundsException e) {
15.62/5.15 throw new ConcurrentModificationException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 final void checkForComodification() {
15.62/5.15 if (modCount != expectedModCount)
15.62/5.15 throw new ConcurrentModificationException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 private class ListItr extends Itr implements ListIterator {
15.62/5.15 ListItr(int index) {
15.62/5.15 cursor = index;
15.62/5.15 }
15.62/5.15
15.62/5.15 public boolean hasPrevious() {
15.62/5.15 return cursor != 0;
15.62/5.15 }
15.62/5.15
15.62/5.15 public E previous() {
15.62/5.15 checkForComodification();
15.62/5.15 try {
15.62/5.15 int i = cursor - 1;
15.62/5.15 E previous = get(i);
15.62/5.15 lastRet = cursor = i;
15.62/5.15 return previous;
15.62/5.15 } catch (IndexOutOfBoundsException e) {
15.62/5.15 checkForComodification();
15.62/5.15 throw new NoSuchElementException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 public int nextIndex() {
15.62/5.15 return cursor;
15.62/5.15 }
15.62/5.15
15.62/5.15 public int previousIndex() {
15.62/5.15 return cursor-1;
15.62/5.15 }
15.62/5.15
15.62/5.15 public void set(E e) {
15.62/5.15 if (lastRet < 0)
15.62/5.15 throw new IllegalStateException();
15.62/5.15 checkForComodification();
15.62/5.15
15.62/5.15 try {
15.62/5.15 AbstractList.this.set(lastRet, e);
15.62/5.15 expectedModCount = modCount;
15.62/5.15 } catch (IndexOutOfBoundsException ex) {
15.62/5.15 throw new ConcurrentModificationException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 public void add(E e) {
15.62/5.15 checkForComodification();
15.62/5.15
15.62/5.15 try {
15.62/5.15 int i = cursor;
15.62/5.15 AbstractList.this.add(i, e);
15.62/5.15 lastRet = -1;
15.62/5.15 cursor = i + 1;
15.62/5.15 expectedModCount = modCount;
15.62/5.15 } catch (IndexOutOfBoundsException ex) {
15.62/5.15 throw new ConcurrentModificationException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * {@inheritDoc}
15.62/5.15 *
15.62/5.15 * This implementation returns a list that subclasses
15.62/5.15 * {@code AbstractList}. The subclass stores, in private fields, the
15.62/5.15 * offset of the subList within the backing list, the size of the subList
15.62/5.15 * (which can change over its lifetime), and the expected
15.62/5.15 * {@code modCount} value of the backing list. There are two variants
15.62/5.15 * of the subclass, one of which implements {@code RandomAccess}.
15.62/5.15 * If this list implements {@code RandomAccess} the returned list will
15.62/5.15 * be an instance of the subclass that implements {@code RandomAccess}.
15.62/5.15 *
15.62/5.15 *
The subclass's {@code set(int, E)}, {@code get(int)},
15.62/5.15 * {@code add(int, E)}, {@code remove(int)}, {@code addAll(int,
15.62/5.15 * Collection)} and {@code removeRange(int, int)} methods all
15.62/5.15 * delegate to the corresponding methods on the backing abstract list,
15.62/5.15 * after bounds-checking the index and adjusting for the offset. The
15.62/5.15 * {@code addAll(Collection c)} method merely returns {@code addAll(size,
15.62/5.15 * c)}.
15.62/5.15 *
15.62/5.15 *
The {@code listIterator(int)} method returns a "wrapper object"
15.62/5.15 * over a list iterator on the backing list, which is created with the
15.62/5.15 * corresponding method on the backing list. The {@code iterator} method
15.62/5.15 * merely returns {@code listIterator()}, and the {@code size} method
15.62/5.15 * merely returns the subclass's {@code size} field.
15.62/5.15 *
15.62/5.15 *
All methods first check to see if the actual {@code modCount} of
15.62/5.15 * the backing list is equal to its expected value, and throw a
15.62/5.15 * {@code ConcurrentModificationException} if it is not.
15.62/5.15 *
15.62/5.15 * @throws IndexOutOfBoundsException if an endpoint index value is out of range
15.62/5.15 * {@code (fromIndex < 0 || toIndex > size)}
15.62/5.15 * @throws IllegalArgumentException if the endpoint indices are out of order
15.62/5.15 * {@code (fromIndex > toIndex)}
15.62/5.15 */
15.62/5.15 public List subList(int fromIndex, int toIndex) {
15.62/5.15 return (this instanceof RandomAccess ?
15.62/5.15 new RandomAccessSubList(this, fromIndex, toIndex) :
15.62/5.15 new SubList(this, fromIndex, toIndex));
15.62/5.15 }
15.62/5.15
15.62/5.15 // Comparison and hashing
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Compares the specified object with this list for equality. Returns
15.62/5.15 * {@code true} if and only if the specified object is also a list, both
15.62/5.15 * lists have the same size, and all corresponding pairs of elements in
15.62/5.15 * the two lists are equal. (Two elements {@code e1} and
15.62/5.15 * {@code e2} are equal if {@code (e1==null ? e2==null :
15.62/5.15 * e1.equals(e2))}.) In other words, two lists are defined to be
15.62/5.15 * equal if they contain the same elements in the same order.
15.62/5.15 *
15.62/5.15 * This implementation first checks if the specified object is this
15.62/5.15 * list. If so, it returns {@code true}; if not, it checks if the
15.62/5.15 * specified object is a list. If not, it returns {@code false}; if so,
15.62/5.15 * it iterates over both lists, comparing corresponding pairs of elements.
15.62/5.15 * If any comparison returns {@code false}, this method returns
15.62/5.15 * {@code false}. If either iterator runs out of elements before the
15.62/5.15 * other it returns {@code false} (as the lists are of unequal length);
15.62/5.15 * otherwise it returns {@code true} when the iterations complete.
15.62/5.15 *
15.62/5.15 * @param o the object to be compared for equality with this list
15.62/5.15 * @return {@code true} if the specified object is equal to this list
15.62/5.15 */
15.62/5.15 public boolean equals(Object o) {
15.62/5.15 if (o == this)
15.62/5.15 return true;
15.62/5.15 if (!(o instanceof List))
15.62/5.15 return false;
15.62/5.15
15.62/5.15 ListIterator e1 = listIterator();
15.62/5.15 ListIterator e2 = ((List) o).listIterator();
15.62/5.15 while(e1.hasNext() && e2.hasNext()) {
15.62/5.15 E o1 = e1.next();
15.62/5.15 Object o2 = e2.next();
15.62/5.15 if (!(o1==null ? o2==null : o1.equals(o2)))
15.62/5.15 return false;
15.62/5.15 }
15.62/5.15 return !(e1.hasNext() || e2.hasNext());
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns the hash code value for this list.
15.62/5.15 *
15.62/5.15 * This implementation uses exactly the code that is used to define the
15.62/5.15 * list hash function in the documentation for the {@link List#hashCode}
15.62/5.15 * method.
15.62/5.15 *
15.62/5.15 * @return the hash code value for this list
15.62/5.15 */
15.62/5.15 public int hashCode() {
15.62/5.15 int hashCode = 1;
15.62/5.15 Iterator it = this.iterator();
15.62/5.15 while (it.hasNext()) {
15.62/5.15 E e = it.next();
15.62/5.15 hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());
15.62/5.15 }
15.62/5.15 return hashCode;
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes from this list all of the elements whose index is between
15.62/5.15 * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
15.62/5.15 * Shifts any succeeding elements to the left (reduces their index).
15.62/5.15 * This call shortens the list by {@code (toIndex - fromIndex)} elements.
15.62/5.15 * (If {@code toIndex==fromIndex}, this operation has no effect.)
15.62/5.15 *
15.62/5.15 * This method is called by the {@code clear} operation on this list
15.62/5.15 * and its subLists. Overriding this method to take advantage of
15.62/5.15 * the internals of the list implementation can substantially
15.62/5.15 * improve the performance of the {@code clear} operation on this list
15.62/5.15 * and its subLists.
15.62/5.15 *
15.62/5.15 *
This implementation gets a list iterator positioned before
15.62/5.15 * {@code fromIndex}, and repeatedly calls {@code ListIterator.next}
15.62/5.15 * followed by {@code ListIterator.remove} until the entire range has
15.62/5.15 * been removed. Note: if {@code ListIterator.remove} requires linear
15.62/5.15 * time, this implementation requires quadratic time.
15.62/5.15 *
15.62/5.15 * @param fromIndex index of first element to be removed
15.62/5.15 * @param toIndex index after last element to be removed
15.62/5.15 */
15.62/5.15 protected void removeRange(int fromIndex, int toIndex) {
15.62/5.15 ListIterator it = listIterator(fromIndex);
15.62/5.15 for (int i=0, n=toIndex-fromIndex; istructurally modified.
15.62/5.15 * Structural modifications are those that change the size of the
15.62/5.15 * list, or otherwise perturb it in such a fashion that iterations in
15.62/5.15 * progress may yield incorrect results.
15.62/5.15 *
15.62/5.15 * This field is used by the iterator and list iterator implementation
15.62/5.15 * returned by the {@code iterator} and {@code listIterator} methods.
15.62/5.15 * If the value of this field changes unexpectedly, the iterator (or list
15.62/5.15 * iterator) will throw a {@code ConcurrentModificationException} in
15.62/5.15 * response to the {@code next}, {@code remove}, {@code previous},
15.62/5.15 * {@code set} or {@code add} operations. This provides
15.62/5.15 * fail-fast behavior, rather than non-deterministic behavior in
15.62/5.15 * the face of concurrent modification during iteration.
15.62/5.15 *
15.62/5.15 *
Use of this field by subclasses is optional. If a subclass
15.62/5.15 * wishes to provide fail-fast iterators (and list iterators), then it
15.62/5.15 * merely has to increment this field in its {@code add(int, E)} and
15.62/5.15 * {@code remove(int)} methods (and any other methods that it overrides
15.62/5.15 * that result in structural modifications to the list). A single call to
15.62/5.15 * {@code add(int, E)} or {@code remove(int)} must add no more than
15.62/5.15 * one to this field, or the iterators (and list iterators) will throw
15.62/5.15 * bogus {@code ConcurrentModificationExceptions}. If an implementation
15.62/5.15 * does not wish to provide fail-fast iterators, this field may be
15.62/5.15 * ignored.
15.62/5.15 */
15.62/5.15 protected transient int modCount = 0;
15.62/5.15
15.62/5.15 private void rangeCheckForAdd(int index) {
15.62/5.15 if (index < 0 || index > size())
15.62/5.15 throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
15.62/5.15 }
15.62/5.15
15.62/5.15 private String outOfBoundsMsg(int index) {
15.62/5.15 return "";
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 class SubList extends AbstractList {
15.62/5.15 private final AbstractList l;
15.62/5.15 private final int offset;
15.62/5.15 private int size;
15.62/5.15
15.62/5.15 SubList(AbstractList list, int fromIndex, int toIndex) {
15.62/5.15 if (fromIndex < 0)
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 if (toIndex > list.size())
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 if (fromIndex > toIndex)
15.62/5.15 throw new IllegalArgumentException();
15.62/5.15 l = list;
15.62/5.15 offset = fromIndex;
15.62/5.15 size = toIndex - fromIndex;
15.62/5.15 this.modCount = l.modCount;
15.62/5.15 }
15.62/5.15
15.62/5.15 public E set(int index, E element) {
15.62/5.15 rangeCheck(index);
15.62/5.15 checkForComodification();
15.62/5.15 return l.set(index+offset, element);
15.62/5.15 }
15.62/5.15
15.62/5.15 public E get(int index) {
15.62/5.15 rangeCheck(index);
15.62/5.15 checkForComodification();
15.62/5.15 return l.get(index+offset);
15.62/5.15 }
15.62/5.15
15.62/5.15 public int size() {
15.62/5.15 checkForComodification();
15.62/5.15 return size;
15.62/5.15 }
15.62/5.15
15.62/5.15 public void add(int index, E element) {
15.62/5.15 rangeCheckForAdd(index);
15.62/5.15 checkForComodification();
15.62/5.15 l.add(index+offset, element);
15.62/5.15 this.modCount = l.modCount;
15.62/5.15 size++;
15.62/5.15 }
15.62/5.15
15.62/5.15 public E remove(int index) {
15.62/5.15 rangeCheck(index);
15.62/5.15 checkForComodification();
15.62/5.15 E result = l.remove(index+offset);
15.62/5.15 this.modCount = l.modCount;
15.62/5.15 size--;
15.62/5.15 return result;
15.62/5.15 }
15.62/5.15
15.62/5.15 protected void removeRange(int fromIndex, int toIndex) {
15.62/5.15 checkForComodification();
15.62/5.15 l.removeRange(fromIndex+offset, toIndex+offset);
15.62/5.15 this.modCount = l.modCount;
15.62/5.15 size -= (toIndex-fromIndex);
15.62/5.15 }
15.62/5.15
15.62/5.15 public boolean addAll(Collection c) {
15.62/5.15 return addAll(size, c);
15.62/5.15 }
15.62/5.15
15.62/5.15 public boolean addAll(int index, Collection c) {
15.62/5.15 rangeCheckForAdd(index);
15.62/5.15 int cSize = c.size();
15.62/5.15 if (cSize==0)
15.62/5.15 return false;
15.62/5.15
15.62/5.15 checkForComodification();
15.62/5.15 l.addAll(offset+index, c);
15.62/5.15 this.modCount = l.modCount;
15.62/5.15 size += cSize;
15.62/5.15 return true;
15.62/5.15 }
15.62/5.15
15.62/5.15 public Iterator iterator() {
15.62/5.15 return listIterator();
15.62/5.15 }
15.62/5.15
15.62/5.15 public ListIterator listIterator(final int index) {
15.62/5.15 checkForComodification();
15.62/5.15 rangeCheckForAdd(index);
15.62/5.15
15.62/5.15 return new ListIterator() {
15.62/5.15 private final ListIterator i = l.listIterator(index+offset);
15.62/5.15
15.62/5.15 public boolean hasNext() {
15.62/5.15 return nextIndex() < size;
15.62/5.15 }
15.62/5.15
15.62/5.15 public E next() {
15.62/5.15 if (hasNext())
15.62/5.15 return i.next();
15.62/5.15 else
15.62/5.15 throw new NoSuchElementException();
15.62/5.15 }
15.62/5.15
15.62/5.15 public boolean hasPrevious() {
15.62/5.15 return previousIndex() >= 0;
15.62/5.15 }
15.62/5.15
15.62/5.15 public E previous() {
15.62/5.15 if (hasPrevious())
15.62/5.15 return i.previous();
15.62/5.15 else
15.62/5.15 throw new NoSuchElementException();
15.62/5.15 }
15.62/5.15
15.62/5.15 public int nextIndex() {
15.62/5.15 return i.nextIndex() - offset;
15.62/5.15 }
15.62/5.15
15.62/5.15 public int previousIndex() {
15.62/5.15 return i.previousIndex() - offset;
15.62/5.15 }
15.62/5.15
15.62/5.15 public void remove() {
15.62/5.15 i.remove();
15.62/5.15 SubList.this.modCount = l.modCount;
15.62/5.15 size--;
15.62/5.15 }
15.62/5.15
15.62/5.15 public void set(E e) {
15.62/5.15 i.set(e);
15.62/5.15 }
15.62/5.15
15.62/5.15 public void add(E e) {
15.62/5.15 i.add(e);
15.62/5.15 SubList.this.modCount = l.modCount;
15.62/5.15 size++;
15.62/5.15 }
15.62/5.15 };
15.62/5.15 }
15.62/5.15
15.62/5.15 public List subList(int fromIndex, int toIndex) {
15.62/5.15 return new SubList(this, fromIndex, toIndex);
15.62/5.15 }
15.62/5.15
15.62/5.15 private void rangeCheck(int index) {
15.62/5.15 if (index < 0 || index >= size)
15.62/5.15 throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
15.62/5.15 }
15.62/5.15
15.62/5.15 private void rangeCheckForAdd(int index) {
15.62/5.15 if (index < 0 || index > size)
15.62/5.15 throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
15.62/5.15 }
15.62/5.15
15.62/5.15 private String outOfBoundsMsg(int index) {
15.62/5.15 return "";
15.62/5.15 }
15.62/5.15
15.62/5.15 private void checkForComodification() {
15.62/5.15 if (this.modCount != l.modCount)
15.62/5.15 throw new ConcurrentModificationException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 class RandomAccessSubList extends SubList implements RandomAccess {
15.62/5.15 RandomAccessSubList(AbstractList list, int fromIndex, int toIndex) {
15.62/5.15 super(list, fromIndex, toIndex);
15.62/5.15 }
15.62/5.15
15.62/5.15 public List subList(int fromIndex, int toIndex) {
15.62/5.15 return new RandomAccessSubList(this, fromIndex, toIndex);
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 /*
15.62/5.15 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.15 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.15 *
15.62/5.15 * This code is free software; you can redistribute it and/or modify it
15.62/5.15 * under the terms of the GNU General Public License version 2 only, as
15.62/5.15 * published by the Free Software Foundation. Sun designates this
15.62/5.15 * particular file as subject to the "Classpath" exception as provided
15.62/5.15 * by Sun in the LICENSE file that accompanied this code.
15.62/5.15 *
15.62/5.15 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.15 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.15 * accompanied this code).
15.62/5.15 *
15.62/5.15 * You should have received a copy of the GNU General Public License version
15.62/5.15 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.15 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.15 *
15.62/5.15 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.15 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.15 * have any questions.
15.62/5.15 */
15.62/5.15
15.62/5.15 package javaUtilEx;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * This class provides a skeletal implementation of the List
15.62/5.15 * interface to minimize the effort required to implement this interface
15.62/5.15 * backed by a "sequential access" data store (such as a linked list). For
15.62/5.15 * random access data (such as an array), AbstractList should be used
15.62/5.15 * in preference to this class.
15.62/5.15 *
15.62/5.15 * This class is the opposite of the AbstractList class in the sense
15.62/5.15 * that it implements the "random access" methods (get(int index),
15.62/5.15 * set(int index, E element), add(int index, E element) and
15.62/5.15 * remove(int index)) on top of the list's list iterator, instead of
15.62/5.15 * the other way around.
15.62/5.15 *
15.62/5.15 * To implement a list the programmer needs only to extend this class and
15.62/5.15 * provide implementations for the listIterator and size
15.62/5.15 * methods. For an unmodifiable list, the programmer need only implement the
15.62/5.15 * list iterator's hasNext, next, hasPrevious,
15.62/5.15 * previous and index methods.
15.62/5.15 *
15.62/5.15 * For a modifiable list the programmer should additionally implement the list
15.62/5.15 * iterator's set method. For a variable-size list the programmer
15.62/5.15 * should additionally implement the list iterator's remove and
15.62/5.15 * add methods.
15.62/5.15 *
15.62/5.15 * The programmer should generally provide a void (no argument) and collection
15.62/5.15 * constructor, as per the recommendation in the Collection interface
15.62/5.15 * specification.
15.62/5.15 *
15.62/5.15 * This class is a member of the
15.62/5.15 *
15.62/5.15 * Java Collections Framework.
15.62/5.15 *
15.62/5.15 * @author Josh Bloch
15.62/5.15 * @author Neal Gafter
15.62/5.15 * @see Collection
15.62/5.15 * @see List
15.62/5.15 * @see AbstractList
15.62/5.15 * @see AbstractCollection
15.62/5.15 * @since 1.2
15.62/5.15 */
15.62/5.15
15.62/5.15 public abstract class AbstractSequentialList extends AbstractList {
15.62/5.15 /**
15.62/5.15 * Sole constructor. (For invocation by subclass constructors, typically
15.62/5.15 * implicit.)
15.62/5.15 */
15.62/5.15 protected AbstractSequentialList() {
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns the element at the specified position in this list.
15.62/5.15 *
15.62/5.15 * This implementation first gets a list iterator pointing to the
15.62/5.15 * indexed element (with listIterator(index)). Then, it gets
15.62/5.15 * the element using ListIterator.next and returns it.
15.62/5.15 *
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public E get(int index) {
15.62/5.15 try {
15.62/5.15 return listIterator(index).next();
15.62/5.15 } catch (NoSuchElementException exc) {
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Replaces the element at the specified position in this list with the
15.62/5.15 * specified element (optional operation).
15.62/5.15 *
15.62/5.15 *
This implementation first gets a list iterator pointing to the
15.62/5.15 * indexed element (with listIterator(index)). Then, it gets
15.62/5.15 * the current element using ListIterator.next and replaces it
15.62/5.15 * with ListIterator.set.
15.62/5.15 *
15.62/5.15 *
Note that this implementation will throw an
15.62/5.15 * UnsupportedOperationException if the list iterator does not
15.62/5.15 * implement the set operation.
15.62/5.15 *
15.62/5.15 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.15 * @throws ClassCastException {@inheritDoc}
15.62/5.15 * @throws NullPointerException {@inheritDoc}
15.62/5.15 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public E set(int index, E element) {
15.62/5.15 try {
15.62/5.15 ListIterator e = listIterator(index);
15.62/5.15 E oldVal = e.next();
15.62/5.15 e.set(element);
15.62/5.15 return oldVal;
15.62/5.15 } catch (NoSuchElementException exc) {
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts the specified element at the specified position in this list
15.62/5.15 * (optional operation). Shifts the element currently at that position
15.62/5.15 * (if any) and any subsequent elements to the right (adds one to their
15.62/5.15 * indices).
15.62/5.15 *
15.62/5.15 * This implementation first gets a list iterator pointing to the
15.62/5.15 * indexed element (with listIterator(index)). Then, it
15.62/5.15 * inserts the specified element with ListIterator.add.
15.62/5.15 *
15.62/5.15 *
Note that this implementation will throw an
15.62/5.15 * UnsupportedOperationException if the list iterator does not
15.62/5.15 * implement the add operation.
15.62/5.15 *
15.62/5.15 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.15 * @throws ClassCastException {@inheritDoc}
15.62/5.15 * @throws NullPointerException {@inheritDoc}
15.62/5.15 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public void add(int index, E element) {
15.62/5.15 try {
15.62/5.15 listIterator(index).add(element);
15.62/5.15 } catch (NoSuchElementException exc) {
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes the element at the specified position in this list (optional
15.62/5.15 * operation). Shifts any subsequent elements to the left (subtracts one
15.62/5.15 * from their indices). Returns the element that was removed from the
15.62/5.15 * list.
15.62/5.15 *
15.62/5.15 *
This implementation first gets a list iterator pointing to the
15.62/5.15 * indexed element (with listIterator(index)). Then, it removes
15.62/5.15 * the element with ListIterator.remove.
15.62/5.15 *
15.62/5.15 *
Note that this implementation will throw an
15.62/5.15 * UnsupportedOperationException if the list iterator does not
15.62/5.15 * implement the remove operation.
15.62/5.15 *
15.62/5.15 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public E remove(int index) {
15.62/5.15 try {
15.62/5.15 ListIterator e = listIterator(index);
15.62/5.15 E outCast = e.next();
15.62/5.15 e.remove();
15.62/5.15 return outCast;
15.62/5.15 } catch (NoSuchElementException exc) {
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 // Bulk Operations
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts all of the elements in the specified collection into this
15.62/5.15 * list at the specified position (optional operation). Shifts the
15.62/5.15 * element currently at that position (if any) and any subsequent
15.62/5.15 * elements to the right (increases their indices). The new elements
15.62/5.15 * will appear in this list in the order that they are returned by the
15.62/5.15 * specified collection's iterator. The behavior of this operation is
15.62/5.15 * undefined if the specified collection is modified while the
15.62/5.15 * operation is in progress. (Note that this will occur if the specified
15.62/5.15 * collection is this list, and it's nonempty.)
15.62/5.15 *
15.62/5.15 * This implementation gets an iterator over the specified collection and
15.62/5.15 * a list iterator over this list pointing to the indexed element (with
15.62/5.15 * listIterator(index)). Then, it iterates over the specified
15.62/5.15 * collection, inserting the elements obtained from the iterator into this
15.62/5.15 * list, one at a time, using ListIterator.add followed by
15.62/5.15 * ListIterator.next (to skip over the added element).
15.62/5.15 *
15.62/5.15 *
Note that this implementation will throw an
15.62/5.15 * UnsupportedOperationException if the list iterator returned by
15.62/5.15 * the listIterator method does not implement the add
15.62/5.15 * operation.
15.62/5.15 *
15.62/5.15 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.15 * @throws ClassCastException {@inheritDoc}
15.62/5.15 * @throws NullPointerException {@inheritDoc}
15.62/5.15 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public boolean addAll(int index, Collection c) {
15.62/5.15 try {
15.62/5.15 boolean modified = false;
15.62/5.15 ListIterator e1 = listIterator(index);
15.62/5.15 Iterator e2 = c.iterator();
15.62/5.15 while (e2.hasNext()) {
15.62/5.15 e1.add(e2.next());
15.62/5.15 modified = true;
15.62/5.15 }
15.62/5.15 return modified;
15.62/5.15 } catch (NoSuchElementException exc) {
15.62/5.15 throw new IndexOutOfBoundsException();
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 // Iterators
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns an iterator over the elements in this list (in proper
15.62/5.15 * sequence).
15.62/5.15 *
15.62/5.15 * This implementation merely returns a list iterator over the list.
15.62/5.15 *
15.62/5.15 * @return an iterator over the elements in this list (in proper sequence)
15.62/5.15 */
15.62/5.15 public Iterator iterator() {
15.62/5.15 return listIterator();
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns a list iterator over the elements in this list (in proper
15.62/5.15 * sequence).
15.62/5.15 *
15.62/5.15 * @param index index of first element to be returned from the list
15.62/5.15 * iterator (by a call to the next method)
15.62/5.15 * @return a list iterator over the elements in this list (in proper
15.62/5.15 * sequence)
15.62/5.15 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.15 */
15.62/5.15 public abstract ListIterator listIterator(int index);
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 /*
15.62/5.15 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.15 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.15 *
15.62/5.15 * This code is free software; you can redistribute it and/or modify it
15.62/5.15 * under the terms of the GNU General Public License version 2 only, as
15.62/5.15 * published by the Free Software Foundation. Sun designates this
15.62/5.15 * particular file as subject to the "Classpath" exception as provided
15.62/5.15 * by Sun in the LICENSE file that accompanied this code.
15.62/5.15 *
15.62/5.15 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.15 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.15 * accompanied this code).
15.62/5.15 *
15.62/5.15 * You should have received a copy of the GNU General Public License version
15.62/5.15 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.15 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.15 *
15.62/5.15 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.15 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.15 * have any questions.
15.62/5.15 */
15.62/5.15
15.62/5.15 package javaUtilEx;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * The root interface in the collection hierarchy. A collection
15.62/5.15 * represents a group of objects, known as its elements. Some
15.62/5.15 * collections allow duplicate elements and others do not. Some are ordered
15.62/5.15 * and others unordered. The JDK does not provide any direct
15.62/5.15 * implementations of this interface: it provides implementations of more
15.62/5.15 * specific subinterfaces like Set and List. This interface
15.62/5.15 * is typically used to pass collections around and manipulate them where
15.62/5.15 * maximum generality is desired.
15.62/5.15 *
15.62/5.15 * Bags or multisets (unordered collections that may contain
15.62/5.15 * duplicate elements) should implement this interface directly.
15.62/5.15 *
15.62/5.15 *
All general-purpose Collection implementation classes (which
15.62/5.15 * typically implement Collection indirectly through one of its
15.62/5.15 * subinterfaces) should provide two "standard" constructors: a void (no
15.62/5.15 * arguments) constructor, which creates an empty collection, and a
15.62/5.15 * constructor with a single argument of type Collection, which
15.62/5.15 * creates a new collection with the same elements as its argument. In
15.62/5.15 * effect, the latter constructor allows the user to copy any collection,
15.62/5.15 * producing an equivalent collection of the desired implementation type.
15.62/5.15 * There is no way to enforce this convention (as interfaces cannot contain
15.62/5.15 * constructors) but all of the general-purpose Collection
15.62/5.15 * implementations in the Java platform libraries comply.
15.62/5.15 *
15.62/5.15 *
The "destructive" methods contained in this interface, that is, the
15.62/5.15 * methods that modify the collection on which they operate, are specified to
15.62/5.15 * throw UnsupportedOperationException if this collection does not
15.62/5.15 * support the operation. If this is the case, these methods may, but are not
15.62/5.15 * required to, throw an UnsupportedOperationException if the
15.62/5.15 * invocation would have no effect on the collection. For example, invoking
15.62/5.15 * the {@link #addAll(Collection)} method on an unmodifiable collection may,
15.62/5.15 * but is not required to, throw the exception if the collection to be added
15.62/5.15 * is empty.
15.62/5.15 *
15.62/5.15 *
Some collection implementations have restrictions on the elements that
15.62/5.15 * they may contain. For example, some implementations prohibit null elements,
15.62/5.15 * and some have restrictions on the types of their elements. Attempting to
15.62/5.15 * add an ineligible element throws an unchecked exception, typically
15.62/5.15 * NullPointerException or ClassCastException. Attempting
15.62/5.15 * to query the presence of an ineligible element may throw an exception,
15.62/5.15 * or it may simply return false; some implementations will exhibit the former
15.62/5.15 * behavior and some will exhibit the latter. More generally, attempting an
15.62/5.15 * operation on an ineligible element whose completion would not result in
15.62/5.15 * the insertion of an ineligible element into the collection may throw an
15.62/5.15 * exception or it may succeed, at the option of the implementation.
15.62/5.15 * Such exceptions are marked as "optional" in the specification for this
15.62/5.15 * interface.
15.62/5.15 *
15.62/5.15 *
It is up to each collection to determine its own synchronization
15.62/5.15 * policy. In the absence of a stronger guarantee by the
15.62/5.15 * implementation, undefined behavior may result from the invocation
15.62/5.15 * of any method on a collection that is being mutated by another
15.62/5.15 * thread; this includes direct invocations, passing the collection to
15.62/5.15 * a method that might perform invocations, and using an existing
15.62/5.15 * iterator to examine the collection.
15.62/5.15 *
15.62/5.15 *
Many methods in Collections Framework interfaces are defined in
15.62/5.15 * terms of the {@link Object#equals(Object) equals} method. For example,
15.62/5.15 * the specification for the {@link #contains(Object) contains(Object o)}
15.62/5.15 * method says: "returns true if and only if this collection
15.62/5.15 * contains at least one element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e))." This specification should
15.62/5.15 * not be construed to imply that invoking Collection.contains
15.62/5.15 * with a non-null argument o will cause o.equals(e) to be
15.62/5.15 * invoked for any element e. Implementations are free to implement
15.62/5.15 * optimizations whereby the equals invocation is avoided, for
15.62/5.15 * example, by first comparing the hash codes of the two elements. (The
15.62/5.15 * {@link Object#hashCode()} specification guarantees that two objects with
15.62/5.15 * unequal hash codes cannot be equal.) More generally, implementations of
15.62/5.15 * the various Collections Framework interfaces are free to take advantage of
15.62/5.15 * the specified behavior of underlying {@link Object} methods wherever the
15.62/5.15 * implementor deems it appropriate.
15.62/5.15 *
15.62/5.15 *
This interface is a member of the
15.62/5.15 *
15.62/5.15 * Java Collections Framework.
15.62/5.15 *
15.62/5.15 * @author Josh Bloch
15.62/5.15 * @author Neal Gafter
15.62/5.15 * @see Set
15.62/5.15 * @see List
15.62/5.15 * @see Map
15.62/5.15 * @see SortedSet
15.62/5.15 * @see SortedMap
15.62/5.15 * @see HashSet
15.62/5.15 * @see TreeSet
15.62/5.15 * @see ArrayList
15.62/5.15 * @see LinkedList
15.62/5.15 * @see Vector
15.62/5.15 * @see Collections
15.62/5.15 * @see Arrays
15.62/5.15 * @see AbstractCollection
15.62/5.15 * @since 1.2
15.62/5.15 */
15.62/5.15
15.62/5.15 public interface Collection {
15.62/5.15 // Query Operations
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns the number of elements in this collection. If this collection
15.62/5.15 * contains more than Integer.MAX_VALUE elements, returns
15.62/5.15 * Integer.MAX_VALUE.
15.62/5.15 *
15.62/5.15 * @return the number of elements in this collection
15.62/5.15 */
15.62/5.15 int size();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns true if this collection contains no elements.
15.62/5.15 *
15.62/5.15 * @return true if this collection contains no elements
15.62/5.15 */
15.62/5.15 boolean isEmpty();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns true if this collection contains the specified element.
15.62/5.15 * More formally, returns true if and only if this collection
15.62/5.15 * contains at least one element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e)).
15.62/5.15 *
15.62/5.15 * @param o element whose presence in this collection is to be tested
15.62/5.15 * @return true if this collection contains the specified
15.62/5.15 * element
15.62/5.15 * @throws ClassCastException if the type of the specified element
15.62/5.15 * is incompatible with this collection (optional)
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * collection does not permit null elements (optional)
15.62/5.15 */
15.62/5.15 boolean contains(Object o);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns an iterator over the elements in this collection. There are no
15.62/5.15 * guarantees concerning the order in which the elements are returned
15.62/5.15 * (unless this collection is an instance of some class that provides a
15.62/5.15 * guarantee).
15.62/5.15 *
15.62/5.15 * @return an Iterator over the elements in this collection
15.62/5.15 */
15.62/5.15 Iterator iterator();
15.62/5.15
15.62/5.15 // Modification Operations
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Ensures that this collection contains the specified element (optional
15.62/5.15 * operation). Returns true if this collection changed as a
15.62/5.15 * result of the call. (Returns false if this collection does
15.62/5.15 * not permit duplicates and already contains the specified element.)
15.62/5.15 *
15.62/5.15 * Collections that support this operation may place limitations on what
15.62/5.15 * elements may be added to this collection. In particular, some
15.62/5.15 * collections will refuse to add null elements, and others will
15.62/5.15 * impose restrictions on the type of elements that may be added.
15.62/5.15 * Collection classes should clearly specify in their documentation any
15.62/5.15 * restrictions on what elements may be added.
15.62/5.15 *
15.62/5.15 * If a collection refuses to add a particular element for any reason
15.62/5.15 * other than that it already contains the element, it must throw
15.62/5.15 * an exception (rather than returning false). This preserves
15.62/5.15 * the invariant that a collection always contains the specified element
15.62/5.15 * after this call returns.
15.62/5.15 *
15.62/5.15 * @param e element whose presence in this collection is to be ensured
15.62/5.15 * @return true if this collection changed as a result of the
15.62/5.15 * call
15.62/5.15 * @throws UnsupportedOperationException if the add operation
15.62/5.15 * is not supported by this collection
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this collection
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * collection does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the element
15.62/5.15 * prevents it from being added to this collection
15.62/5.15 * @throws IllegalStateException if the element cannot be added at this
15.62/5.15 * time due to insertion restrictions
15.62/5.15 */
15.62/5.15 boolean add(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes a single instance of the specified element from this
15.62/5.15 * collection, if it is present (optional operation). More formally,
15.62/5.15 * removes an element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e)), if
15.62/5.15 * this collection contains one or more such elements. Returns
15.62/5.15 * true if this collection contained the specified element (or
15.62/5.15 * equivalently, if this collection changed as a result of the call).
15.62/5.15 *
15.62/5.15 * @param o element to be removed from this collection, if present
15.62/5.15 * @return true if an element was removed as a result of this call
15.62/5.15 * @throws ClassCastException if the type of the specified element
15.62/5.15 * is incompatible with this collection (optional)
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * collection does not permit null elements (optional)
15.62/5.15 * @throws UnsupportedOperationException if the remove operation
15.62/5.15 * is not supported by this collection
15.62/5.15 */
15.62/5.15 boolean remove(Object o);
15.62/5.15
15.62/5.15
15.62/5.15 // Bulk Operations
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns true if this collection contains all of the elements
15.62/5.15 * in the specified collection.
15.62/5.15 *
15.62/5.15 * @param c collection to be checked for containment in this collection
15.62/5.15 * @return true if this collection contains all of the elements
15.62/5.15 * in the specified collection
15.62/5.15 * @throws ClassCastException if the types of one or more elements
15.62/5.15 * in the specified collection are incompatible with this
15.62/5.15 * collection (optional)
15.62/5.15 * @throws NullPointerException if the specified collection contains one
15.62/5.15 * or more null elements and this collection does not permit null
15.62/5.15 * elements (optional), or if the specified collection is null
15.62/5.15 * @see #contains(Object)
15.62/5.15 */
15.62/5.15 boolean containsAll(Collection c);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Adds all of the elements in the specified collection to this collection
15.62/5.15 * (optional operation). The behavior of this operation is undefined if
15.62/5.15 * the specified collection is modified while the operation is in progress.
15.62/5.15 * (This implies that the behavior of this call is undefined if the
15.62/5.15 * specified collection is this collection, and this collection is
15.62/5.15 * nonempty.)
15.62/5.15 *
15.62/5.15 * @param c collection containing elements to be added to this collection
15.62/5.15 * @return true if this collection changed as a result of the call
15.62/5.15 * @throws UnsupportedOperationException if the addAll operation
15.62/5.15 * is not supported by this collection
15.62/5.15 * @throws ClassCastException if the class of an element of the specified
15.62/5.15 * collection prevents it from being added to this collection
15.62/5.15 * @throws NullPointerException if the specified collection contains a
15.62/5.15 * null element and this collection does not permit null elements,
15.62/5.15 * or if the specified collection is null
15.62/5.15 * @throws IllegalArgumentException if some property of an element of the
15.62/5.15 * specified collection prevents it from being added to this
15.62/5.15 * collection
15.62/5.15 * @throws IllegalStateException if not all the elements can be added at
15.62/5.15 * this time due to insertion restrictions
15.62/5.15 * @see #add(Object)
15.62/5.15 */
15.62/5.15 boolean addAll(Collection c);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes all of this collection's elements that are also contained in the
15.62/5.15 * specified collection (optional operation). After this call returns,
15.62/5.15 * this collection will contain no elements in common with the specified
15.62/5.15 * collection.
15.62/5.15 *
15.62/5.15 * @param c collection containing elements to be removed from this collection
15.62/5.15 * @return true if this collection changed as a result of the
15.62/5.15 * call
15.62/5.15 * @throws UnsupportedOperationException if the removeAll method
15.62/5.15 * is not supported by this collection
15.62/5.15 * @throws ClassCastException if the types of one or more elements
15.62/5.15 * in this collection are incompatible with the specified
15.62/5.15 * collection (optional)
15.62/5.15 * @throws NullPointerException if this collection contains one or more
15.62/5.15 * null elements and the specified collection does not support
15.62/5.15 * null elements (optional), or if the specified collection is null
15.62/5.15 * @see #remove(Object)
15.62/5.15 * @see #contains(Object)
15.62/5.15 */
15.62/5.15 boolean removeAll(Collection c);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retains only the elements in this collection that are contained in the
15.62/5.15 * specified collection (optional operation). In other words, removes from
15.62/5.15 * this collection all of its elements that are not contained in the
15.62/5.15 * specified collection.
15.62/5.15 *
15.62/5.15 * @param c collection containing elements to be retained in this collection
15.62/5.15 * @return true if this collection changed as a result of the call
15.62/5.15 * @throws UnsupportedOperationException if the retainAll operation
15.62/5.15 * is not supported by this collection
15.62/5.15 * @throws ClassCastException if the types of one or more elements
15.62/5.15 * in this collection are incompatible with the specified
15.62/5.15 * collection (optional)
15.62/5.15 * @throws NullPointerException if this collection contains one or more
15.62/5.15 * null elements and the specified collection does not permit null
15.62/5.15 * elements (optional), or if the specified collection is null
15.62/5.15 * @see #remove(Object)
15.62/5.15 * @see #contains(Object)
15.62/5.15 */
15.62/5.15 boolean retainAll(Collection c);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes all of the elements from this collection (optional operation).
15.62/5.15 * The collection will be empty after this method returns.
15.62/5.15 *
15.62/5.15 * @throws UnsupportedOperationException if the clear operation
15.62/5.15 * is not supported by this collection
15.62/5.15 */
15.62/5.15 void clear();
15.62/5.15
15.62/5.15
15.62/5.15 // Comparison and hashing
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Compares the specified object with this collection for equality.
15.62/5.15 *
15.62/5.15 * While the Collection interface adds no stipulations to the
15.62/5.15 * general contract for the Object.equals, programmers who
15.62/5.15 * implement the Collection interface "directly" (in other words,
15.62/5.15 * create a class that is a Collection but is not a Set
15.62/5.15 * or a List) must exercise care if they choose to override the
15.62/5.15 * Object.equals. It is not necessary to do so, and the simplest
15.62/5.15 * course of action is to rely on Object's implementation, but
15.62/5.15 * the implementor may wish to implement a "value comparison" in place of
15.62/5.15 * the default "reference comparison." (The List and
15.62/5.15 * Set interfaces mandate such value comparisons.)
15.62/5.15 *
15.62/5.15 * The general contract for the Object.equals method states that
15.62/5.15 * equals must be symmetric (in other words, a.equals(b) if and
15.62/5.15 * only if b.equals(a)). The contracts for List.equals
15.62/5.15 * and Set.equals state that lists are only equal to other lists,
15.62/5.15 * and sets to other sets. Thus, a custom equals method for a
15.62/5.15 * collection class that implements neither the List nor
15.62/5.15 * Set interface must return false when this collection
15.62/5.15 * is compared to any list or set. (By the same logic, it is not possible
15.62/5.15 * to write a class that correctly implements both the Set and
15.62/5.15 * List interfaces.)
15.62/5.15 *
15.62/5.15 * @param o object to be compared for equality with this collection
15.62/5.15 * @return true if the specified object is equal to this
15.62/5.15 * collection
15.62/5.15 *
15.62/5.15 * @see Object#equals(Object)
15.62/5.15 * @see Set#equals(Object)
15.62/5.15 * @see List#equals(Object)
15.62/5.15 */
15.62/5.15 boolean equals(Object o);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns the hash code value for this collection. While the
15.62/5.15 * Collection interface adds no stipulations to the general
15.62/5.15 * contract for the Object.hashCode method, programmers should
15.62/5.15 * take note that any class that overrides the Object.equals
15.62/5.15 * method must also override the Object.hashCode method in order
15.62/5.15 * to satisfy the general contract for the Object.hashCodemethod.
15.62/5.15 * In particular, c1.equals(c2) implies that
15.62/5.15 * c1.hashCode()==c2.hashCode().
15.62/5.15 *
15.62/5.15 * @return the hash code value for this collection
15.62/5.15 *
15.62/5.15 * @see Object#hashCode()
15.62/5.15 * @see Object#equals(Object)
15.62/5.15 */
15.62/5.15 int hashCode();
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 /*
15.62/5.15 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.15 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.15 *
15.62/5.15 * This code is free software; you can redistribute it and/or modify it
15.62/5.15 * under the terms of the GNU General Public License version 2 only, as
15.62/5.15 * published by the Free Software Foundation. Sun designates this
15.62/5.15 * particular file as subject to the "Classpath" exception as provided
15.62/5.15 * by Sun in the LICENSE file that accompanied this code.
15.62/5.15 *
15.62/5.15 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.15 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.15 * accompanied this code).
15.62/5.15 *
15.62/5.15 * You should have received a copy of the GNU General Public License version
15.62/5.15 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.15 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.15 *
15.62/5.15 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.15 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.15 * have any questions.
15.62/5.15 */
15.62/5.15
15.62/5.15 package javaUtilEx;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * This exception may be thrown by methods that have detected concurrent
15.62/5.15 * modification of an object when such modification is not permissible.
15.62/5.15 *
15.62/5.15 * For example, it is not generally permissible for one thread to modify a Collection
15.62/5.15 * while another thread is iterating over it. In general, the results of the
15.62/5.15 * iteration are undefined under these circumstances. Some Iterator
15.62/5.15 * implementations (including those of all the general purpose collection implementations
15.62/5.15 * provided by the JRE) may choose to throw this exception if this behavior is
15.62/5.15 * detected. Iterators that do this are known as fail-fast iterators,
15.62/5.15 * as they fail quickly and cleanly, rather that risking arbitrary,
15.62/5.15 * non-deterministic behavior at an undetermined time in the future.
15.62/5.15 *
15.62/5.15 * Note that this exception does not always indicate that an object has
15.62/5.15 * been concurrently modified by a different thread. If a single
15.62/5.15 * thread issues a sequence of method invocations that violates the
15.62/5.15 * contract of an object, the object may throw this exception. For
15.62/5.15 * example, if a thread modifies a collection directly while it is
15.62/5.15 * iterating over the collection with a fail-fast iterator, the iterator
15.62/5.15 * will throw this exception.
15.62/5.15 *
15.62/5.15 *
Note that fail-fast behavior cannot be guaranteed as it is, generally
15.62/5.15 * speaking, impossible to make any hard guarantees in the presence of
15.62/5.15 * unsynchronized concurrent modification. Fail-fast operations
15.62/5.15 * throw ConcurrentModificationException on a best-effort basis.
15.62/5.15 * Therefore, it would be wrong to write a program that depended on this
15.62/5.15 * exception for its correctness: ConcurrentModificationException
15.62/5.15 * should be used only to detect bugs.
15.62/5.15 *
15.62/5.15 * @author Josh Bloch
15.62/5.15 * @see Collection
15.62/5.15 * @see Iterator
15.62/5.15 * @see ListIterator
15.62/5.15 * @see Vector
15.62/5.15 * @see LinkedList
15.62/5.15 * @see HashSet
15.62/5.15 * @see Hashtable
15.62/5.15 * @see TreeMap
15.62/5.15 * @see AbstractList
15.62/5.15 * @since 1.2
15.62/5.15 */
15.62/5.15 public class ConcurrentModificationException extends RuntimeException {
15.62/5.15 /**
15.62/5.15 * Constructs a ConcurrentModificationException with no
15.62/5.15 * detail message.
15.62/5.15 */
15.62/5.15 public ConcurrentModificationException() {
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Constructs a ConcurrentModificationException with the
15.62/5.15 * specified detail message.
15.62/5.15 *
15.62/5.15 * @param message the detail message pertaining to this exception.
15.62/5.15 */
15.62/5.15 public ConcurrentModificationException(String message) {
15.62/5.15 super(message);
15.62/5.15 }
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 /*
15.62/5.15 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.15 *
15.62/5.15 * This code is free software; you can redistribute it and/or modify it
15.62/5.15 * under the terms of the GNU General Public License version 2 only, as
15.62/5.15 * published by the Free Software Foundation. Sun designates this
15.62/5.15 * particular file as subject to the "Classpath" exception as provided
15.62/5.15 * by Sun in the LICENSE file that accompanied this code.
15.62/5.15 *
15.62/5.15 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.15 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.15 * accompanied this code).
15.62/5.15 *
15.62/5.15 * You should have received a copy of the GNU General Public License version
15.62/5.15 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.15 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.15 *
15.62/5.15 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.15 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.15 * have any questions.
15.62/5.15 */
15.62/5.15
15.62/5.15 /*
15.62/5.15 * This file is available under and governed by the GNU General Public
15.62/5.15 * License version 2 only, as published by the Free Software Foundation.
15.62/5.15 * However, the following notice accompanied the original version of this
15.62/5.15 * file:
15.62/5.15 *
15.62/5.15 * Written by Doug Lea and Josh Bloch with assistance from members of
15.62/5.15 * JCP JSR-166 Expert Group and released to the public domain, as explained
15.62/5.15 * at http://creativecommons.org/licenses/publicdomain
15.62/5.15 */
15.62/5.15
15.62/5.15 package javaUtilEx;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * A linear collection that supports element insertion and removal at
15.62/5.15 * both ends. The name deque is short for "double ended queue"
15.62/5.15 * and is usually pronounced "deck". Most Deque
15.62/5.15 * implementations place no fixed limits on the number of elements
15.62/5.15 * they may contain, but this interface supports capacity-restricted
15.62/5.15 * deques as well as those with no fixed size limit.
15.62/5.15 *
15.62/5.15 *
This interface defines methods to access the elements at both
15.62/5.15 * ends of the deque. Methods are provided to insert, remove, and
15.62/5.15 * examine the element. Each of these methods exists in two forms:
15.62/5.15 * one throws an exception if the operation fails, the other returns a
15.62/5.15 * special value (either null or false, depending on
15.62/5.15 * the operation). The latter form of the insert operation is
15.62/5.15 * designed specifically for use with capacity-restricted
15.62/5.15 * Deque implementations; in most implementations, insert
15.62/5.15 * operations cannot fail.
15.62/5.15 *
15.62/5.15 *
The twelve methods described above are summarized in the
15.62/5.15 * following table:
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * |
15.62/5.15 * First Element (Head) |
15.62/5.15 * Last Element (Tail) |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * |
15.62/5.15 * Throws exception |
15.62/5.15 * Special value |
15.62/5.15 * Throws exception |
15.62/5.15 * Special value |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | Insert |
15.62/5.15 * {@link #addFirst addFirst(e)} |
15.62/5.15 * {@link #offerFirst offerFirst(e)} |
15.62/5.15 * {@link #addLast addLast(e)} |
15.62/5.15 * {@link #offerLast offerLast(e)} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | Remove |
15.62/5.15 * {@link #removeFirst removeFirst()} |
15.62/5.15 * {@link #pollFirst pollFirst()} |
15.62/5.15 * {@link #removeLast removeLast()} |
15.62/5.15 * {@link #pollLast pollLast()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | Examine |
15.62/5.15 * {@link #getFirst getFirst()} |
15.62/5.15 * {@link #peekFirst peekFirst()} |
15.62/5.15 * {@link #getLast getLast()} |
15.62/5.15 * {@link #peekLast peekLast()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * This interface extends the {@link Queue} interface. When a deque is
15.62/5.15 * used as a queue, FIFO (First-In-First-Out) behavior results. Elements are
15.62/5.15 * added at the end of the deque and removed from the beginning. The methods
15.62/5.15 * inherited from the Queue interface are precisely equivalent to
15.62/5.15 * Deque methods as indicated in the following table:
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | Queue Method |
15.62/5.15 * Equivalent Deque Method |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link java.util.Queue#add add(e)} |
15.62/5.15 * {@link #addLast addLast(e)} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link java.util.Queue#offer offer(e)} |
15.62/5.15 * {@link #offerLast offerLast(e)} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link java.util.Queue#remove remove()} |
15.62/5.15 * {@link #removeFirst removeFirst()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link java.util.Queue#poll poll()} |
15.62/5.15 * {@link #pollFirst pollFirst()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link java.util.Queue#element element()} |
15.62/5.15 * {@link #getFirst getFirst()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link java.util.Queue#peek peek()} |
15.62/5.15 * {@link #peek peekFirst()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * Deques can also be used as LIFO (Last-In-First-Out) stacks. This
15.62/5.15 * interface should be used in preference to the legacy {@link Stack} class.
15.62/5.15 * When a deque is used as a stack, elements are pushed and popped from the
15.62/5.15 * beginning of the deque. Stack methods are precisely equivalent to
15.62/5.15 * Deque methods as indicated in the table below:
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | Stack Method |
15.62/5.15 * Equivalent Deque Method |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link #push push(e)} |
15.62/5.15 * {@link #addFirst addFirst(e)} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link #pop pop()} |
15.62/5.15 * {@link #removeFirst removeFirst()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * | {@link #peek peek()} |
15.62/5.15 * {@link #peekFirst peekFirst()} |
15.62/5.15 *
15.62/5.15 *
15.62/5.15 *
15.62/5.15 * Note that the {@link #peek peek} method works equally well when
15.62/5.15 * a deque is used as a queue or a stack; in either case, elements are
15.62/5.15 * drawn from the beginning of the deque.
15.62/5.15 *
15.62/5.15 *
This interface provides two methods to remove interior
15.62/5.15 * elements, {@link #removeFirstOccurrence removeFirstOccurrence} and
15.62/5.15 * {@link #removeLastOccurrence removeLastOccurrence}.
15.62/5.15 *
15.62/5.15 *
Unlike the {@link List} interface, this interface does not
15.62/5.15 * provide support for indexed access to elements.
15.62/5.15 *
15.62/5.15 *
While Deque implementations are not strictly required
15.62/5.15 * to prohibit the insertion of null elements, they are strongly
15.62/5.15 * encouraged to do so. Users of any Deque implementations
15.62/5.15 * that do allow null elements are strongly encouraged not to
15.62/5.15 * take advantage of the ability to insert nulls. This is so because
15.62/5.15 * null is used as a special return value by various methods
15.62/5.15 * to indicated that the deque is empty.
15.62/5.15 *
15.62/5.15 *
Deque implementations generally do not define
15.62/5.15 * element-based versions of the equals and hashCode
15.62/5.15 * methods, but instead inherit the identity-based versions from class
15.62/5.15 * Object.
15.62/5.15 *
15.62/5.15 *
This interface is a member of the Java Collections
15.62/5.15 * Framework.
15.62/5.15 *
15.62/5.15 * @author Doug Lea
15.62/5.15 * @author Josh Bloch
15.62/5.15 * @since 1.6
15.62/5.15 * @param the type of elements held in this collection
15.62/5.15 */
15.62/5.15
15.62/5.15 public interface Deque extends Queue {
15.62/5.15 /**
15.62/5.15 * Inserts the specified element at the front of this deque if it is
15.62/5.15 * possible to do so immediately without violating capacity restrictions.
15.62/5.15 * When using a capacity-restricted deque, it is generally preferable to
15.62/5.15 * use method {@link #offerFirst}.
15.62/5.15 *
15.62/5.15 * @param e the element to add
15.62/5.15 * @throws IllegalStateException if the element cannot be added at this
15.62/5.15 * time due to capacity restrictions
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 void addFirst(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts the specified element at the end of this deque if it is
15.62/5.15 * possible to do so immediately without violating capacity restrictions.
15.62/5.15 * When using a capacity-restricted deque, it is generally preferable to
15.62/5.15 * use method {@link #offerLast}.
15.62/5.15 *
15.62/5.15 * This method is equivalent to {@link #add}.
15.62/5.15 *
15.62/5.15 * @param e the element to add
15.62/5.15 * @throws IllegalStateException if the element cannot be added at this
15.62/5.15 * time due to capacity restrictions
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 void addLast(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts the specified element at the front of this deque unless it would
15.62/5.15 * violate capacity restrictions. When using a capacity-restricted deque,
15.62/5.15 * this method is generally preferable to the {@link #addFirst} method,
15.62/5.15 * which can fail to insert an element only by throwing an exception.
15.62/5.15 *
15.62/5.15 * @param e the element to add
15.62/5.15 * @return true if the element was added to this deque, else
15.62/5.15 * false
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 boolean offerFirst(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts the specified element at the end of this deque unless it would
15.62/5.15 * violate capacity restrictions. When using a capacity-restricted deque,
15.62/5.15 * this method is generally preferable to the {@link #addLast} method,
15.62/5.15 * which can fail to insert an element only by throwing an exception.
15.62/5.15 *
15.62/5.15 * @param e the element to add
15.62/5.15 * @return true if the element was added to this deque, else
15.62/5.15 * false
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 boolean offerLast(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves and removes the first element of this deque. This method
15.62/5.15 * differs from {@link #pollFirst pollFirst} only in that it throws an
15.62/5.15 * exception if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the head of this deque
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E removeFirst();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves and removes the last element of this deque. This method
15.62/5.15 * differs from {@link #pollLast pollLast} only in that it throws an
15.62/5.15 * exception if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the tail of this deque
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E removeLast();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves and removes the first element of this deque,
15.62/5.15 * or returns null if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the head of this deque, or null if this deque is empty
15.62/5.15 */
15.62/5.15 E pollFirst();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves and removes the last element of this deque,
15.62/5.15 * or returns null if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the tail of this deque, or null if this deque is empty
15.62/5.15 */
15.62/5.15 E pollLast();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves, but does not remove, the first element of this deque.
15.62/5.15 *
15.62/5.15 * This method differs from {@link #peekFirst peekFirst} only in that it
15.62/5.15 * throws an exception if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the head of this deque
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E getFirst();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves, but does not remove, the last element of this deque.
15.62/5.15 * This method differs from {@link #peekLast peekLast} only in that it
15.62/5.15 * throws an exception if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the tail of this deque
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E getLast();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves, but does not remove, the first element of this deque,
15.62/5.15 * or returns null if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the head of this deque, or null if this deque is empty
15.62/5.15 */
15.62/5.15 E peekFirst();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves, but does not remove, the last element of this deque,
15.62/5.15 * or returns null if this deque is empty.
15.62/5.15 *
15.62/5.15 * @return the tail of this deque, or null if this deque is empty
15.62/5.15 */
15.62/5.15 E peekLast();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes the first occurrence of the specified element from this deque.
15.62/5.15 * If the deque does not contain the element, it is unchanged.
15.62/5.15 * More formally, removes the first element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e))
15.62/5.15 * (if such an element exists).
15.62/5.15 * Returns true if this deque contained the specified element
15.62/5.15 * (or equivalently, if this deque changed as a result of the call).
15.62/5.15 *
15.62/5.15 * @param o element to be removed from this deque, if present
15.62/5.15 * @return true if an element was removed as a result of this call
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * is incompatible with this deque (optional)
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements (optional)
15.62/5.15 */
15.62/5.15 boolean removeFirstOccurrence(Object o);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes the last occurrence of the specified element from this deque.
15.62/5.15 * If the deque does not contain the element, it is unchanged.
15.62/5.15 * More formally, removes the last element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e))
15.62/5.15 * (if such an element exists).
15.62/5.15 * Returns true if this deque contained the specified element
15.62/5.15 * (or equivalently, if this deque changed as a result of the call).
15.62/5.15 *
15.62/5.15 * @param o element to be removed from this deque, if present
15.62/5.15 * @return true if an element was removed as a result of this call
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * is incompatible with this deque (optional)
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements (optional)
15.62/5.15 */
15.62/5.15 boolean removeLastOccurrence(Object o);
15.62/5.15
15.62/5.15 // *** Queue methods ***
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts the specified element into the queue represented by this deque
15.62/5.15 * (in other words, at the tail of this deque) if it is possible to do so
15.62/5.15 * immediately without violating capacity restrictions, returning
15.62/5.15 * true upon success and throwing an
15.62/5.15 * IllegalStateException if no space is currently available.
15.62/5.15 * When using a capacity-restricted deque, it is generally preferable to
15.62/5.15 * use {@link #offer(Object) offer}.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #addLast}.
15.62/5.15 *
15.62/5.15 * @param e the element to add
15.62/5.15 * @return true (as specified by {@link Collection#add})
15.62/5.15 * @throws IllegalStateException if the element cannot be added at this
15.62/5.15 * time due to capacity restrictions
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 boolean add(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Inserts the specified element into the queue represented by this deque
15.62/5.15 * (in other words, at the tail of this deque) if it is possible to do so
15.62/5.15 * immediately without violating capacity restrictions, returning
15.62/5.15 * true upon success and false if no space is currently
15.62/5.15 * available. When using a capacity-restricted deque, this method is
15.62/5.15 * generally preferable to the {@link #add} method, which can fail to
15.62/5.15 * insert an element only by throwing an exception.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #offerLast}.
15.62/5.15 *
15.62/5.15 * @param e the element to add
15.62/5.15 * @return true if the element was added to this deque, else
15.62/5.15 * false
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 boolean offer(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves and removes the head of the queue represented by this deque
15.62/5.15 * (in other words, the first element of this deque).
15.62/5.15 * This method differs from {@link #poll poll} only in that it throws an
15.62/5.15 * exception if this deque is empty.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #removeFirst()}.
15.62/5.15 *
15.62/5.15 * @return the head of the queue represented by this deque
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E remove();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves and removes the head of the queue represented by this deque
15.62/5.15 * (in other words, the first element of this deque), or returns
15.62/5.15 * null if this deque is empty.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #pollFirst()}.
15.62/5.15 *
15.62/5.15 * @return the first element of this deque, or null if
15.62/5.15 * this deque is empty
15.62/5.15 */
15.62/5.15 E poll();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves, but does not remove, the head of the queue represented by
15.62/5.15 * this deque (in other words, the first element of this deque).
15.62/5.15 * This method differs from {@link #peek peek} only in that it throws an
15.62/5.15 * exception if this deque is empty.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #getFirst()}.
15.62/5.15 *
15.62/5.15 * @return the head of the queue represented by this deque
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E element();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Retrieves, but does not remove, the head of the queue represented by
15.62/5.15 * this deque (in other words, the first element of this deque), or
15.62/5.15 * returns null if this deque is empty.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #peekFirst()}.
15.62/5.15 *
15.62/5.15 * @return the head of the queue represented by this deque, or
15.62/5.15 * null if this deque is empty
15.62/5.15 */
15.62/5.15 E peek();
15.62/5.15
15.62/5.15
15.62/5.15 // *** Stack methods ***
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Pushes an element onto the stack represented by this deque (in other
15.62/5.15 * words, at the head of this deque) if it is possible to do so
15.62/5.15 * immediately without violating capacity restrictions, returning
15.62/5.15 * true upon success and throwing an
15.62/5.15 * IllegalStateException if no space is currently available.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #addFirst}.
15.62/5.15 *
15.62/5.15 * @param e the element to push
15.62/5.15 * @throws IllegalStateException if the element cannot be added at this
15.62/5.15 * time due to capacity restrictions
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * prevents it from being added to this deque
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements
15.62/5.15 * @throws IllegalArgumentException if some property of the specified
15.62/5.15 * element prevents it from being added to this deque
15.62/5.15 */
15.62/5.15 void push(E e);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Pops an element from the stack represented by this deque. In other
15.62/5.15 * words, removes and returns the first element of this deque.
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #removeFirst()}.
15.62/5.15 *
15.62/5.15 * @return the element at the front of this deque (which is the top
15.62/5.15 * of the stack represented by this deque)
15.62/5.15 * @throws NoSuchElementException if this deque is empty
15.62/5.15 */
15.62/5.15 E pop();
15.62/5.15
15.62/5.15
15.62/5.15 // *** Collection methods ***
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Removes the first occurrence of the specified element from this deque.
15.62/5.15 * If the deque does not contain the element, it is unchanged.
15.62/5.15 * More formally, removes the first element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e))
15.62/5.15 * (if such an element exists).
15.62/5.15 * Returns true if this deque contained the specified element
15.62/5.15 * (or equivalently, if this deque changed as a result of the call).
15.62/5.15 *
15.62/5.15 *
This method is equivalent to {@link #removeFirstOccurrence}.
15.62/5.15 *
15.62/5.15 * @param o element to be removed from this deque, if present
15.62/5.15 * @return true if an element was removed as a result of this call
15.62/5.15 * @throws ClassCastException if the class of the specified element
15.62/5.15 * is incompatible with this deque (optional)
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements (optional)
15.62/5.15 */
15.62/5.15 boolean remove(Object o);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns true if this deque contains the specified element.
15.62/5.15 * More formally, returns true if and only if this deque contains
15.62/5.15 * at least one element e such that
15.62/5.15 * (o==null ? e==null : o.equals(e)).
15.62/5.15 *
15.62/5.15 * @param o element whose presence in this deque is to be tested
15.62/5.15 * @return true if this deque contains the specified element
15.62/5.15 * @throws ClassCastException if the type of the specified element
15.62/5.15 * is incompatible with this deque (optional)
15.62/5.15 * @throws NullPointerException if the specified element is null and this
15.62/5.15 * deque does not permit null elements (optional)
15.62/5.15 */
15.62/5.15 boolean contains(Object o);
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns the number of elements in this deque.
15.62/5.15 *
15.62/5.15 * @return the number of elements in this deque
15.62/5.15 */
15.62/5.15 public int size();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns an iterator over the elements in this deque in proper sequence.
15.62/5.15 * The elements will be returned in order from first (head) to last (tail).
15.62/5.15 *
15.62/5.15 * @return an iterator over the elements in this deque in proper sequence
15.62/5.15 */
15.62/5.15 Iterator iterator();
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Returns an iterator over the elements in this deque in reverse
15.62/5.15 * sequential order. The elements will be returned in order from
15.62/5.15 * last (tail) to first (head).
15.62/5.15 *
15.62/5.15 * @return an iterator over the elements in this deque in reverse
15.62/5.15 * sequence
15.62/5.15 */
15.62/5.15 Iterator descendingIterator();
15.62/5.15
15.62/5.15 }
15.62/5.15
15.62/5.15
15.62/5.15 /*
15.62/5.15 * Copyright 1994-2003 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.15 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.15 *
15.62/5.15 * This code is free software; you can redistribute it and/or modify it
15.62/5.15 * under the terms of the GNU General Public License version 2 only, as
15.62/5.15 * published by the Free Software Foundation. Sun designates this
15.62/5.15 * particular file as subject to the "Classpath" exception as provided
15.62/5.15 * by Sun in the LICENSE file that accompanied this code.
15.62/5.15 *
15.62/5.15 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.15 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.15 * accompanied this code).
15.62/5.15 *
15.62/5.15 * You should have received a copy of the GNU General Public License version
15.62/5.15 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.15 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.15 *
15.62/5.15 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.15 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.15 * have any questions.
15.62/5.15 */
15.62/5.15
15.62/5.15 package javaUtilEx;
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Thrown to indicate that a method has been passed an illegal or
15.62/5.15 * inappropriate argument.
15.62/5.15 *
15.62/5.15 * @author unascribed
15.62/5.15 * @see java.lang.Thread#setPriority(int)
15.62/5.15 * @since JDK1.0
15.62/5.15 */
15.62/5.15 public
15.62/5.15 class IllegalArgumentException extends RuntimeException {
15.62/5.15 /**
15.62/5.15 * Constructs an IllegalArgumentException with no
15.62/5.15 * detail message.
15.62/5.15 */
15.62/5.15 public IllegalArgumentException() {
15.62/5.15 super();
15.62/5.15 }
15.62/5.15
15.62/5.15 /**
15.62/5.15 * Constructs an IllegalArgumentException with the
15.62/5.15 * specified detail message.
15.62/5.15 *
15.62/5.15 * @param s the detail message.
15.62/5.15 */
15.62/5.15 public IllegalArgumentException(String s) {
15.62/5.16 super(s);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs a new exception with the specified detail message and
15.62/5.16 * cause.
15.62/5.16 *
15.62/5.16 * Note that the detail message associated with cause is
15.62/5.16 * not automatically incorporated in this exception's detail
15.62/5.16 * message.
15.62/5.16 *
15.62/5.16 * @param message the detail message (which is saved for later retrieval
15.62/5.16 * by the {@link Throwable#getMessage()} method).
15.62/5.16 * @param cause the cause (which is saved for later retrieval by the
15.62/5.16 * {@link Throwable#getCause()} method). (A null value
15.62/5.16 * is permitted, and indicates that the cause is nonexistent or
15.62/5.16 * unknown.)
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public IllegalArgumentException(String message, Throwable cause) {
15.62/5.16 super(message, cause);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs a new exception with the specified cause and a detail
15.62/5.16 * message of (cause==null ? null : cause.toString()) (which
15.62/5.16 * typically contains the class and detail message of cause).
15.62/5.16 * This constructor is useful for exceptions that are little more than
15.62/5.16 * wrappers for other throwables (for example, {@link
15.62/5.16 * java.security.PrivilegedActionException}).
15.62/5.16 *
15.62/5.16 * @param cause the cause (which is saved for later retrieval by the
15.62/5.16 * {@link Throwable#getCause()} method). (A null value is
15.62/5.16 * permitted, and indicates that the cause is nonexistent or
15.62/5.16 * unknown.)
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public IllegalArgumentException(Throwable cause) {
15.62/5.16 super(cause);
15.62/5.16 }
15.62/5.16
15.62/5.16 private static final long serialVersionUID = -5365630128856068164L;
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Signals that a method has been invoked at an illegal or
15.62/5.16 * inappropriate time. In other words, the Java environment or
15.62/5.16 * Java application is not in an appropriate state for the requested
15.62/5.16 * operation.
15.62/5.16 *
15.62/5.16 * @author Jonni Kanerva
15.62/5.16 * @since JDK1.1
15.62/5.16 */
15.62/5.16 public
15.62/5.16 class IllegalStateException extends RuntimeException {
15.62/5.16 /**
15.62/5.16 * Constructs an IllegalStateException with no detail message.
15.62/5.16 * A detail message is a String that describes this particular exception.
15.62/5.16 */
15.62/5.16 public IllegalStateException() {
15.62/5.16 super();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs an IllegalStateException with the specified detail
15.62/5.16 * message. A detail message is a String that describes this particular
15.62/5.16 * exception.
15.62/5.16 *
15.62/5.16 * @param s the String that contains a detailed message
15.62/5.16 */
15.62/5.16 public IllegalStateException(String s) {
15.62/5.16 super(s);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs a new exception with the specified detail message and
15.62/5.16 * cause.
15.62/5.16 *
15.62/5.16 *
Note that the detail message associated with cause is
15.62/5.16 * not automatically incorporated in this exception's detail
15.62/5.16 * message.
15.62/5.16 *
15.62/5.16 * @param message the detail message (which is saved for later retrieval
15.62/5.16 * by the {@link Throwable#getMessage()} method).
15.62/5.16 * @param cause the cause (which is saved for later retrieval by the
15.62/5.16 * {@link Throwable#getCause()} method). (A null value
15.62/5.16 * is permitted, and indicates that the cause is nonexistent or
15.62/5.16 * unknown.)
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public IllegalStateException(String message, Throwable cause) {
15.62/5.16 super(message, cause);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs a new exception with the specified cause and a detail
15.62/5.16 * message of (cause==null ? null : cause.toString()) (which
15.62/5.16 * typically contains the class and detail message of cause).
15.62/5.16 * This constructor is useful for exceptions that are little more than
15.62/5.16 * wrappers for other throwables (for example, {@link
15.62/5.16 * java.security.PrivilegedActionException}).
15.62/5.16 *
15.62/5.16 * @param cause the cause (which is saved for later retrieval by the
15.62/5.16 * {@link Throwable#getCause()} method). (A null value is
15.62/5.16 * permitted, and indicates that the cause is nonexistent or
15.62/5.16 * unknown.)
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public IllegalStateException(Throwable cause) {
15.62/5.16 super(cause);
15.62/5.16 }
15.62/5.16
15.62/5.16 static final long serialVersionUID = -1848914673093119416L;
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * An iterator over a collection. {@code Iterator} takes the place of
15.62/5.16 * {@link Enumeration} in the Java Collections Framework. Iterators
15.62/5.16 * differ from enumerations in two ways:
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * - Iterators allow the caller to remove elements from the
15.62/5.16 * underlying collection during the iteration with well-defined
15.62/5.16 * semantics.
15.62/5.16 *
- Method names have been improved.
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * This interface is a member of the
15.62/5.16 *
15.62/5.16 * Java Collections Framework.
15.62/5.16 *
15.62/5.16 * @author Josh Bloch
15.62/5.16 * @see Collection
15.62/5.16 * @see ListIterator
15.62/5.16 * @see Iterable
15.62/5.16 * @since 1.2
15.62/5.16 */
15.62/5.16 public interface Iterator {
15.62/5.16 /**
15.62/5.16 * Returns {@code true} if the iteration has more elements.
15.62/5.16 * (In other words, returns {@code true} if {@link #next} would
15.62/5.16 * return an element rather than throwing an exception.)
15.62/5.16 *
15.62/5.16 * @return {@code true} if the iteration has more elements
15.62/5.16 */
15.62/5.16 boolean hasNext();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the next element in the iteration.
15.62/5.16 *
15.62/5.16 * @return the next element in the iteration
15.62/5.16 * @throws NoSuchElementException if the iteration has no more elements
15.62/5.16 */
15.62/5.16 E next();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes from the underlying collection the last element returned
15.62/5.16 * by this iterator (optional operation). This method can be called
15.62/5.16 * only once per call to {@link #next}. The behavior of an iterator
15.62/5.16 * is unspecified if the underlying collection is modified while the
15.62/5.16 * iteration is in progress in any way other than by calling this
15.62/5.16 * method.
15.62/5.16 *
15.62/5.16 * @throws UnsupportedOperationException if the {@code remove}
15.62/5.16 * operation is not supported by this iterator
15.62/5.16 *
15.62/5.16 * @throws IllegalStateException if the {@code next} method has not
15.62/5.16 * yet been called, or the {@code remove} method has already
15.62/5.16 * been called after the last call to the {@code next}
15.62/5.16 * method
15.62/5.16 */
15.62/5.16 void remove();
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 public class juLinkedListCreateRemoveFirst {
15.62/5.16 public static void main(String[] args) {
15.62/5.16 Random.args = args;
15.62/5.16
15.62/5.16 LinkedList l = createList(Random.random());
15.62/5.16 l.removeFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 public static LinkedList createList(int n) {
15.62/5.16 LinkedList l = new LinkedList();
15.62/5.16 while (n > 0) {
15.62/5.16 l.addLast(new Content(Random.random()));
15.62/5.16 n--;
15.62/5.16 }
15.62/5.16 return l;
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16 final class Content {
15.62/5.16 int val;
15.62/5.16
15.62/5.16 public Content(int v) {
15.62/5.16 this.val = v;
15.62/5.16 }
15.62/5.16
15.62/5.16 public int hashCode() {
15.62/5.16 return val^31;
15.62/5.16 }
15.62/5.16
15.62/5.16 public boolean equals(Object o) {
15.62/5.16 if (o instanceof Content) {
15.62/5.16 return this.val == ((Content) o).val;
15.62/5.16 }
15.62/5.16 return false;
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Linked list implementation of the List interface. Implements all
15.62/5.16 * optional list operations, and permits all elements (including
15.62/5.16 * null). In addition to implementing the List interface,
15.62/5.16 * the LinkedList class provides uniformly named methods to
15.62/5.16 * get, remove and insert an element at the
15.62/5.16 * beginning and end of the list. These operations allow linked lists to be
15.62/5.16 * used as a stack, {@linkplain Queue queue}, or {@linkplain Deque
15.62/5.16 * double-ended queue}.
15.62/5.16 *
15.62/5.16 * The class implements the Deque interface, providing
15.62/5.16 * first-in-first-out queue operations for add,
15.62/5.16 * poll, along with other stack and deque operations.
15.62/5.16 *
15.62/5.16 * All of the operations perform as could be expected for a doubly-linked
15.62/5.16 * list. Operations that index into the list will traverse the list from
15.62/5.16 * the beginning or the end, whichever is closer to the specified index.
15.62/5.16 *
15.62/5.16 *
Note that this implementation is not synchronized.
15.62/5.16 * If multiple threads access a linked list concurrently, and at least
15.62/5.16 * one of the threads modifies the list structurally, it must be
15.62/5.16 * synchronized externally. (A structural modification is any operation
15.62/5.16 * that adds or deletes one or more elements; merely setting the value of
15.62/5.16 * an element is not a structural modification.) This is typically
15.62/5.16 * accomplished by synchronizing on some object that naturally
15.62/5.16 * encapsulates the list.
15.62/5.16 *
15.62/5.16 * If no such object exists, the list should be "wrapped" using the
15.62/5.16 * {@link Collections#synchronizedList Collections.synchronizedList}
15.62/5.16 * method. This is best done at creation time, to prevent accidental
15.62/5.16 * unsynchronized access to the list:
15.62/5.16 * List list = Collections.synchronizedList(new LinkedList(...));
15.62/5.16 *
15.62/5.16 * The iterators returned by this class's iterator and
15.62/5.16 * listIterator methods are fail-fast: if the list is
15.62/5.16 * structurally modified at any time after the iterator is created, in
15.62/5.16 * any way except through the Iterator's own remove or
15.62/5.16 * add methods, the iterator will throw a {@link
15.62/5.16 * ConcurrentModificationException}. Thus, in the face of concurrent
15.62/5.16 * modification, the iterator fails quickly and cleanly, rather than
15.62/5.16 * risking arbitrary, non-deterministic behavior at an undetermined
15.62/5.16 * time in the future.
15.62/5.16 *
15.62/5.16 *
Note that the fail-fast behavior of an iterator cannot be guaranteed
15.62/5.16 * as it is, generally speaking, impossible to make any hard guarantees in the
15.62/5.16 * presence of unsynchronized concurrent modification. Fail-fast iterators
15.62/5.16 * throw ConcurrentModificationException on a best-effort basis.
15.62/5.16 * Therefore, it would be wrong to write a program that depended on this
15.62/5.16 * exception for its correctness: the fail-fast behavior of iterators
15.62/5.16 * should be used only to detect bugs.
15.62/5.16 *
15.62/5.16 *
This class is a member of the
15.62/5.16 *
15.62/5.16 * Java Collections Framework.
15.62/5.16 *
15.62/5.16 * @author Josh Bloch
15.62/5.16 * @see List
15.62/5.16 * @see ArrayList
15.62/5.16 * @see Vector
15.62/5.16 * @since 1.2
15.62/5.16 * @param the type of elements held in this collection
15.62/5.16 */
15.62/5.16
15.62/5.16 public class LinkedList
15.62/5.16 extends AbstractSequentialList
15.62/5.16 implements List, Deque
15.62/5.16 {
15.62/5.16 private transient Entry header = new Entry(null, null, null);
15.62/5.16 private transient int size = 0;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs an empty list.
15.62/5.16 */
15.62/5.16 public LinkedList() {
15.62/5.16 header.next = header.previous = header;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs a list containing the elements of the specified
15.62/5.16 * collection, in the order they are returned by the collection's
15.62/5.16 * iterator.
15.62/5.16 *
15.62/5.16 * @param c the collection whose elements are to be placed into this list
15.62/5.16 * @throws NullPointerException if the specified collection is null
15.62/5.16 */
15.62/5.16 public LinkedList(Collection c) {
15.62/5.16 this();
15.62/5.16 addAll(c);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the first element in this list.
15.62/5.16 *
15.62/5.16 * @return the first element in this list
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 */
15.62/5.16 public E getFirst() {
15.62/5.16 if (size==0)
15.62/5.16 throw new NoSuchElementException();
15.62/5.16
15.62/5.16 return header.next.element;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the last element in this list.
15.62/5.16 *
15.62/5.16 * @return the last element in this list
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 */
15.62/5.16 public E getLast() {
15.62/5.16 if (size==0)
15.62/5.16 throw new NoSuchElementException();
15.62/5.16
15.62/5.16 return header.previous.element;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes and returns the first element from this list.
15.62/5.16 *
15.62/5.16 * @return the first element from this list
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 */
15.62/5.16 public E removeFirst() {
15.62/5.16 return remove(header.next);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes and returns the last element from this list.
15.62/5.16 *
15.62/5.16 * @return the last element from this list
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 */
15.62/5.16 public E removeLast() {
15.62/5.16 return remove(header.previous);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Inserts the specified element at the beginning of this list.
15.62/5.16 *
15.62/5.16 * @param e the element to add
15.62/5.16 */
15.62/5.16 public void addFirst(E e) {
15.62/5.16 addBefore(e, header.next);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Appends the specified element to the end of this list.
15.62/5.16 *
15.62/5.16 * This method is equivalent to {@link #add}.
15.62/5.16 *
15.62/5.16 * @param e the element to add
15.62/5.16 */
15.62/5.16 public void addLast(E e) {
15.62/5.16 addBefore(e, header);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns true if this list contains the specified element.
15.62/5.16 * More formally, returns true if and only if this list contains
15.62/5.16 * at least one element e such that
15.62/5.16 * (o==null ? e==null : o.equals(e)).
15.62/5.16 *
15.62/5.16 * @param o element whose presence in this list is to be tested
15.62/5.16 * @return true if this list contains the specified element
15.62/5.16 */
15.62/5.16 public boolean contains(Object o) {
15.62/5.16 return indexOf(o) != -1;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the number of elements in this list.
15.62/5.16 *
15.62/5.16 * @return the number of elements in this list
15.62/5.16 */
15.62/5.16 public int size() {
15.62/5.16 return size;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Appends the specified element to the end of this list.
15.62/5.16 *
15.62/5.16 *
This method is equivalent to {@link #addLast}.
15.62/5.16 *
15.62/5.16 * @param e element to be appended to this list
15.62/5.16 * @return true (as specified by {@link Collection#add})
15.62/5.16 */
15.62/5.16 public boolean add(E e) {
15.62/5.16 addBefore(e, header);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes the first occurrence of the specified element from this list,
15.62/5.16 * if it is present. If this list does not contain the element, it is
15.62/5.16 * unchanged. More formally, removes the element with the lowest index
15.62/5.16 * i such that
15.62/5.16 * (o==null ? get(i)==null : o.equals(get(i)))
15.62/5.16 * (if such an element exists). Returns true if this list
15.62/5.16 * contained the specified element (or equivalently, if this list
15.62/5.16 * changed as a result of the call).
15.62/5.16 *
15.62/5.16 * @param o element to be removed from this list, if present
15.62/5.16 * @return true if this list contained the specified element
15.62/5.16 */
15.62/5.16 public boolean remove(Object o) {
15.62/5.16 if (o==null) {
15.62/5.16 for (Entry e = header.next; e != header; e = e.next) {
15.62/5.16 if (e.element==null) {
15.62/5.16 remove(e);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16 }
15.62/5.16 } else {
15.62/5.16 for (Entry e = header.next; e != header; e = e.next) {
15.62/5.16 if (o.equals(e.element)) {
15.62/5.16 remove(e);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16 }
15.62/5.16 }
15.62/5.16 return false;
15.62/5.16 }
15.62/5.16 /**
15.62/5.16 * Removes all of the elements from this list.
15.62/5.16 */
15.62/5.16 public void clear() {
15.62/5.16 Entry e = header.next;
15.62/5.16 while (e != header) {
15.62/5.16 Entry next = e.next;
15.62/5.16 e.next = e.previous = null;
15.62/5.16 e.element = null;
15.62/5.16 e = next;
15.62/5.16 }
15.62/5.16 header.next = header.previous = header;
15.62/5.16 size = 0;
15.62/5.16 modCount++;
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 // Positional Access Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the element at the specified position in this list.
15.62/5.16 *
15.62/5.16 * @param index index of the element to return
15.62/5.16 * @return the element at the specified position in this list
15.62/5.16 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.16 */
15.62/5.16 public E get(int index) {
15.62/5.16 return entry(index).element;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Replaces the element at the specified position in this list with the
15.62/5.16 * specified element.
15.62/5.16 *
15.62/5.16 * @param index index of the element to replace
15.62/5.16 * @param element element to be stored at the specified position
15.62/5.16 * @return the element previously at the specified position
15.62/5.16 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.16 */
15.62/5.16 public E set(int index, E element) {
15.62/5.16 Entry e = entry(index);
15.62/5.16 E oldVal = e.element;
15.62/5.16 e.element = element;
15.62/5.16 return oldVal;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Inserts the specified element at the specified position in this list.
15.62/5.16 * Shifts the element currently at that position (if any) and any
15.62/5.16 * subsequent elements to the right (adds one to their indices).
15.62/5.16 *
15.62/5.16 * @param index index at which the specified element is to be inserted
15.62/5.16 * @param element element to be inserted
15.62/5.16 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.16 */
15.62/5.16 public void add(int index, E element) {
15.62/5.16 addBefore(element, (index==size ? header : entry(index)));
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes the element at the specified position in this list. Shifts any
15.62/5.16 * subsequent elements to the left (subtracts one from their indices).
15.62/5.16 * Returns the element that was removed from the list.
15.62/5.16 *
15.62/5.16 * @param index the index of the element to be removed
15.62/5.16 * @return the element previously at the specified position
15.62/5.16 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.16 */
15.62/5.16 public E remove(int index) {
15.62/5.16 return remove(entry(index));
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the indexed entry.
15.62/5.16 */
15.62/5.16 private Entry entry(int index) {
15.62/5.16 if (index < 0 || index >= size)
15.62/5.16 throw new IndexOutOfBoundsException();
15.62/5.16 Entry e = header;
15.62/5.16 if (index < (size >> 1)) {
15.62/5.16 for (int i = 0; i <= index; i++)
15.62/5.16 e = e.next;
15.62/5.16 } else {
15.62/5.16 for (int i = size; i > index; i--)
15.62/5.16 e = e.previous;
15.62/5.16 }
15.62/5.16 return e;
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 // Search Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the index of the first occurrence of the specified element
15.62/5.16 * in this list, or -1 if this list does not contain the element.
15.62/5.16 * More formally, returns the lowest index i such that
15.62/5.16 * (o==null ? get(i)==null : o.equals(get(i))),
15.62/5.16 * or -1 if there is no such index.
15.62/5.16 *
15.62/5.16 * @param o element to search for
15.62/5.16 * @return the index of the first occurrence of the specified element in
15.62/5.16 * this list, or -1 if this list does not contain the element
15.62/5.16 */
15.62/5.16 public int indexOf(Object o) {
15.62/5.16 int index = 0;
15.62/5.16 if (o==null) {
15.62/5.16 for (Entry e = header.next; e != header; e = e.next) {
15.62/5.16 if (e.element==null)
15.62/5.16 return index;
15.62/5.16 index++;
15.62/5.16 }
15.62/5.16 } else {
15.62/5.16 for (Entry e = header.next; e != header; e = e.next) {
15.62/5.16 if (o.equals(e.element))
15.62/5.16 return index;
15.62/5.16 index++;
15.62/5.16 }
15.62/5.16 }
15.62/5.16 return -1;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the index of the last occurrence of the specified element
15.62/5.16 * in this list, or -1 if this list does not contain the element.
15.62/5.16 * More formally, returns the highest index i such that
15.62/5.16 * (o==null ? get(i)==null : o.equals(get(i))),
15.62/5.16 * or -1 if there is no such index.
15.62/5.16 *
15.62/5.16 * @param o element to search for
15.62/5.16 * @return the index of the last occurrence of the specified element in
15.62/5.16 * this list, or -1 if this list does not contain the element
15.62/5.16 */
15.62/5.16 public int lastIndexOf(Object o) {
15.62/5.16 int index = size;
15.62/5.16 if (o==null) {
15.62/5.16 for (Entry e = header.previous; e != header; e = e.previous) {
15.62/5.16 index--;
15.62/5.16 if (e.element==null)
15.62/5.16 return index;
15.62/5.16 }
15.62/5.16 } else {
15.62/5.16 for (Entry e = header.previous; e != header; e = e.previous) {
15.62/5.16 index--;
15.62/5.16 if (o.equals(e.element))
15.62/5.16 return index;
15.62/5.16 }
15.62/5.16 }
15.62/5.16 return -1;
15.62/5.16 }
15.62/5.16
15.62/5.16 // Queue operations.
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves, but does not remove, the head (first element) of this list.
15.62/5.16 * @return the head of this list, or null if this list is empty
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public E peek() {
15.62/5.16 if (size==0)
15.62/5.16 return null;
15.62/5.16 return getFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves, but does not remove, the head (first element) of this list.
15.62/5.16 * @return the head of this list
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public E element() {
15.62/5.16 return getFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves and removes the head (first element) of this list
15.62/5.16 * @return the head of this list, or null if this list is empty
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public E poll() {
15.62/5.16 if (size==0)
15.62/5.16 return null;
15.62/5.16 return removeFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves and removes the head (first element) of this list.
15.62/5.16 *
15.62/5.16 * @return the head of this list
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public E remove() {
15.62/5.16 return removeFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Adds the specified element as the tail (last element) of this list.
15.62/5.16 *
15.62/5.16 * @param e the element to add
15.62/5.16 * @return true (as specified by {@link Queue#offer})
15.62/5.16 * @since 1.5
15.62/5.16 */
15.62/5.16 public boolean offer(E e) {
15.62/5.16 return add(e);
15.62/5.16 }
15.62/5.16
15.62/5.16 // Deque operations
15.62/5.16 /**
15.62/5.16 * Inserts the specified element at the front of this list.
15.62/5.16 *
15.62/5.16 * @param e the element to insert
15.62/5.16 * @return true (as specified by {@link Deque#offerFirst})
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public boolean offerFirst(E e) {
15.62/5.16 addFirst(e);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Inserts the specified element at the end of this list.
15.62/5.16 *
15.62/5.16 * @param e the element to insert
15.62/5.16 * @return true (as specified by {@link Deque#offerLast})
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public boolean offerLast(E e) {
15.62/5.16 addLast(e);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves, but does not remove, the first element of this list,
15.62/5.16 * or returns null if this list is empty.
15.62/5.16 *
15.62/5.16 * @return the first element of this list, or null
15.62/5.16 * if this list is empty
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public E peekFirst() {
15.62/5.16 if (size==0)
15.62/5.16 return null;
15.62/5.16 return getFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves, but does not remove, the last element of this list,
15.62/5.16 * or returns null if this list is empty.
15.62/5.16 *
15.62/5.16 * @return the last element of this list, or null
15.62/5.16 * if this list is empty
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public E peekLast() {
15.62/5.16 if (size==0)
15.62/5.16 return null;
15.62/5.16 return getLast();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves and removes the first element of this list,
15.62/5.16 * or returns null if this list is empty.
15.62/5.16 *
15.62/5.16 * @return the first element of this list, or null if
15.62/5.16 * this list is empty
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public E pollFirst() {
15.62/5.16 if (size==0)
15.62/5.16 return null;
15.62/5.16 return removeFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retrieves and removes the last element of this list,
15.62/5.16 * or returns null if this list is empty.
15.62/5.16 *
15.62/5.16 * @return the last element of this list, or null if
15.62/5.16 * this list is empty
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public E pollLast() {
15.62/5.16 if (size==0)
15.62/5.16 return null;
15.62/5.16 return removeLast();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Pushes an element onto the stack represented by this list. In other
15.62/5.16 * words, inserts the element at the front of this list.
15.62/5.16 *
15.62/5.16 * This method is equivalent to {@link #addFirst}.
15.62/5.16 *
15.62/5.16 * @param e the element to push
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public void push(E e) {
15.62/5.16 addFirst(e);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Pops an element from the stack represented by this list. In other
15.62/5.16 * words, removes and returns the first element of this list.
15.62/5.16 *
15.62/5.16 *
This method is equivalent to {@link #removeFirst()}.
15.62/5.16 *
15.62/5.16 * @return the element at the front of this list (which is the top
15.62/5.16 * of the stack represented by this list)
15.62/5.16 * @throws NoSuchElementException if this list is empty
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public E pop() {
15.62/5.16 return removeFirst();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes the first occurrence of the specified element in this
15.62/5.16 * list (when traversing the list from head to tail). If the list
15.62/5.16 * does not contain the element, it is unchanged.
15.62/5.16 *
15.62/5.16 * @param o element to be removed from this list, if present
15.62/5.16 * @return true if the list contained the specified element
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public boolean removeFirstOccurrence(Object o) {
15.62/5.16 return remove(o);
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes the last occurrence of the specified element in this
15.62/5.16 * list (when traversing the list from head to tail). If the list
15.62/5.16 * does not contain the element, it is unchanged.
15.62/5.16 *
15.62/5.16 * @param o element to be removed from this list, if present
15.62/5.16 * @return true if the list contained the specified element
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public boolean removeLastOccurrence(Object o) {
15.62/5.16 if (o==null) {
15.62/5.16 for (Entry e = header.previous; e != header; e = e.previous) {
15.62/5.16 if (e.element==null) {
15.62/5.16 remove(e);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16 }
15.62/5.16 } else {
15.62/5.16 for (Entry e = header.previous; e != header; e = e.previous) {
15.62/5.16 if (o.equals(e.element)) {
15.62/5.16 remove(e);
15.62/5.16 return true;
15.62/5.16 }
15.62/5.16 }
15.62/5.16 }
15.62/5.16 return false;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns a list-iterator of the elements in this list (in proper
15.62/5.16 * sequence), starting at the specified position in the list.
15.62/5.16 * Obeys the general contract of List.listIterator(int).
15.62/5.16 *
15.62/5.16 * The list-iterator is fail-fast: if the list is structurally
15.62/5.16 * modified at any time after the Iterator is created, in any way except
15.62/5.16 * through the list-iterator's own remove or add
15.62/5.16 * methods, the list-iterator will throw a
15.62/5.16 * ConcurrentModificationException. Thus, in the face of
15.62/5.16 * concurrent modification, the iterator fails quickly and cleanly, rather
15.62/5.16 * than risking arbitrary, non-deterministic behavior at an undetermined
15.62/5.16 * time in the future.
15.62/5.16 *
15.62/5.16 * @param index index of the first element to be returned from the
15.62/5.16 * list-iterator (by a call to next)
15.62/5.16 * @return a ListIterator of the elements in this list (in proper
15.62/5.16 * sequence), starting at the specified position in the list
15.62/5.16 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.16 * @see List#listIterator(int)
15.62/5.16 */
15.62/5.16 public ListIterator listIterator(int index) {
15.62/5.16 return new ListItr(index);
15.62/5.16 }
15.62/5.16
15.62/5.16 private class ListItr implements ListIterator {
15.62/5.16 private Entry lastReturned = header;
15.62/5.16 private Entry next;
15.62/5.16 private int nextIndex;
15.62/5.16 private int expectedModCount = modCount;
15.62/5.16
15.62/5.16 ListItr(int index) {
15.62/5.16 if (index < 0 || index > size)
15.62/5.16 throw new IndexOutOfBoundsException();
15.62/5.16 if (index < (size >> 1)) {
15.62/5.16 next = header.next;
15.62/5.16 for (nextIndex=0; nextIndexindex; nextIndex--)
15.62/5.16 next = next.previous;
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16 public boolean hasNext() {
15.62/5.16 return nextIndex != size;
15.62/5.16 }
15.62/5.16
15.62/5.16 public E next() {
15.62/5.16 checkForComodification();
15.62/5.16 if (nextIndex == size)
15.62/5.16 throw new NoSuchElementException();
15.62/5.16
15.62/5.16 lastReturned = next;
15.62/5.16 next = next.next;
15.62/5.16 nextIndex++;
15.62/5.16 return lastReturned.element;
15.62/5.16 }
15.62/5.16
15.62/5.16 public boolean hasPrevious() {
15.62/5.16 return nextIndex != 0;
15.62/5.16 }
15.62/5.16
15.62/5.16 public E previous() {
15.62/5.16 if (nextIndex == 0)
15.62/5.16 throw new NoSuchElementException();
15.62/5.16
15.62/5.16 lastReturned = next = next.previous;
15.62/5.16 nextIndex--;
15.62/5.16 checkForComodification();
15.62/5.16 return lastReturned.element;
15.62/5.16 }
15.62/5.16
15.62/5.16 public int nextIndex() {
15.62/5.16 return nextIndex;
15.62/5.16 }
15.62/5.16
15.62/5.16 public int previousIndex() {
15.62/5.16 return nextIndex-1;
15.62/5.16 }
15.62/5.16
15.62/5.16 public void remove() {
15.62/5.16 checkForComodification();
15.62/5.16 Entry lastNext = lastReturned.next;
15.62/5.16 try {
15.62/5.16 LinkedList.this.remove(lastReturned);
15.62/5.16 } catch (NoSuchElementException e) {
15.62/5.16 throw new IllegalStateException();
15.62/5.16 }
15.62/5.16 if (next==lastReturned)
15.62/5.16 next = lastNext;
15.62/5.16 else
15.62/5.16 nextIndex--;
15.62/5.16 lastReturned = header;
15.62/5.16 expectedModCount++;
15.62/5.16 }
15.62/5.16
15.62/5.16 public void set(E e) {
15.62/5.16 if (lastReturned == header)
15.62/5.16 throw new IllegalStateException();
15.62/5.16 checkForComodification();
15.62/5.16 lastReturned.element = e;
15.62/5.16 }
15.62/5.16
15.62/5.16 public void add(E e) {
15.62/5.16 checkForComodification();
15.62/5.16 lastReturned = header;
15.62/5.16 addBefore(e, next);
15.62/5.16 nextIndex++;
15.62/5.16 expectedModCount++;
15.62/5.16 }
15.62/5.16
15.62/5.16 final void checkForComodification() {
15.62/5.16 if (modCount != expectedModCount)
15.62/5.16 throw new ConcurrentModificationException();
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16 private static class Entry {
15.62/5.16 E element;
15.62/5.16 Entry next;
15.62/5.16 Entry previous;
15.62/5.16
15.62/5.16 Entry(E element, Entry next, Entry previous) {
15.62/5.16 this.element = element;
15.62/5.16 this.next = next;
15.62/5.16 this.previous = previous;
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16 private Entry addBefore(E e, Entry entry) {
15.62/5.16 Entry newEntry = new Entry(e, entry, entry.previous);
15.62/5.16 newEntry.previous.next = newEntry;
15.62/5.16 newEntry.next.previous = newEntry;
15.62/5.16 size++;
15.62/5.16 modCount++;
15.62/5.16 return newEntry;
15.62/5.16 }
15.62/5.16
15.62/5.16 private E remove(Entry e) {
15.62/5.16 if (e == header)
15.62/5.16 throw new NoSuchElementException();
15.62/5.16
15.62/5.16 E result = e.element;
15.62/5.16 e.previous.next = e.next;
15.62/5.16 e.next.previous = e.previous;
15.62/5.16 e.next = e.previous = null;
15.62/5.16 e.element = null;
15.62/5.16 size--;
15.62/5.16 modCount++;
15.62/5.16 return result;
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * @since 1.6
15.62/5.16 */
15.62/5.16 public Iterator descendingIterator() {
15.62/5.16 return new DescendingIterator();
15.62/5.16 }
15.62/5.16
15.62/5.16 /** Adapter to provide descending iterators via ListItr.previous */
15.62/5.16 private class DescendingIterator implements Iterator {
15.62/5.16 final ListItr itr = new ListItr(size());
15.62/5.16 public boolean hasNext() {
15.62/5.16 return itr.hasPrevious();
15.62/5.16 }
15.62/5.16 public E next() {
15.62/5.16 return itr.previous();
15.62/5.16 }
15.62/5.16 public void remove() {
15.62/5.16 itr.remove();
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns an array containing all of the elements in this list
15.62/5.16 * in proper sequence (from first to last element).
15.62/5.16 *
15.62/5.16 * The returned array will be "safe" in that no references to it are
15.62/5.16 * maintained by this list. (In other words, this method must allocate
15.62/5.16 * a new array). The caller is thus free to modify the returned array.
15.62/5.16 *
15.62/5.16 *
This method acts as bridge between array-based and collection-based
15.62/5.16 * APIs.
15.62/5.16 *
15.62/5.16 * @return an array containing all of the elements in this list
15.62/5.16 * in proper sequence
15.62/5.16 */
15.62/5.16 public Object[] toArray() {
15.62/5.16 Object[] result = new Object[size];
15.62/5.16 int i = 0;
15.62/5.16 for (Entry e = header.next; e != header; e = e.next)
15.62/5.16 result[i++] = e.element;
15.62/5.16 return result;
15.62/5.16 }
15.62/5.16
15.62/5.16 private static final long serialVersionUID = 876323262645176354L;
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * An iterator for lists that allows the programmer
15.62/5.16 * to traverse the list in either direction, modify
15.62/5.16 * the list during iteration, and obtain the iterator's
15.62/5.16 * current position in the list. A {@code ListIterator}
15.62/5.16 * has no current element; its cursor position always
15.62/5.16 * lies between the element that would be returned by a call
15.62/5.16 * to {@code previous()} and the element that would be
15.62/5.16 * returned by a call to {@code next()}.
15.62/5.16 * An iterator for a list of length {@code n} has {@code n+1} possible
15.62/5.16 * cursor positions, as illustrated by the carets ({@code ^}) below:
15.62/5.16 *
15.62/5.16 * Element(0) Element(1) Element(2) ... Element(n-1)
15.62/5.16 * cursor positions: ^ ^ ^ ^ ^
15.62/5.16 *
15.62/5.16 * Note that the {@link #remove} and {@link #set(Object)} methods are
15.62/5.16 * not defined in terms of the cursor position; they are defined to
15.62/5.16 * operate on the last element returned by a call to {@link #next} or
15.62/5.16 * {@link #previous()}.
15.62/5.16 *
15.62/5.16 * This interface is a member of the
15.62/5.16 *
15.62/5.16 * Java Collections Framework.
15.62/5.16 *
15.62/5.16 * @author Josh Bloch
15.62/5.16 * @see Collection
15.62/5.16 * @see List
15.62/5.16 * @see Iterator
15.62/5.16 * @see Enumeration
15.62/5.16 * @see List#listIterator()
15.62/5.16 * @since 1.2
15.62/5.16 */
15.62/5.16 public interface ListIterator extends Iterator {
15.62/5.16 // Query Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns {@code true} if this list iterator has more elements when
15.62/5.16 * traversing the list in the forward direction. (In other words,
15.62/5.16 * returns {@code true} if {@link #next} would return an element rather
15.62/5.16 * than throwing an exception.)
15.62/5.16 *
15.62/5.16 * @return {@code true} if the list iterator has more elements when
15.62/5.16 * traversing the list in the forward direction
15.62/5.16 */
15.62/5.16 boolean hasNext();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the next element in the list and advances the cursor position.
15.62/5.16 * This method may be called repeatedly to iterate through the list,
15.62/5.16 * or intermixed with calls to {@link #previous} to go back and forth.
15.62/5.16 * (Note that alternating calls to {@code next} and {@code previous}
15.62/5.16 * will return the same element repeatedly.)
15.62/5.16 *
15.62/5.16 * @return the next element in the list
15.62/5.16 * @throws NoSuchElementException if the iteration has no next element
15.62/5.16 */
15.62/5.16 E next();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns {@code true} if this list iterator has more elements when
15.62/5.16 * traversing the list in the reverse direction. (In other words,
15.62/5.16 * returns {@code true} if {@link #previous} would return an element
15.62/5.16 * rather than throwing an exception.)
15.62/5.16 *
15.62/5.16 * @return {@code true} if the list iterator has more elements when
15.62/5.16 * traversing the list in the reverse direction
15.62/5.16 */
15.62/5.16 boolean hasPrevious();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the previous element in the list and moves the cursor
15.62/5.16 * position backwards. This method may be called repeatedly to
15.62/5.16 * iterate through the list backwards, or intermixed with calls to
15.62/5.16 * {@link #next} to go back and forth. (Note that alternating calls
15.62/5.16 * to {@code next} and {@code previous} will return the same
15.62/5.16 * element repeatedly.)
15.62/5.16 *
15.62/5.16 * @return the previous element in the list
15.62/5.16 * @throws NoSuchElementException if the iteration has no previous
15.62/5.16 * element
15.62/5.16 */
15.62/5.16 E previous();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the index of the element that would be returned by a
15.62/5.16 * subsequent call to {@link #next}. (Returns list size if the list
15.62/5.16 * iterator is at the end of the list.)
15.62/5.16 *
15.62/5.16 * @return the index of the element that would be returned by a
15.62/5.16 * subsequent call to {@code next}, or list size if the list
15.62/5.16 * iterator is at the end of the list
15.62/5.16 */
15.62/5.16 int nextIndex();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the index of the element that would be returned by a
15.62/5.16 * subsequent call to {@link #previous}. (Returns -1 if the list
15.62/5.16 * iterator is at the beginning of the list.)
15.62/5.16 *
15.62/5.16 * @return the index of the element that would be returned by a
15.62/5.16 * subsequent call to {@code previous}, or -1 if the list
15.62/5.16 * iterator is at the beginning of the list
15.62/5.16 */
15.62/5.16 int previousIndex();
15.62/5.16
15.62/5.16
15.62/5.16 // Modification Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes from the list the last element that was returned by {@link
15.62/5.16 * #next} or {@link #previous} (optional operation). This call can
15.62/5.16 * only be made once per call to {@code next} or {@code previous}.
15.62/5.16 * It can be made only if {@link #add} has not been
15.62/5.16 * called after the last call to {@code next} or {@code previous}.
15.62/5.16 *
15.62/5.16 * @throws UnsupportedOperationException if the {@code remove}
15.62/5.16 * operation is not supported by this list iterator
15.62/5.16 * @throws IllegalStateException if neither {@code next} nor
15.62/5.16 * {@code previous} have been called, or {@code remove} or
15.62/5.16 * {@code add} have been called after the last call to
15.62/5.16 * {@code next} or {@code previous}
15.62/5.16 */
15.62/5.16 void remove();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Replaces the last element returned by {@link #next} or
15.62/5.16 * {@link #previous} with the specified element (optional operation).
15.62/5.16 * This call can be made only if neither {@link #remove} nor {@link
15.62/5.16 * #add} have been called after the last call to {@code next} or
15.62/5.16 * {@code previous}.
15.62/5.16 *
15.62/5.16 * @param e the element with which to replace the last element returned by
15.62/5.16 * {@code next} or {@code previous}
15.62/5.16 * @throws UnsupportedOperationException if the {@code set} operation
15.62/5.16 * is not supported by this list iterator
15.62/5.16 * @throws ClassCastException if the class of the specified element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 * @throws IllegalArgumentException if some aspect of the specified
15.62/5.16 * element prevents it from being added to this list
15.62/5.16 * @throws IllegalStateException if neither {@code next} nor
15.62/5.16 * {@code previous} have been called, or {@code remove} or
15.62/5.16 * {@code add} have been called after the last call to
15.62/5.16 * {@code next} or {@code previous}
15.62/5.16 */
15.62/5.16 void set(E e);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Inserts the specified element into the list (optional operation).
15.62/5.16 * The element is inserted immediately before the next element that
15.62/5.16 * would be returned by {@link #next}, if any, and after the next
15.62/5.16 * element that would be returned by {@link #previous}, if any. (If the
15.62/5.16 * list contains no elements, the new element becomes the sole element
15.62/5.16 * on the list.) The new element is inserted before the implicit
15.62/5.16 * cursor: a subsequent call to {@code next} would be unaffected, and a
15.62/5.16 * subsequent call to {@code previous} would return the new element.
15.62/5.16 * (This call increases by one the value that would be returned by a
15.62/5.16 * call to {@code nextIndex} or {@code previousIndex}.)
15.62/5.16 *
15.62/5.16 * @param e the element to insert
15.62/5.16 * @throws UnsupportedOperationException if the {@code add} method is
15.62/5.16 * not supported by this list iterator
15.62/5.16 * @throws ClassCastException if the class of the specified element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 * @throws IllegalArgumentException if some aspect of this element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 */
15.62/5.16 void add(E e);
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * An ordered collection (also known as a sequence). The user of this
15.62/5.16 * interface has precise control over where in the list each element is
15.62/5.16 * inserted. The user can access elements by their integer index (position in
15.62/5.16 * the list), and search for elements in the list.
15.62/5.16 *
15.62/5.16 * Unlike sets, lists typically allow duplicate elements. More formally,
15.62/5.16 * lists typically allow pairs of elements e1 and e2
15.62/5.16 * such that e1.equals(e2), and they typically allow multiple
15.62/5.16 * null elements if they allow null elements at all. It is not inconceivable
15.62/5.16 * that someone might wish to implement a list that prohibits duplicates, by
15.62/5.16 * throwing runtime exceptions when the user attempts to insert them, but we
15.62/5.16 * expect this usage to be rare.
15.62/5.16 *
15.62/5.16 * The List interface places additional stipulations, beyond those
15.62/5.16 * specified in the Collection interface, on the contracts of the
15.62/5.16 * iterator, add, remove, equals, and
15.62/5.16 * hashCode methods. Declarations for other inherited methods are
15.62/5.16 * also included here for convenience.
15.62/5.16 *
15.62/5.16 * The List interface provides four methods for positional (indexed)
15.62/5.16 * access to list elements. Lists (like Java arrays) are zero based. Note
15.62/5.16 * that these operations may execute in time proportional to the index value
15.62/5.16 * for some implementations (the LinkedList class, for
15.62/5.16 * example). Thus, iterating over the elements in a list is typically
15.62/5.16 * preferable to indexing through it if the caller does not know the
15.62/5.16 * implementation.
15.62/5.16 *
15.62/5.16 * The List interface provides a special iterator, called a
15.62/5.16 * ListIterator, that allows element insertion and replacement, and
15.62/5.16 * bidirectional access in addition to the normal operations that the
15.62/5.16 * Iterator interface provides. A method is provided to obtain a
15.62/5.16 * list iterator that starts at a specified position in the list.
15.62/5.16 *
15.62/5.16 * The List interface provides two methods to search for a specified
15.62/5.16 * object. From a performance standpoint, these methods should be used with
15.62/5.16 * caution. In many implementations they will perform costly linear
15.62/5.16 * searches.
15.62/5.16 *
15.62/5.16 * The List interface provides two methods to efficiently insert and
15.62/5.16 * remove multiple elements at an arbitrary point in the list.
15.62/5.16 *
15.62/5.16 * Note: While it is permissible for lists to contain themselves as elements,
15.62/5.16 * extreme caution is advised: the equals and hashCode
15.62/5.16 * methods are no longer well defined on such a list.
15.62/5.16 *
15.62/5.16 *
Some list implementations have restrictions on the elements that
15.62/5.16 * they may contain. For example, some implementations prohibit null elements,
15.62/5.16 * and some have restrictions on the types of their elements. Attempting to
15.62/5.16 * add an ineligible element throws an unchecked exception, typically
15.62/5.16 * NullPointerException or ClassCastException. Attempting
15.62/5.16 * to query the presence of an ineligible element may throw an exception,
15.62/5.16 * or it may simply return false; some implementations will exhibit the former
15.62/5.16 * behavior and some will exhibit the latter. More generally, attempting an
15.62/5.16 * operation on an ineligible element whose completion would not result in
15.62/5.16 * the insertion of an ineligible element into the list may throw an
15.62/5.16 * exception or it may succeed, at the option of the implementation.
15.62/5.16 * Such exceptions are marked as "optional" in the specification for this
15.62/5.16 * interface.
15.62/5.16 *
15.62/5.16 *
This interface is a member of the
15.62/5.16 *
15.62/5.16 * Java Collections Framework.
15.62/5.16 *
15.62/5.16 * @author Josh Bloch
15.62/5.16 * @author Neal Gafter
15.62/5.16 * @see Collection
15.62/5.16 * @see Set
15.62/5.16 * @see ArrayList
15.62/5.16 * @see LinkedList
15.62/5.16 * @see Vector
15.62/5.16 * @see Arrays#asList(Object[])
15.62/5.16 * @see Collections#nCopies(int, Object)
15.62/5.16 * @see Collections#EMPTY_LIST
15.62/5.16 * @see AbstractList
15.62/5.16 * @see AbstractSequentialList
15.62/5.16 * @since 1.2
15.62/5.16 */
15.62/5.16
15.62/5.16 public interface List extends Collection {
15.62/5.16 // Query Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the number of elements in this list. If this list contains
15.62/5.16 * more than Integer.MAX_VALUE elements, returns
15.62/5.16 * Integer.MAX_VALUE.
15.62/5.16 *
15.62/5.16 * @return the number of elements in this list
15.62/5.16 */
15.62/5.16 int size();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns true if this list contains no elements.
15.62/5.16 *
15.62/5.16 * @return true if this list contains no elements
15.62/5.16 */
15.62/5.16 boolean isEmpty();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns true if this list contains the specified element.
15.62/5.16 * More formally, returns true if and only if this list contains
15.62/5.16 * at least one element e such that
15.62/5.16 * (o==null ? e==null : o.equals(e)).
15.62/5.16 *
15.62/5.16 * @param o element whose presence in this list is to be tested
15.62/5.16 * @return true if this list contains the specified element
15.62/5.16 * @throws ClassCastException if the type of the specified element
15.62/5.16 * is incompatible with this list (optional)
15.62/5.16 * @throws NullPointerException if the specified element is null and this
15.62/5.16 * list does not permit null elements (optional)
15.62/5.16 */
15.62/5.16 boolean contains(Object o);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns an iterator over the elements in this list in proper sequence.
15.62/5.16 *
15.62/5.16 * @return an iterator over the elements in this list in proper sequence
15.62/5.16 */
15.62/5.16 Iterator iterator();
15.62/5.16
15.62/5.16 // Modification Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Appends the specified element to the end of this list (optional
15.62/5.16 * operation).
15.62/5.16 *
15.62/5.16 * Lists that support this operation may place limitations on what
15.62/5.16 * elements may be added to this list. In particular, some
15.62/5.16 * lists will refuse to add null elements, and others will impose
15.62/5.16 * restrictions on the type of elements that may be added. List
15.62/5.16 * classes should clearly specify in their documentation any restrictions
15.62/5.16 * on what elements may be added.
15.62/5.16 *
15.62/5.16 * @param e element to be appended to this list
15.62/5.16 * @return true (as specified by {@link Collection#add})
15.62/5.16 * @throws UnsupportedOperationException if the add operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of the specified element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 * @throws NullPointerException if the specified element is null and this
15.62/5.16 * list does not permit null elements
15.62/5.16 * @throws IllegalArgumentException if some property of this element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 */
15.62/5.16 boolean add(E e);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes the first occurrence of the specified element from this list,
15.62/5.16 * if it is present (optional operation). If this list does not contain
15.62/5.16 * the element, it is unchanged. More formally, removes the element with
15.62/5.16 * the lowest index i such that
15.62/5.16 * (o==null ? get(i)==null : o.equals(get(i)))
15.62/5.16 * (if such an element exists). Returns true if this list
15.62/5.16 * contained the specified element (or equivalently, if this list changed
15.62/5.16 * as a result of the call).
15.62/5.16 *
15.62/5.16 * @param o element to be removed from this list, if present
15.62/5.16 * @return true if this list contained the specified element
15.62/5.16 * @throws ClassCastException if the type of the specified element
15.62/5.16 * is incompatible with this list (optional)
15.62/5.16 * @throws NullPointerException if the specified element is null and this
15.62/5.16 * list does not permit null elements (optional)
15.62/5.16 * @throws UnsupportedOperationException if the remove operation
15.62/5.16 * is not supported by this list
15.62/5.16 */
15.62/5.16 boolean remove(Object o);
15.62/5.16
15.62/5.16
15.62/5.16 // Bulk Modification Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns true if this list contains all of the elements of the
15.62/5.16 * specified collection.
15.62/5.16 *
15.62/5.16 * @param c collection to be checked for containment in this list
15.62/5.16 * @return true if this list contains all of the elements of the
15.62/5.16 * specified collection
15.62/5.16 * @throws ClassCastException if the types of one or more elements
15.62/5.16 * in the specified collection are incompatible with this
15.62/5.16 * list (optional)
15.62/5.16 * @throws NullPointerException if the specified collection contains one
15.62/5.16 * or more null elements and this list does not permit null
15.62/5.16 * elements (optional), or if the specified collection is null
15.62/5.16 * @see #contains(Object)
15.62/5.16 */
15.62/5.16 boolean containsAll(Collection c);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Appends all of the elements in the specified collection to the end of
15.62/5.16 * this list, in the order that they are returned by the specified
15.62/5.16 * collection's iterator (optional operation). The behavior of this
15.62/5.16 * operation is undefined if the specified collection is modified while
15.62/5.16 * the operation is in progress. (Note that this will occur if the
15.62/5.16 * specified collection is this list, and it's nonempty.)
15.62/5.16 *
15.62/5.16 * @param c collection containing elements to be added to this list
15.62/5.16 * @return true if this list changed as a result of the call
15.62/5.16 * @throws UnsupportedOperationException if the addAll operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of an element of the specified
15.62/5.16 * collection prevents it from being added to this list
15.62/5.16 * @throws NullPointerException if the specified collection contains one
15.62/5.16 * or more null elements and this list does not permit null
15.62/5.16 * elements, or if the specified collection is null
15.62/5.16 * @throws IllegalArgumentException if some property of an element of the
15.62/5.16 * specified collection prevents it from being added to this list
15.62/5.16 * @see #add(Object)
15.62/5.16 */
15.62/5.16 boolean addAll(Collection c);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Inserts all of the elements in the specified collection into this
15.62/5.16 * list at the specified position (optional operation). Shifts the
15.62/5.16 * element currently at that position (if any) and any subsequent
15.62/5.16 * elements to the right (increases their indices). The new elements
15.62/5.16 * will appear in this list in the order that they are returned by the
15.62/5.16 * specified collection's iterator. The behavior of this operation is
15.62/5.16 * undefined if the specified collection is modified while the
15.62/5.16 * operation is in progress. (Note that this will occur if the specified
15.62/5.16 * collection is this list, and it's nonempty.)
15.62/5.16 *
15.62/5.16 * @param index index at which to insert the first element from the
15.62/5.16 * specified collection
15.62/5.16 * @param c collection containing elements to be added to this list
15.62/5.16 * @return true if this list changed as a result of the call
15.62/5.16 * @throws UnsupportedOperationException if the addAll operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of an element of the specified
15.62/5.16 * collection prevents it from being added to this list
15.62/5.16 * @throws NullPointerException if the specified collection contains one
15.62/5.16 * or more null elements and this list does not permit null
15.62/5.16 * elements, or if the specified collection is null
15.62/5.16 * @throws IllegalArgumentException if some property of an element of the
15.62/5.16 * specified collection prevents it from being added to this list
15.62/5.16 * @throws IndexOutOfBoundsException if the index is out of range
15.62/5.16 * (index < 0 || index > size())
15.62/5.16 */
15.62/5.16 boolean addAll(int index, Collection c);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes from this list all of its elements that are contained in the
15.62/5.16 * specified collection (optional operation).
15.62/5.16 *
15.62/5.16 * @param c collection containing elements to be removed from this list
15.62/5.16 * @return true if this list changed as a result of the call
15.62/5.16 * @throws UnsupportedOperationException if the removeAll operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of an element of this list
15.62/5.16 * is incompatible with the specified collection (optional)
15.62/5.16 * @throws NullPointerException if this list contains a null element and the
15.62/5.16 * specified collection does not permit null elements (optional),
15.62/5.16 * or if the specified collection is null
15.62/5.16 * @see #remove(Object)
15.62/5.16 * @see #contains(Object)
15.62/5.16 */
15.62/5.16 boolean removeAll(Collection c);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Retains only the elements in this list that are contained in the
15.62/5.16 * specified collection (optional operation). In other words, removes
15.62/5.16 * from this list all of its elements that are not contained in the
15.62/5.16 * specified collection.
15.62/5.16 *
15.62/5.16 * @param c collection containing elements to be retained in this list
15.62/5.16 * @return true if this list changed as a result of the call
15.62/5.16 * @throws UnsupportedOperationException if the retainAll operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of an element of this list
15.62/5.16 * is incompatible with the specified collection (optional)
15.62/5.16 * @throws NullPointerException if this list contains a null element and the
15.62/5.16 * specified collection does not permit null elements (optional),
15.62/5.16 * or if the specified collection is null
15.62/5.16 * @see #remove(Object)
15.62/5.16 * @see #contains(Object)
15.62/5.16 */
15.62/5.16 boolean retainAll(Collection c);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes all of the elements from this list (optional operation).
15.62/5.16 * The list will be empty after this call returns.
15.62/5.16 *
15.62/5.16 * @throws UnsupportedOperationException if the clear operation
15.62/5.16 * is not supported by this list
15.62/5.16 */
15.62/5.16 void clear();
15.62/5.16
15.62/5.16
15.62/5.16 // Comparison and hashing
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Compares the specified object with this list for equality. Returns
15.62/5.16 * true if and only if the specified object is also a list, both
15.62/5.16 * lists have the same size, and all corresponding pairs of elements in
15.62/5.16 * the two lists are equal. (Two elements e1 and
15.62/5.16 * e2 are equal if (e1==null ? e2==null :
15.62/5.16 * e1.equals(e2)).) In other words, two lists are defined to be
15.62/5.16 * equal if they contain the same elements in the same order. This
15.62/5.16 * definition ensures that the equals method works properly across
15.62/5.16 * different implementations of the List interface.
15.62/5.16 *
15.62/5.16 * @param o the object to be compared for equality with this list
15.62/5.16 * @return true if the specified object is equal to this list
15.62/5.16 */
15.62/5.16 boolean equals(Object o);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the hash code value for this list. The hash code of a list
15.62/5.16 * is defined to be the result of the following calculation:
15.62/5.16 *
15.62/5.16 * int hashCode = 1;
15.62/5.16 * for (E e : list)
15.62/5.16 * hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());
15.62/5.16 *
15.62/5.16 * This ensures that list1.equals(list2) implies that
15.62/5.16 * list1.hashCode()==list2.hashCode() for any two lists,
15.62/5.16 * list1 and list2, as required by the general
15.62/5.16 * contract of {@link Object#hashCode}.
15.62/5.16 *
15.62/5.16 * @return the hash code value for this list
15.62/5.16 * @see Object#equals(Object)
15.62/5.16 * @see #equals(Object)
15.62/5.16 */
15.62/5.16 int hashCode();
15.62/5.16
15.62/5.16
15.62/5.16 // Positional Access Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the element at the specified position in this list.
15.62/5.16 *
15.62/5.16 * @param index index of the element to return
15.62/5.16 * @return the element at the specified position in this list
15.62/5.16 * @throws IndexOutOfBoundsException if the index is out of range
15.62/5.16 * (index < 0 || index >= size())
15.62/5.16 */
15.62/5.16 E get(int index);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Replaces the element at the specified position in this list with the
15.62/5.16 * specified element (optional operation).
15.62/5.16 *
15.62/5.16 * @param index index of the element to replace
15.62/5.16 * @param element element to be stored at the specified position
15.62/5.16 * @return the element previously at the specified position
15.62/5.16 * @throws UnsupportedOperationException if the set operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of the specified element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 * @throws NullPointerException if the specified element is null and
15.62/5.16 * this list does not permit null elements
15.62/5.16 * @throws IllegalArgumentException if some property of the specified
15.62/5.16 * element prevents it from being added to this list
15.62/5.16 * @throws IndexOutOfBoundsException if the index is out of range
15.62/5.16 * (index < 0 || index >= size())
15.62/5.16 */
15.62/5.16 E set(int index, E element);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Inserts the specified element at the specified position in this list
15.62/5.16 * (optional operation). Shifts the element currently at that position
15.62/5.16 * (if any) and any subsequent elements to the right (adds one to their
15.62/5.16 * indices).
15.62/5.16 *
15.62/5.16 * @param index index at which the specified element is to be inserted
15.62/5.16 * @param element element to be inserted
15.62/5.16 * @throws UnsupportedOperationException if the add operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws ClassCastException if the class of the specified element
15.62/5.16 * prevents it from being added to this list
15.62/5.16 * @throws NullPointerException if the specified element is null and
15.62/5.16 * this list does not permit null elements
15.62/5.16 * @throws IllegalArgumentException if some property of the specified
15.62/5.16 * element prevents it from being added to this list
15.62/5.16 * @throws IndexOutOfBoundsException if the index is out of range
15.62/5.16 * (index < 0 || index > size())
15.62/5.16 */
15.62/5.16 void add(int index, E element);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Removes the element at the specified position in this list (optional
15.62/5.16 * operation). Shifts any subsequent elements to the left (subtracts one
15.62/5.16 * from their indices). Returns the element that was removed from the
15.62/5.16 * list.
15.62/5.16 *
15.62/5.16 * @param index the index of the element to be removed
15.62/5.16 * @return the element previously at the specified position
15.62/5.16 * @throws UnsupportedOperationException if the remove operation
15.62/5.16 * is not supported by this list
15.62/5.16 * @throws IndexOutOfBoundsException if the index is out of range
15.62/5.16 * (index < 0 || index >= size())
15.62/5.16 */
15.62/5.16 E remove(int index);
15.62/5.16
15.62/5.16
15.62/5.16 // Search Operations
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the index of the first occurrence of the specified element
15.62/5.16 * in this list, or -1 if this list does not contain the element.
15.62/5.16 * More formally, returns the lowest index i such that
15.62/5.16 * (o==null ? get(i)==null : o.equals(get(i))),
15.62/5.16 * or -1 if there is no such index.
15.62/5.16 *
15.62/5.16 * @param o element to search for
15.62/5.16 * @return the index of the first occurrence of the specified element in
15.62/5.16 * this list, or -1 if this list does not contain the element
15.62/5.16 * @throws ClassCastException if the type of the specified element
15.62/5.16 * is incompatible with this list (optional)
15.62/5.16 * @throws NullPointerException if the specified element is null and this
15.62/5.16 * list does not permit null elements (optional)
15.62/5.16 */
15.62/5.16 int indexOf(Object o);
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns the index of the last occurrence of the specified element
15.62/5.16 * in this list, or -1 if this list does not contain the element.
15.62/5.16 * More formally, returns the highest index i such that
15.62/5.16 * (o==null ? get(i)==null : o.equals(get(i))),
15.62/5.16 * or -1 if there is no such index.
15.62/5.16 *
15.62/5.16 * @param o element to search for
15.62/5.16 * @return the index of the last occurrence of the specified element in
15.62/5.16 * this list, or -1 if this list does not contain the element
15.62/5.16 * @throws ClassCastException if the type of the specified element
15.62/5.16 * is incompatible with this list (optional)
15.62/5.16 * @throws NullPointerException if the specified element is null and this
15.62/5.16 * list does not permit null elements (optional)
15.62/5.16 */
15.62/5.16 int lastIndexOf(Object o);
15.62/5.16
15.62/5.16
15.62/5.16 // List Iterators
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns a list iterator over the elements in this list (in proper
15.62/5.16 * sequence).
15.62/5.16 *
15.62/5.16 * @return a list iterator over the elements in this list (in proper
15.62/5.16 * sequence)
15.62/5.16 */
15.62/5.16 ListIterator listIterator();
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns a list iterator over the elements in this list (in proper
15.62/5.16 * sequence), starting at the specified position in the list.
15.62/5.16 * The specified index indicates the first element that would be
15.62/5.16 * returned by an initial call to {@link ListIterator#next next}.
15.62/5.16 * An initial call to {@link ListIterator#previous previous} would
15.62/5.16 * return the element with the specified index minus one.
15.62/5.16 *
15.62/5.16 * @param index index of the first element to be returned from the
15.62/5.16 * list iterator (by a call to {@link ListIterator#next next})
15.62/5.16 * @return a list iterator over the elements in this list (in proper
15.62/5.16 * sequence), starting at the specified position in the list
15.62/5.16 * @throws IndexOutOfBoundsException if the index is out of range
15.62/5.16 * ({@code index < 0 || index > size()})
15.62/5.16 */
15.62/5.16 ListIterator listIterator(int index);
15.62/5.16
15.62/5.16 // View
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Returns a view of the portion of this list between the specified
15.62/5.16 * fromIndex, inclusive, and toIndex, exclusive. (If
15.62/5.16 * fromIndex and toIndex are equal, the returned list is
15.62/5.16 * empty.) The returned list is backed by this list, so non-structural
15.62/5.16 * changes in the returned list are reflected in this list, and vice-versa.
15.62/5.16 * The returned list supports all of the optional list operations supported
15.62/5.16 * by this list.
15.62/5.16 *
15.62/5.16 * This method eliminates the need for explicit range operations (of
15.62/5.16 * the sort that commonly exist for arrays). Any operation that expects
15.62/5.16 * a list can be used as a range operation by passing a subList view
15.62/5.16 * instead of a whole list. For example, the following idiom
15.62/5.16 * removes a range of elements from a list:
15.62/5.16 *
15.62/5.16 * list.subList(from, to).clear();
15.62/5.16 *
15.62/5.16 * Similar idioms may be constructed for indexOf and
15.62/5.16 * lastIndexOf, and all of the algorithms in the
15.62/5.16 * Collections class can be applied to a subList.
15.62/5.16 *
15.62/5.16 * The semantics of the list returned by this method become undefined if
15.62/5.16 * the backing list (i.e., this list) is structurally modified in
15.62/5.16 * any way other than via the returned list. (Structural modifications are
15.62/5.16 * those that change the size of this list, or otherwise perturb it in such
15.62/5.16 * a fashion that iterations in progress may yield incorrect results.)
15.62/5.16 *
15.62/5.16 * @param fromIndex low endpoint (inclusive) of the subList
15.62/5.16 * @param toIndex high endpoint (exclusive) of the subList
15.62/5.16 * @return a view of the specified range within this list
15.62/5.16 * @throws IndexOutOfBoundsException for an illegal endpoint index value
15.62/5.16 * (fromIndex < 0 || toIndex > size ||
15.62/5.16 * fromIndex > toIndex)
15.62/5.16 */
15.62/5.16 List subList(int fromIndex, int toIndex);
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * Copyright 1994-1998 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Thrown by the nextElement method of an
15.62/5.16 * Enumeration to indicate that there are no more
15.62/5.16 * elements in the enumeration.
15.62/5.16 *
15.62/5.16 * @author unascribed
15.62/5.16 * @see java.util.Enumeration
15.62/5.16 * @see java.util.Enumeration#nextElement()
15.62/5.16 * @since JDK1.0
15.62/5.16 */
15.62/5.16 public
15.62/5.16 class NoSuchElementException extends RuntimeException {
15.62/5.16 /**
15.62/5.16 * Constructs a NoSuchElementException with null
15.62/5.16 * as its error message string.
15.62/5.16 */
15.62/5.16 public NoSuchElementException() {
15.62/5.16 super();
15.62/5.16 }
15.62/5.16
15.62/5.16 /**
15.62/5.16 * Constructs a NoSuchElementException, saving a reference
15.62/5.16 * to the error message string s for later retrieval by the
15.62/5.16 * getMessage method.
15.62/5.16 *
15.62/5.16 * @param s the detail message.
15.62/5.16 */
15.62/5.16 public NoSuchElementException(String s) {
15.62/5.16 super(s);
15.62/5.16 }
15.62/5.16 }
15.62/5.16
15.62/5.16
15.62/5.16 /*
15.62/5.16 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.16 *
15.62/5.16 * This code is free software; you can redistribute it and/or modify it
15.62/5.16 * under the terms of the GNU General Public License version 2 only, as
15.62/5.16 * published by the Free Software Foundation. Sun designates this
15.62/5.16 * particular file as subject to the "Classpath" exception as provided
15.62/5.16 * by Sun in the LICENSE file that accompanied this code.
15.62/5.16 *
15.62/5.16 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.16 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.16 * accompanied this code).
15.62/5.16 *
15.62/5.16 * You should have received a copy of the GNU General Public License version
15.62/5.16 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.16 *
15.62/5.16 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.16 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.16 * have any questions.
15.62/5.16 */
15.62/5.16
15.62/5.16 /*
15.62/5.16 * This file is available under and governed by the GNU General Public
15.62/5.16 * License version 2 only, as published by the Free Software Foundation.
15.62/5.16 * However, the following notice accompanied the original version of this
15.62/5.16 * file:
15.62/5.16 *
15.62/5.16 * Written by Doug Lea with assistance from members of JCP JSR-166
15.62/5.16 * Expert Group and released to the public domain, as explained at
15.62/5.16 * http://creativecommons.org/licenses/publicdomain
15.62/5.16 */
15.62/5.16
15.62/5.16 package javaUtilEx;
15.62/5.16
15.62/5.16 /**
15.62/5.16 * A collection designed for holding elements prior to processing.
15.62/5.16 * Besides basic {@link java.util.Collection Collection} operations,
15.62/5.16 * queues provide additional insertion, extraction, and inspection
15.62/5.16 * operations. Each of these methods exists in two forms: one throws
15.62/5.16 * an exception if the operation fails, the other returns a special
15.62/5.16 * value (either null or false, depending on the
15.62/5.16 * operation). The latter form of the insert operation is designed
15.62/5.16 * specifically for use with capacity-restricted Queue
15.62/5.16 * implementations; in most implementations, insert operations cannot
15.62/5.16 * fail.
15.62/5.16 *
15.62/5.16 *
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * |
15.62/5.16 * Throws exception |
15.62/5.16 * Returns special value |
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * | Insert |
15.62/5.16 * {@link #add add(e)} |
15.62/5.16 * {@link #offer offer(e)} |
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * | Remove |
15.62/5.16 * {@link #remove remove()} |
15.62/5.16 * {@link #poll poll()} |
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * | Examine |
15.62/5.16 * {@link #element element()} |
15.62/5.16 * {@link #peek peek()} |
15.62/5.16 *
15.62/5.16 *
15.62/5.16 *
15.62/5.16 * Queues typically, but do not necessarily, order elements in a
15.62/5.16 * FIFO (first-in-first-out) manner. Among the exceptions are
15.62/5.16 * priority queues, which order elements according to a supplied
15.62/5.16 * comparator, or the elements' natural ordering, and LIFO queues (or
15.62/5.16 * stacks) which order the elements LIFO (last-in-first-out).
15.62/5.16 * Whatever the ordering used, the head of the queue is that
15.62/5.16 * element which would be removed by a call to {@link #remove() } or
15.62/5.16 * {@link #poll()}. In a FIFO queue, all new elements are inserted at
15.62/5.16 * the tail of the queue. Other kinds of queues may use
15.62/5.16 * different placement rules. Every Queue implementation
15.62/5.16 * must specify its ordering properties.
15.62/5.16 *
15.62/5.16 *
The {@link #offer offer} method inserts an element if possible,
15.62/5.16 * otherwise returning false. This differs from the {@link
15.62/5.16 * java.util.Collection#add Collection.add} method, which can fail to
15.62/5.16 * add an element only by throwing an unchecked exception. The
15.62/5.16 * offer method is designed for use when failure is a normal,
15.62/5.16 * rather than exceptional occurrence, for example, in fixed-capacity
15.62/5.16 * (or "bounded") queues.
15.62/5.16 *
15.62/5.16 *
The {@link #remove()} and {@link #poll()} methods remove and
15.62/5.16 * return the head of the queue.
15.62/5.16 * Exactly which element is removed from the queue is a
15.62/5.16 * function of the queue's ordering policy, which differs from
15.62/5.16 * implementation to implementation. The remove() and
15.62/5.16 * poll() methods differ only in their behavior when the
15.62/5.16 * queue is empty: the remove() method throws an exception,
15.62/5.16 * while the poll() method returns null.
15.62/5.16 *
15.62/5.16 *
The {@link #element()} and {@link #peek()} methods return, but do
15.62/5.17 * not remove, the head of the queue.
15.62/5.17 *
15.62/5.17 *
The Queue interface does not define the blocking queue
15.62/5.17 * methods, which are common in concurrent programming. These methods,
15.62/5.17 * which wait for elements to appear or for space to become available, are
15.62/5.17 * defined in the {@link java.util.concurrent.BlockingQueue} interface, which
15.62/5.17 * extends this interface.
15.62/5.17 *
15.62/5.17 *
Queue implementations generally do not allow insertion
15.62/5.17 * of null elements, although some implementations, such as
15.62/5.17 * {@link LinkedList}, do not prohibit insertion of null.
15.62/5.17 * Even in the implementations that permit it, null should
15.62/5.17 * not be inserted into a Queue, as null is also
15.62/5.17 * used as a special return value by the poll method to
15.62/5.17 * indicate that the queue contains no elements.
15.62/5.17 *
15.62/5.17 *
Queue implementations generally do not define
15.62/5.17 * element-based versions of methods equals and
15.62/5.17 * hashCode but instead inherit the identity based versions
15.62/5.17 * from class Object, because element-based equality is not
15.62/5.17 * always well-defined for queues with the same elements but different
15.62/5.17 * ordering properties.
15.62/5.17 *
15.62/5.17 *
15.62/5.17 *
This interface is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @see java.util.Collection
15.62/5.17 * @see LinkedList
15.62/5.17 * @see PriorityQueue
15.62/5.17 * @see java.util.concurrent.LinkedBlockingQueue
15.62/5.17 * @see java.util.concurrent.BlockingQueue
15.62/5.17 * @see java.util.concurrent.ArrayBlockingQueue
15.62/5.17 * @see java.util.concurrent.LinkedBlockingQueue
15.62/5.17 * @see java.util.concurrent.PriorityBlockingQueue
15.62/5.17 * @since 1.5
15.62/5.17 * @author Doug Lea
15.62/5.17 * @param the type of elements held in this collection
15.62/5.17 */
15.62/5.17 public interface Queue extends Collection {
15.62/5.17 /**
15.62/5.17 * Inserts the specified element into this queue if it is possible to do so
15.62/5.17 * immediately without violating capacity restrictions, returning
15.62/5.17 * true upon success and throwing an IllegalStateException
15.62/5.17 * if no space is currently available.
15.62/5.17 *
15.62/5.17 * @param e the element to add
15.62/5.17 * @return true (as specified by {@link Collection#add})
15.62/5.17 * @throws IllegalStateException if the element cannot be added at this
15.62/5.17 * time due to capacity restrictions
15.62/5.17 * @throws ClassCastException if the class of the specified element
15.62/5.17 * prevents it from being added to this queue
15.62/5.17 * @throws NullPointerException if the specified element is null and
15.62/5.17 * this queue does not permit null elements
15.62/5.17 * @throws IllegalArgumentException if some property of this element
15.62/5.17 * prevents it from being added to this queue
15.62/5.17 */
15.62/5.17 boolean add(E e);
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Inserts the specified element into this queue if it is possible to do
15.62/5.17 * so immediately without violating capacity restrictions.
15.62/5.17 * When using a capacity-restricted queue, this method is generally
15.62/5.17 * preferable to {@link #add}, which can fail to insert an element only
15.62/5.17 * by throwing an exception.
15.62/5.17 *
15.62/5.17 * @param e the element to add
15.62/5.17 * @return true if the element was added to this queue, else
15.62/5.17 * false
15.62/5.17 * @throws ClassCastException if the class of the specified element
15.62/5.17 * prevents it from being added to this queue
15.62/5.17 * @throws NullPointerException if the specified element is null and
15.62/5.17 * this queue does not permit null elements
15.62/5.17 * @throws IllegalArgumentException if some property of this element
15.62/5.17 * prevents it from being added to this queue
15.62/5.17 */
15.62/5.17 boolean offer(E e);
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Retrieves and removes the head of this queue. This method differs
15.62/5.17 * from {@link #poll poll} only in that it throws an exception if this
15.62/5.17 * queue is empty.
15.62/5.17 *
15.62/5.17 * @return the head of this queue
15.62/5.17 * @throws NoSuchElementException if this queue is empty
15.62/5.17 */
15.62/5.17 E remove();
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Retrieves and removes the head of this queue,
15.62/5.17 * or returns null if this queue is empty.
15.62/5.17 *
15.62/5.17 * @return the head of this queue, or null if this queue is empty
15.62/5.17 */
15.62/5.17 E poll();
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Retrieves, but does not remove, the head of this queue. This method
15.62/5.17 * differs from {@link #peek peek} only in that it throws an exception
15.62/5.17 * if this queue is empty.
15.62/5.17 *
15.62/5.17 * @return the head of this queue
15.62/5.17 * @throws NoSuchElementException if this queue is empty
15.62/5.17 */
15.62/5.17 E element();
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Retrieves, but does not remove, the head of this queue,
15.62/5.17 * or returns null if this queue is empty.
15.62/5.17 *
15.62/5.17 * @return the head of this queue, or null if this queue is empty
15.62/5.17 */
15.62/5.17 E peek();
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 /*
15.62/5.17 * Copyright 2000-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.17 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.17 *
15.62/5.17 * This code is free software; you can redistribute it and/or modify it
15.62/5.17 * under the terms of the GNU General Public License version 2 only, as
15.62/5.17 * published by the Free Software Foundation. Sun designates this
15.62/5.17 * particular file as subject to the "Classpath" exception as provided
15.62/5.17 * by Sun in the LICENSE file that accompanied this code.
15.62/5.17 *
15.62/5.17 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.17 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.17 * accompanied this code).
15.62/5.17 *
15.62/5.17 * You should have received a copy of the GNU General Public License version
15.62/5.17 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.17 *
15.62/5.17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.17 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.17 * have any questions.
15.62/5.17 */
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Marker interface used by List implementations to indicate that
15.62/5.17 * they support fast (generally constant time) random access. The primary
15.62/5.17 * purpose of this interface is to allow generic algorithms to alter their
15.62/5.17 * behavior to provide good performance when applied to either random or
15.62/5.17 * sequential access lists.
15.62/5.17 *
15.62/5.17 * The best algorithms for manipulating random access lists (such as
15.62/5.17 * ArrayList) can produce quadratic behavior when applied to
15.62/5.17 * sequential access lists (such as LinkedList). Generic list
15.62/5.17 * algorithms are encouraged to check whether the given list is an
15.62/5.17 * instanceof this interface before applying an algorithm that would
15.62/5.17 * provide poor performance if it were applied to a sequential access list,
15.62/5.17 * and to alter their behavior if necessary to guarantee acceptable
15.62/5.17 * performance.
15.62/5.17 *
15.62/5.17 *
It is recognized that the distinction between random and sequential
15.62/5.17 * access is often fuzzy. For example, some List implementations
15.62/5.17 * provide asymptotically linear access times if they get huge, but constant
15.62/5.17 * access times in practice. Such a List implementation
15.62/5.17 * should generally implement this interface. As a rule of thumb, a
15.62/5.17 * List implementation should implement this interface if,
15.62/5.17 * for typical instances of the class, this loop:
15.62/5.17 *
15.62/5.17 * for (int i=0, n=list.size(); i < n; i++)
15.62/5.17 * list.get(i);
15.62/5.17 *
15.62/5.17 * runs faster than this loop:
15.62/5.17 *
15.62/5.17 * for (Iterator i=list.iterator(); i.hasNext(); )
15.62/5.17 * i.next();
15.62/5.17 *
15.62/5.17 *
15.62/5.17 * This interface is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @since 1.4
15.62/5.17 */
15.62/5.17 public interface RandomAccess {
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 public class Random {
15.62/5.17 static String[] args;
15.62/5.17 static int index = 0;
15.62/5.17
15.62/5.17 public static int random() {
15.62/5.17 String string = args[index];
15.62/5.17 index++;
15.62/5.17 return string.length();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 /*
15.62/5.17 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.17 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.17 *
15.62/5.17 * This code is free software; you can redistribute it and/or modify it
15.62/5.17 * under the terms of the GNU General Public License version 2 only, as
15.62/5.17 * published by the Free Software Foundation. Sun designates this
15.62/5.17 * particular file as subject to the "Classpath" exception as provided
15.62/5.17 * by Sun in the LICENSE file that accompanied this code.
15.62/5.17 *
15.62/5.17 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.17 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.17 * accompanied this code).
15.62/5.17 *
15.62/5.17 * You should have received a copy of the GNU General Public License version
15.62/5.17 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.17 *
15.62/5.17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.17 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.17 * have any questions.
15.62/5.17 */
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Thrown to indicate that the requested operation is not supported.
15.62/5.17 *
15.62/5.17 * This class is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @author Josh Bloch
15.62/5.17 * @since 1.2
15.62/5.17 */
15.62/5.17 public class UnsupportedOperationException extends RuntimeException {
15.62/5.17 /**
15.62/5.17 * Constructs an UnsupportedOperationException with no detail message.
15.62/5.17 */
15.62/5.17 public UnsupportedOperationException() {
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Constructs an UnsupportedOperationException with the specified
15.62/5.17 * detail message.
15.62/5.17 *
15.62/5.17 * @param message the detail message
15.62/5.17 */
15.62/5.17 public UnsupportedOperationException(String message) {
15.62/5.17 super(message);
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Constructs a new exception with the specified detail message and
15.62/5.17 * cause.
15.62/5.17 *
15.62/5.17 *
Note that the detail message associated with cause is
15.62/5.17 * not automatically incorporated in this exception's detail
15.62/5.17 * message.
15.62/5.17 *
15.62/5.17 * @param message the detail message (which is saved for later retrieval
15.62/5.17 * by the {@link Throwable#getMessage()} method).
15.62/5.17 * @param cause the cause (which is saved for later retrieval by the
15.62/5.17 * {@link Throwable#getCause()} method). (A null value
15.62/5.17 * is permitted, and indicates that the cause is nonexistent or
15.62/5.17 * unknown.)
15.62/5.17 * @since 1.5
15.62/5.17 */
15.62/5.17 public UnsupportedOperationException(String message, Throwable cause) {
15.62/5.17 super(message, cause);
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Constructs a new exception with the specified cause and a detail
15.62/5.17 * message of (cause==null ? null : cause.toString()) (which
15.62/5.17 * typically contains the class and detail message of cause).
15.62/5.17 * This constructor is useful for exceptions that are little more than
15.62/5.17 * wrappers for other throwables (for example, {@link
15.62/5.17 * java.security.PrivilegedActionException}).
15.62/5.17 *
15.62/5.17 * @param cause the cause (which is saved for later retrieval by the
15.62/5.17 * {@link Throwable#getCause()} method). (A null value is
15.62/5.17 * permitted, and indicates that the cause is nonexistent or
15.62/5.17 * unknown.)
15.62/5.17 * @since 1.5
15.62/5.17 */
15.62/5.17 public UnsupportedOperationException(Throwable cause) {
15.62/5.17 super(cause);
15.62/5.17 }
15.62/5.17
15.62/5.17 static final long serialVersionUID = -1242599979055084673L;
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17
15.62/5.17 ----------------------------------------
15.62/5.17
15.62/5.17 (1) BareJBCToJBCProof (EQUIVALENT)
15.62/5.17 initialized classpath
15.62/5.17 ----------------------------------------
15.62/5.17
15.62/5.17 (2)
15.62/5.17 Obligation:
15.62/5.17 need to prove termination of the following program:
15.62/5.17 /*
15.62/5.17 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.17 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.17 *
15.62/5.17 * This code is free software; you can redistribute it and/or modify it
15.62/5.17 * under the terms of the GNU General Public License version 2 only, as
15.62/5.17 * published by the Free Software Foundation. Sun designates this
15.62/5.17 * particular file as subject to the "Classpath" exception as provided
15.62/5.17 * by Sun in the LICENSE file that accompanied this code.
15.62/5.17 *
15.62/5.17 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.17 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.17 * accompanied this code).
15.62/5.17 *
15.62/5.17 * You should have received a copy of the GNU General Public License version
15.62/5.17 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.17 *
15.62/5.17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.17 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.17 * have any questions.
15.62/5.17 */
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * This class provides a skeletal implementation of the Collection
15.62/5.17 * interface, to minimize the effort required to implement this interface.
15.62/5.17 *
15.62/5.17 * To implement an unmodifiable collection, the programmer needs only to
15.62/5.17 * extend this class and provide implementations for the iterator and
15.62/5.17 * size methods. (The iterator returned by the iterator
15.62/5.17 * method must implement hasNext and next.)
15.62/5.17 *
15.62/5.17 * To implement a modifiable collection, the programmer must additionally
15.62/5.17 * override this class's add method (which otherwise throws an
15.62/5.17 * UnsupportedOperationException), and the iterator returned by the
15.62/5.17 * iterator method must additionally implement its remove
15.62/5.17 * method.
15.62/5.17 *
15.62/5.17 * The programmer should generally provide a void (no argument) and
15.62/5.17 * Collection constructor, as per the recommendation in the
15.62/5.17 * Collection interface specification.
15.62/5.17 *
15.62/5.17 * The documentation for each non-abstract method in this class describes its
15.62/5.17 * implementation in detail. Each of these methods may be overridden if
15.62/5.17 * the collection being implemented admits a more efficient implementation.
15.62/5.17 *
15.62/5.17 * This class is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @author Josh Bloch
15.62/5.17 * @author Neal Gafter
15.62/5.17 * @see Collection
15.62/5.17 * @since 1.2
15.62/5.17 */
15.62/5.17
15.62/5.17 public abstract class AbstractCollection implements Collection {
15.62/5.17 /**
15.62/5.17 * Sole constructor. (For invocation by subclass constructors, typically
15.62/5.17 * implicit.)
15.62/5.17 */
15.62/5.17 protected AbstractCollection() {
15.62/5.17 }
15.62/5.17
15.62/5.17 // Query Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns an iterator over the elements contained in this collection.
15.62/5.17 *
15.62/5.17 * @return an iterator over the elements contained in this collection
15.62/5.17 */
15.62/5.17 public abstract Iterator iterator();
15.62/5.17
15.62/5.17 public abstract int size();
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation returns size() == 0.
15.62/5.17 */
15.62/5.17 public boolean isEmpty() {
15.62/5.17 return size() == 0;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation iterates over the elements in the collection,
15.62/5.17 * checking each element in turn for equality with the specified element.
15.62/5.17 *
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public boolean contains(Object o) {
15.62/5.17 Iterator e = iterator();
15.62/5.17 if (o==null) {
15.62/5.17 while (e.hasNext())
15.62/5.17 if (e.next()==null)
15.62/5.17 return true;
15.62/5.17 } else {
15.62/5.17 while (e.hasNext())
15.62/5.17 if (o.equals(e.next()))
15.62/5.17 return true;
15.62/5.17 }
15.62/5.17 return false;
15.62/5.17 }
15.62/5.17
15.62/5.17 // Modification Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation always throws an
15.62/5.17 * UnsupportedOperationException.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IllegalStateException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public boolean add(E e) {
15.62/5.17 throw new UnsupportedOperationException();
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation iterates over the collection looking for the
15.62/5.17 * specified element. If it finds the element, it removes the element
15.62/5.17 * from the collection using the iterator's remove method.
15.62/5.17 *
15.62/5.17 *
Note that this implementation throws an
15.62/5.17 * UnsupportedOperationException if the iterator returned by this
15.62/5.17 * collection's iterator method does not implement the remove
15.62/5.17 * method and this collection contains the specified object.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public boolean remove(Object o) {
15.62/5.17 Iterator e = iterator();
15.62/5.17 if (o==null) {
15.62/5.17 while (e.hasNext()) {
15.62/5.17 if (e.next()==null) {
15.62/5.17 e.remove();
15.62/5.17 return true;
15.62/5.17 }
15.62/5.17 }
15.62/5.17 } else {
15.62/5.17 while (e.hasNext()) {
15.62/5.17 if (o.equals(e.next())) {
15.62/5.17 e.remove();
15.62/5.17 return true;
15.62/5.17 }
15.62/5.17 }
15.62/5.17 }
15.62/5.17 return false;
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // Bulk Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation iterates over the specified collection,
15.62/5.17 * checking each element returned by the iterator in turn to see
15.62/5.17 * if it's contained in this collection. If all elements are so
15.62/5.17 * contained true is returned, otherwise false.
15.62/5.17 *
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @see #contains(Object)
15.62/5.17 */
15.62/5.17 public boolean containsAll(Collection c) {
15.62/5.17 Iterator e = c.iterator();
15.62/5.17 while (e.hasNext())
15.62/5.17 if (!contains(e.next()))
15.62/5.17 return false;
15.62/5.17 return true;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation iterates over the specified collection, and adds
15.62/5.17 * each object returned by the iterator to this collection, in turn.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException unless add is
15.62/5.17 * overridden (assuming the specified collection is non-empty).
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IllegalStateException {@inheritDoc}
15.62/5.17 *
15.62/5.17 * @see #add(Object)
15.62/5.17 */
15.62/5.17 public boolean addAll(Collection c) {
15.62/5.17 boolean modified = false;
15.62/5.17 Iterator e = c.iterator();
15.62/5.17 while (e.hasNext()) {
15.62/5.17 if (add(e.next()))
15.62/5.17 modified = true;
15.62/5.17 }
15.62/5.17 return modified;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation iterates over this collection, checking each
15.62/5.17 * element returned by the iterator in turn to see if it's contained
15.62/5.17 * in the specified collection. If it's so contained, it's removed from
15.62/5.17 * this collection with the iterator's remove method.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the iterator returned by the
15.62/5.17 * iterator method does not implement the remove method
15.62/5.17 * and this collection contains one or more elements in common with the
15.62/5.17 * specified collection.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 *
15.62/5.17 * @see #remove(Object)
15.62/5.17 * @see #contains(Object)
15.62/5.17 */
15.62/5.17 public boolean removeAll(Collection c) {
15.62/5.17 boolean modified = false;
15.62/5.17 Iterator e = iterator();
15.62/5.17 while (e.hasNext()) {
15.62/5.17 if (c.contains(e.next())) {
15.62/5.17 e.remove();
15.62/5.17 modified = true;
15.62/5.17 }
15.62/5.17 }
15.62/5.17 return modified;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation iterates over this collection, checking each
15.62/5.17 * element returned by the iterator in turn to see if it's contained
15.62/5.17 * in the specified collection. If it's not so contained, it's removed
15.62/5.17 * from this collection with the iterator's remove method.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the iterator returned by the
15.62/5.17 * iterator method does not implement the remove method
15.62/5.17 * and this collection contains one or more elements not present in the
15.62/5.17 * specified collection.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 *
15.62/5.17 * @see #remove(Object)
15.62/5.17 * @see #contains(Object)
15.62/5.17 */
15.62/5.17 public boolean retainAll(Collection c) {
15.62/5.17 boolean modified = false;
15.62/5.17 Iterator e = iterator();
15.62/5.17 while (e.hasNext()) {
15.62/5.17 if (!c.contains(e.next())) {
15.62/5.17 e.remove();
15.62/5.17 modified = true;
15.62/5.17 }
15.62/5.17 }
15.62/5.17 return modified;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation iterates over this collection, removing each
15.62/5.17 * element using the Iterator.remove operation. Most
15.62/5.17 * implementations will probably choose to override this method for
15.62/5.17 * efficiency.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the iterator returned by this
15.62/5.17 * collection's iterator method does not implement the
15.62/5.17 * remove method and this collection is non-empty.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public void clear() {
15.62/5.17 Iterator e = iterator();
15.62/5.17 while (e.hasNext()) {
15.62/5.17 e.next();
15.62/5.17 e.remove();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // String conversion
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns a string representation of this collection. The string
15.62/5.17 * representation consists of a list of the collection's elements in the
15.62/5.17 * order they are returned by its iterator, enclosed in square brackets
15.62/5.17 * ("[]"). Adjacent elements are separated by the characters
15.62/5.17 * ", " (comma and space). Elements are converted to strings as
15.62/5.17 * by {@link String#valueOf(Object)}.
15.62/5.17 *
15.62/5.17 * @return a string representation of this collection
15.62/5.17 */
15.62/5.17 public String toString() {
15.62/5.17 Iterator i = iterator();
15.62/5.17 if (! i.hasNext())
15.62/5.17 return "[]";
15.62/5.17
15.62/5.17 String sb = "";
15.62/5.17 sb = sb + "[";
15.62/5.17 for (;;) {
15.62/5.17 E e = i.next();
15.62/5.17 sb = sb + (e == this ? "(this Collection)" : e);
15.62/5.17 if (! i.hasNext()) {
15.62/5.17 sb = sb + "]";
15.62/5.17 return sb;
15.62/5.17 }
15.62/5.17 sb = sb + ", ";
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 /*
15.62/5.17 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.17 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.17 *
15.62/5.17 * This code is free software; you can redistribute it and/or modify it
15.62/5.17 * under the terms of the GNU General Public License version 2 only, as
15.62/5.17 * published by the Free Software Foundation. Sun designates this
15.62/5.17 * particular file as subject to the "Classpath" exception as provided
15.62/5.17 * by Sun in the LICENSE file that accompanied this code.
15.62/5.17 *
15.62/5.17 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.17 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.17 * accompanied this code).
15.62/5.17 *
15.62/5.17 * You should have received a copy of the GNU General Public License version
15.62/5.17 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.17 *
15.62/5.17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.17 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.17 * have any questions.
15.62/5.17 */
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * This class provides a skeletal implementation of the {@link List}
15.62/5.17 * interface to minimize the effort required to implement this interface
15.62/5.17 * backed by a "random access" data store (such as an array). For sequential
15.62/5.17 * access data (such as a linked list), {@link AbstractSequentialList} should
15.62/5.17 * be used in preference to this class.
15.62/5.17 *
15.62/5.17 * To implement an unmodifiable list, the programmer needs only to extend
15.62/5.17 * this class and provide implementations for the {@link #get(int)} and
15.62/5.17 * {@link List#size() size()} methods.
15.62/5.17 *
15.62/5.17 *
To implement a modifiable list, the programmer must additionally
15.62/5.17 * override the {@link #set(int, Object) set(int, E)} method (which otherwise
15.62/5.17 * throws an {@code UnsupportedOperationException}). If the list is
15.62/5.17 * variable-size the programmer must additionally override the
15.62/5.17 * {@link #add(int, Object) add(int, E)} and {@link #remove(int)} methods.
15.62/5.17 *
15.62/5.17 *
The programmer should generally provide a void (no argument) and collection
15.62/5.17 * constructor, as per the recommendation in the {@link Collection} interface
15.62/5.17 * specification.
15.62/5.17 *
15.62/5.17 *
Unlike the other abstract collection implementations, the programmer does
15.62/5.17 * not have to provide an iterator implementation; the iterator and
15.62/5.17 * list iterator are implemented by this class, on top of the "random access"
15.62/5.17 * methods:
15.62/5.17 * {@link #get(int)},
15.62/5.17 * {@link #set(int, Object) set(int, E)},
15.62/5.17 * {@link #add(int, Object) add(int, E)} and
15.62/5.17 * {@link #remove(int)}.
15.62/5.17 *
15.62/5.17 *
The documentation for each non-abstract method in this class describes its
15.62/5.17 * implementation in detail. Each of these methods may be overridden if the
15.62/5.17 * collection being implemented admits a more efficient implementation.
15.62/5.17 *
15.62/5.17 *
This class is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @author Josh Bloch
15.62/5.17 * @author Neal Gafter
15.62/5.17 * @since 1.2
15.62/5.17 */
15.62/5.17
15.62/5.17 public abstract class AbstractList extends AbstractCollection implements List {
15.62/5.17 /**
15.62/5.17 * Sole constructor. (For invocation by subclass constructors, typically
15.62/5.17 * implicit.)
15.62/5.17 */
15.62/5.17 protected AbstractList() {
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Appends the specified element to the end of this list (optional
15.62/5.17 * operation).
15.62/5.17 *
15.62/5.17 * Lists that support this operation may place limitations on what
15.62/5.17 * elements may be added to this list. In particular, some
15.62/5.17 * lists will refuse to add null elements, and others will impose
15.62/5.17 * restrictions on the type of elements that may be added. List
15.62/5.17 * classes should clearly specify in their documentation any restrictions
15.62/5.17 * on what elements may be added.
15.62/5.17 *
15.62/5.17 *
This implementation calls {@code add(size(), e)}.
15.62/5.17 *
15.62/5.17 *
Note that this implementation throws an
15.62/5.17 * {@code UnsupportedOperationException} unless
15.62/5.17 * {@link #add(int, Object) add(int, E)} is overridden.
15.62/5.17 *
15.62/5.17 * @param e element to be appended to this list
15.62/5.17 * @return {@code true} (as specified by {@link Collection#add})
15.62/5.17 * @throws UnsupportedOperationException if the {@code add} operation
15.62/5.17 * is not supported by this list
15.62/5.17 * @throws ClassCastException if the class of the specified element
15.62/5.17 * prevents it from being added to this list
15.62/5.17 * @throws NullPointerException if the specified element is null and this
15.62/5.17 * list does not permit null elements
15.62/5.17 * @throws IllegalArgumentException if some property of this element
15.62/5.17 * prevents it from being added to this list
15.62/5.17 */
15.62/5.17 public boolean add(E e) {
15.62/5.17 add(size(), e);
15.62/5.17 return true;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 abstract public E get(int index);
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation always throws an
15.62/5.17 * {@code UnsupportedOperationException}.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public E set(int index, E element) {
15.62/5.17 throw new UnsupportedOperationException();
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation always throws an
15.62/5.17 * {@code UnsupportedOperationException}.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public void add(int index, E element) {
15.62/5.17 throw new UnsupportedOperationException();
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation always throws an
15.62/5.17 * {@code UnsupportedOperationException}.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public E remove(int index) {
15.62/5.17 throw new UnsupportedOperationException();
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // Search Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation first gets a list iterator (with
15.62/5.17 * {@code listIterator()}). Then, it iterates over the list until the
15.62/5.17 * specified element is found or the end of the list is reached.
15.62/5.17 *
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public int indexOf(Object o) {
15.62/5.17 ListIterator e = listIterator();
15.62/5.17 if (o==null) {
15.62/5.17 while (e.hasNext())
15.62/5.17 if (e.next()==null)
15.62/5.17 return e.previousIndex();
15.62/5.17 } else {
15.62/5.17 while (e.hasNext())
15.62/5.17 if (o.equals(e.next()))
15.62/5.17 return e.previousIndex();
15.62/5.17 }
15.62/5.17 return -1;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation first gets a list iterator that points to the end
15.62/5.17 * of the list (with {@code listIterator(size())}). Then, it iterates
15.62/5.17 * backwards over the list until the specified element is found, or the
15.62/5.17 * beginning of the list is reached.
15.62/5.17 *
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public int lastIndexOf(Object o) {
15.62/5.17 ListIterator e = listIterator(size());
15.62/5.17 if (o==null) {
15.62/5.17 while (e.hasPrevious())
15.62/5.17 if (e.previous()==null)
15.62/5.17 return e.nextIndex();
15.62/5.17 } else {
15.62/5.17 while (e.hasPrevious())
15.62/5.17 if (o.equals(e.previous()))
15.62/5.17 return e.nextIndex();
15.62/5.17 }
15.62/5.17 return -1;
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // Bulk Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Removes all of the elements from this list (optional operation).
15.62/5.17 * The list will be empty after this call returns.
15.62/5.17 *
15.62/5.17 * This implementation calls {@code removeRange(0, size())}.
15.62/5.17 *
15.62/5.17 *
Note that this implementation throws an
15.62/5.17 * {@code UnsupportedOperationException} unless {@code remove(int
15.62/5.17 * index)} or {@code removeRange(int fromIndex, int toIndex)} is
15.62/5.17 * overridden.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException if the {@code clear} operation
15.62/5.17 * is not supported by this list
15.62/5.17 */
15.62/5.17 public void clear() {
15.62/5.17 removeRange(0, size());
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 *
This implementation gets an iterator over the specified collection
15.62/5.17 * and iterates over it, inserting the elements obtained from the
15.62/5.17 * iterator into this list at the appropriate position, one at a time,
15.62/5.17 * using {@code add(int, E)}.
15.62/5.17 * Many implementations will override this method for efficiency.
15.62/5.17 *
15.62/5.17 *
Note that this implementation throws an
15.62/5.17 * {@code UnsupportedOperationException} unless
15.62/5.17 * {@link #add(int, Object) add(int, E)} is overridden.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public boolean addAll(int index, Collection c) {
15.62/5.17 rangeCheckForAdd(index);
15.62/5.17 boolean modified = false;
15.62/5.17 Iterator e = c.iterator();
15.62/5.17 while (e.hasNext()) {
15.62/5.17 add(index++, e.next());
15.62/5.17 modified = true;
15.62/5.17 }
15.62/5.17 return modified;
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // Iterators
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns an iterator over the elements in this list in proper sequence.
15.62/5.17 *
15.62/5.17 *
This implementation returns a straightforward implementation of the
15.62/5.17 * iterator interface, relying on the backing list's {@code size()},
15.62/5.17 * {@code get(int)}, and {@code remove(int)} methods.
15.62/5.17 *
15.62/5.17 *
Note that the iterator returned by this method will throw an
15.62/5.17 * {@link UnsupportedOperationException} in response to its
15.62/5.17 * {@code remove} method unless the list's {@code remove(int)} method is
15.62/5.17 * overridden.
15.62/5.17 *
15.62/5.17 *
This implementation can be made to throw runtime exceptions in the
15.62/5.17 * face of concurrent modification, as described in the specification
15.62/5.17 * for the (protected) {@link #modCount} field.
15.62/5.17 *
15.62/5.17 * @return an iterator over the elements in this list in proper sequence
15.62/5.17 */
15.62/5.17 public Iterator iterator() {
15.62/5.17 return new Itr();
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation returns {@code listIterator(0)}.
15.62/5.17 *
15.62/5.17 * @see #listIterator(int)
15.62/5.17 */
15.62/5.17 public ListIterator listIterator() {
15.62/5.17 return listIterator(0);
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation returns a straightforward implementation of the
15.62/5.17 * {@code ListIterator} interface that extends the implementation of the
15.62/5.17 * {@code Iterator} interface returned by the {@code iterator()} method.
15.62/5.17 * The {@code ListIterator} implementation relies on the backing list's
15.62/5.17 * {@code get(int)}, {@code set(int, E)}, {@code add(int, E)}
15.62/5.17 * and {@code remove(int)} methods.
15.62/5.17 *
15.62/5.17 *
Note that the list iterator returned by this implementation will
15.62/5.17 * throw an {@link UnsupportedOperationException} in response to its
15.62/5.17 * {@code remove}, {@code set} and {@code add} methods unless the
15.62/5.17 * list's {@code remove(int)}, {@code set(int, E)}, and
15.62/5.17 * {@code add(int, E)} methods are overridden.
15.62/5.17 *
15.62/5.17 *
This implementation can be made to throw runtime exceptions in the
15.62/5.17 * face of concurrent modification, as described in the specification for
15.62/5.17 * the (protected) {@link #modCount} field.
15.62/5.17 *
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public ListIterator listIterator(final int index) {
15.62/5.17 rangeCheckForAdd(index);
15.62/5.17
15.62/5.17 return new ListItr(index);
15.62/5.17 }
15.62/5.17
15.62/5.17 private class Itr implements Iterator {
15.62/5.17 /**
15.62/5.17 * Index of element to be returned by subsequent call to next.
15.62/5.17 */
15.62/5.17 int cursor = 0;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Index of element returned by most recent call to next or
15.62/5.17 * previous. Reset to -1 if this element is deleted by a call
15.62/5.17 * to remove.
15.62/5.17 */
15.62/5.17 int lastRet = -1;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * The modCount value that the iterator believes that the backing
15.62/5.17 * List should have. If this expectation is violated, the iterator
15.62/5.17 * has detected concurrent modification.
15.62/5.17 */
15.62/5.17 int expectedModCount = modCount;
15.62/5.17
15.62/5.17 public boolean hasNext() {
15.62/5.17 return cursor != size();
15.62/5.17 }
15.62/5.17
15.62/5.17 public E next() {
15.62/5.17 checkForComodification();
15.62/5.17 try {
15.62/5.17 int i = cursor;
15.62/5.17 E next = get(i);
15.62/5.17 lastRet = i;
15.62/5.17 cursor = i + 1;
15.62/5.17 return next;
15.62/5.17 } catch (IndexOutOfBoundsException e) {
15.62/5.17 checkForComodification();
15.62/5.17 throw new NoSuchElementException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 public void remove() {
15.62/5.17 if (lastRet < 0)
15.62/5.17 throw new IllegalStateException();
15.62/5.17 checkForComodification();
15.62/5.17
15.62/5.17 try {
15.62/5.17 AbstractList.this.remove(lastRet);
15.62/5.17 if (lastRet < cursor)
15.62/5.17 cursor--;
15.62/5.17 lastRet = -1;
15.62/5.17 expectedModCount = modCount;
15.62/5.17 } catch (IndexOutOfBoundsException e) {
15.62/5.17 throw new ConcurrentModificationException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 final void checkForComodification() {
15.62/5.17 if (modCount != expectedModCount)
15.62/5.17 throw new ConcurrentModificationException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 private class ListItr extends Itr implements ListIterator {
15.62/5.17 ListItr(int index) {
15.62/5.17 cursor = index;
15.62/5.17 }
15.62/5.17
15.62/5.17 public boolean hasPrevious() {
15.62/5.17 return cursor != 0;
15.62/5.17 }
15.62/5.17
15.62/5.17 public E previous() {
15.62/5.17 checkForComodification();
15.62/5.17 try {
15.62/5.17 int i = cursor - 1;
15.62/5.17 E previous = get(i);
15.62/5.17 lastRet = cursor = i;
15.62/5.17 return previous;
15.62/5.17 } catch (IndexOutOfBoundsException e) {
15.62/5.17 checkForComodification();
15.62/5.17 throw new NoSuchElementException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 public int nextIndex() {
15.62/5.17 return cursor;
15.62/5.17 }
15.62/5.17
15.62/5.17 public int previousIndex() {
15.62/5.17 return cursor-1;
15.62/5.17 }
15.62/5.17
15.62/5.17 public void set(E e) {
15.62/5.17 if (lastRet < 0)
15.62/5.17 throw new IllegalStateException();
15.62/5.17 checkForComodification();
15.62/5.17
15.62/5.17 try {
15.62/5.17 AbstractList.this.set(lastRet, e);
15.62/5.17 expectedModCount = modCount;
15.62/5.17 } catch (IndexOutOfBoundsException ex) {
15.62/5.17 throw new ConcurrentModificationException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 public void add(E e) {
15.62/5.17 checkForComodification();
15.62/5.17
15.62/5.17 try {
15.62/5.17 int i = cursor;
15.62/5.17 AbstractList.this.add(i, e);
15.62/5.17 lastRet = -1;
15.62/5.17 cursor = i + 1;
15.62/5.17 expectedModCount = modCount;
15.62/5.17 } catch (IndexOutOfBoundsException ex) {
15.62/5.17 throw new ConcurrentModificationException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * {@inheritDoc}
15.62/5.17 *
15.62/5.17 * This implementation returns a list that subclasses
15.62/5.17 * {@code AbstractList}. The subclass stores, in private fields, the
15.62/5.17 * offset of the subList within the backing list, the size of the subList
15.62/5.17 * (which can change over its lifetime), and the expected
15.62/5.17 * {@code modCount} value of the backing list. There are two variants
15.62/5.17 * of the subclass, one of which implements {@code RandomAccess}.
15.62/5.17 * If this list implements {@code RandomAccess} the returned list will
15.62/5.17 * be an instance of the subclass that implements {@code RandomAccess}.
15.62/5.17 *
15.62/5.17 *
The subclass's {@code set(int, E)}, {@code get(int)},
15.62/5.17 * {@code add(int, E)}, {@code remove(int)}, {@code addAll(int,
15.62/5.17 * Collection)} and {@code removeRange(int, int)} methods all
15.62/5.17 * delegate to the corresponding methods on the backing abstract list,
15.62/5.17 * after bounds-checking the index and adjusting for the offset. The
15.62/5.17 * {@code addAll(Collection c)} method merely returns {@code addAll(size,
15.62/5.17 * c)}.
15.62/5.17 *
15.62/5.17 *
The {@code listIterator(int)} method returns a "wrapper object"
15.62/5.17 * over a list iterator on the backing list, which is created with the
15.62/5.17 * corresponding method on the backing list. The {@code iterator} method
15.62/5.17 * merely returns {@code listIterator()}, and the {@code size} method
15.62/5.17 * merely returns the subclass's {@code size} field.
15.62/5.17 *
15.62/5.17 *
All methods first check to see if the actual {@code modCount} of
15.62/5.17 * the backing list is equal to its expected value, and throw a
15.62/5.17 * {@code ConcurrentModificationException} if it is not.
15.62/5.17 *
15.62/5.17 * @throws IndexOutOfBoundsException if an endpoint index value is out of range
15.62/5.17 * {@code (fromIndex < 0 || toIndex > size)}
15.62/5.17 * @throws IllegalArgumentException if the endpoint indices are out of order
15.62/5.17 * {@code (fromIndex > toIndex)}
15.62/5.17 */
15.62/5.17 public List subList(int fromIndex, int toIndex) {
15.62/5.17 return (this instanceof RandomAccess ?
15.62/5.17 new RandomAccessSubList(this, fromIndex, toIndex) :
15.62/5.17 new SubList(this, fromIndex, toIndex));
15.62/5.17 }
15.62/5.17
15.62/5.17 // Comparison and hashing
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Compares the specified object with this list for equality. Returns
15.62/5.17 * {@code true} if and only if the specified object is also a list, both
15.62/5.17 * lists have the same size, and all corresponding pairs of elements in
15.62/5.17 * the two lists are equal. (Two elements {@code e1} and
15.62/5.17 * {@code e2} are equal if {@code (e1==null ? e2==null :
15.62/5.17 * e1.equals(e2))}.) In other words, two lists are defined to be
15.62/5.17 * equal if they contain the same elements in the same order.
15.62/5.17 *
15.62/5.17 * This implementation first checks if the specified object is this
15.62/5.17 * list. If so, it returns {@code true}; if not, it checks if the
15.62/5.17 * specified object is a list. If not, it returns {@code false}; if so,
15.62/5.17 * it iterates over both lists, comparing corresponding pairs of elements.
15.62/5.17 * If any comparison returns {@code false}, this method returns
15.62/5.17 * {@code false}. If either iterator runs out of elements before the
15.62/5.17 * other it returns {@code false} (as the lists are of unequal length);
15.62/5.17 * otherwise it returns {@code true} when the iterations complete.
15.62/5.17 *
15.62/5.17 * @param o the object to be compared for equality with this list
15.62/5.17 * @return {@code true} if the specified object is equal to this list
15.62/5.17 */
15.62/5.17 public boolean equals(Object o) {
15.62/5.17 if (o == this)
15.62/5.17 return true;
15.62/5.17 if (!(o instanceof List))
15.62/5.17 return false;
15.62/5.17
15.62/5.17 ListIterator e1 = listIterator();
15.62/5.17 ListIterator e2 = ((List) o).listIterator();
15.62/5.17 while(e1.hasNext() && e2.hasNext()) {
15.62/5.17 E o1 = e1.next();
15.62/5.17 Object o2 = e2.next();
15.62/5.17 if (!(o1==null ? o2==null : o1.equals(o2)))
15.62/5.17 return false;
15.62/5.17 }
15.62/5.17 return !(e1.hasNext() || e2.hasNext());
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns the hash code value for this list.
15.62/5.17 *
15.62/5.17 * This implementation uses exactly the code that is used to define the
15.62/5.17 * list hash function in the documentation for the {@link List#hashCode}
15.62/5.17 * method.
15.62/5.17 *
15.62/5.17 * @return the hash code value for this list
15.62/5.17 */
15.62/5.17 public int hashCode() {
15.62/5.17 int hashCode = 1;
15.62/5.17 Iterator it = this.iterator();
15.62/5.17 while (it.hasNext()) {
15.62/5.17 E e = it.next();
15.62/5.17 hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());
15.62/5.17 }
15.62/5.17 return hashCode;
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Removes from this list all of the elements whose index is between
15.62/5.17 * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
15.62/5.17 * Shifts any succeeding elements to the left (reduces their index).
15.62/5.17 * This call shortens the list by {@code (toIndex - fromIndex)} elements.
15.62/5.17 * (If {@code toIndex==fromIndex}, this operation has no effect.)
15.62/5.17 *
15.62/5.17 * This method is called by the {@code clear} operation on this list
15.62/5.17 * and its subLists. Overriding this method to take advantage of
15.62/5.17 * the internals of the list implementation can substantially
15.62/5.17 * improve the performance of the {@code clear} operation on this list
15.62/5.17 * and its subLists.
15.62/5.17 *
15.62/5.17 *
This implementation gets a list iterator positioned before
15.62/5.17 * {@code fromIndex}, and repeatedly calls {@code ListIterator.next}
15.62/5.17 * followed by {@code ListIterator.remove} until the entire range has
15.62/5.17 * been removed. Note: if {@code ListIterator.remove} requires linear
15.62/5.17 * time, this implementation requires quadratic time.
15.62/5.17 *
15.62/5.17 * @param fromIndex index of first element to be removed
15.62/5.17 * @param toIndex index after last element to be removed
15.62/5.17 */
15.62/5.17 protected void removeRange(int fromIndex, int toIndex) {
15.62/5.17 ListIterator it = listIterator(fromIndex);
15.62/5.17 for (int i=0, n=toIndex-fromIndex; istructurally modified.
15.62/5.17 * Structural modifications are those that change the size of the
15.62/5.17 * list, or otherwise perturb it in such a fashion that iterations in
15.62/5.17 * progress may yield incorrect results.
15.62/5.17 *
15.62/5.17 * This field is used by the iterator and list iterator implementation
15.62/5.17 * returned by the {@code iterator} and {@code listIterator} methods.
15.62/5.17 * If the value of this field changes unexpectedly, the iterator (or list
15.62/5.17 * iterator) will throw a {@code ConcurrentModificationException} in
15.62/5.17 * response to the {@code next}, {@code remove}, {@code previous},
15.62/5.17 * {@code set} or {@code add} operations. This provides
15.62/5.17 * fail-fast behavior, rather than non-deterministic behavior in
15.62/5.17 * the face of concurrent modification during iteration.
15.62/5.17 *
15.62/5.17 *
Use of this field by subclasses is optional. If a subclass
15.62/5.17 * wishes to provide fail-fast iterators (and list iterators), then it
15.62/5.17 * merely has to increment this field in its {@code add(int, E)} and
15.62/5.17 * {@code remove(int)} methods (and any other methods that it overrides
15.62/5.17 * that result in structural modifications to the list). A single call to
15.62/5.17 * {@code add(int, E)} or {@code remove(int)} must add no more than
15.62/5.17 * one to this field, or the iterators (and list iterators) will throw
15.62/5.17 * bogus {@code ConcurrentModificationExceptions}. If an implementation
15.62/5.17 * does not wish to provide fail-fast iterators, this field may be
15.62/5.17 * ignored.
15.62/5.17 */
15.62/5.17 protected transient int modCount = 0;
15.62/5.17
15.62/5.17 private void rangeCheckForAdd(int index) {
15.62/5.17 if (index < 0 || index > size())
15.62/5.17 throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
15.62/5.17 }
15.62/5.17
15.62/5.17 private String outOfBoundsMsg(int index) {
15.62/5.17 return "";
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 class SubList extends AbstractList {
15.62/5.17 private final AbstractList l;
15.62/5.17 private final int offset;
15.62/5.17 private int size;
15.62/5.17
15.62/5.17 SubList(AbstractList list, int fromIndex, int toIndex) {
15.62/5.17 if (fromIndex < 0)
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 if (toIndex > list.size())
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 if (fromIndex > toIndex)
15.62/5.17 throw new IllegalArgumentException();
15.62/5.17 l = list;
15.62/5.17 offset = fromIndex;
15.62/5.17 size = toIndex - fromIndex;
15.62/5.17 this.modCount = l.modCount;
15.62/5.17 }
15.62/5.17
15.62/5.17 public E set(int index, E element) {
15.62/5.17 rangeCheck(index);
15.62/5.17 checkForComodification();
15.62/5.17 return l.set(index+offset, element);
15.62/5.17 }
15.62/5.17
15.62/5.17 public E get(int index) {
15.62/5.17 rangeCheck(index);
15.62/5.17 checkForComodification();
15.62/5.17 return l.get(index+offset);
15.62/5.17 }
15.62/5.17
15.62/5.17 public int size() {
15.62/5.17 checkForComodification();
15.62/5.17 return size;
15.62/5.17 }
15.62/5.17
15.62/5.17 public void add(int index, E element) {
15.62/5.17 rangeCheckForAdd(index);
15.62/5.17 checkForComodification();
15.62/5.17 l.add(index+offset, element);
15.62/5.17 this.modCount = l.modCount;
15.62/5.17 size++;
15.62/5.17 }
15.62/5.17
15.62/5.17 public E remove(int index) {
15.62/5.17 rangeCheck(index);
15.62/5.17 checkForComodification();
15.62/5.17 E result = l.remove(index+offset);
15.62/5.17 this.modCount = l.modCount;
15.62/5.17 size--;
15.62/5.17 return result;
15.62/5.17 }
15.62/5.17
15.62/5.17 protected void removeRange(int fromIndex, int toIndex) {
15.62/5.17 checkForComodification();
15.62/5.17 l.removeRange(fromIndex+offset, toIndex+offset);
15.62/5.17 this.modCount = l.modCount;
15.62/5.17 size -= (toIndex-fromIndex);
15.62/5.17 }
15.62/5.17
15.62/5.17 public boolean addAll(Collection c) {
15.62/5.17 return addAll(size, c);
15.62/5.17 }
15.62/5.17
15.62/5.17 public boolean addAll(int index, Collection c) {
15.62/5.17 rangeCheckForAdd(index);
15.62/5.17 int cSize = c.size();
15.62/5.17 if (cSize==0)
15.62/5.17 return false;
15.62/5.17
15.62/5.17 checkForComodification();
15.62/5.17 l.addAll(offset+index, c);
15.62/5.17 this.modCount = l.modCount;
15.62/5.17 size += cSize;
15.62/5.17 return true;
15.62/5.17 }
15.62/5.17
15.62/5.17 public Iterator iterator() {
15.62/5.17 return listIterator();
15.62/5.17 }
15.62/5.17
15.62/5.17 public ListIterator listIterator(final int index) {
15.62/5.17 checkForComodification();
15.62/5.17 rangeCheckForAdd(index);
15.62/5.17
15.62/5.17 return new ListIterator() {
15.62/5.17 private final ListIterator i = l.listIterator(index+offset);
15.62/5.17
15.62/5.17 public boolean hasNext() {
15.62/5.17 return nextIndex() < size;
15.62/5.17 }
15.62/5.17
15.62/5.17 public E next() {
15.62/5.17 if (hasNext())
15.62/5.17 return i.next();
15.62/5.17 else
15.62/5.17 throw new NoSuchElementException();
15.62/5.17 }
15.62/5.17
15.62/5.17 public boolean hasPrevious() {
15.62/5.17 return previousIndex() >= 0;
15.62/5.17 }
15.62/5.17
15.62/5.17 public E previous() {
15.62/5.17 if (hasPrevious())
15.62/5.17 return i.previous();
15.62/5.17 else
15.62/5.17 throw new NoSuchElementException();
15.62/5.17 }
15.62/5.17
15.62/5.17 public int nextIndex() {
15.62/5.17 return i.nextIndex() - offset;
15.62/5.17 }
15.62/5.17
15.62/5.17 public int previousIndex() {
15.62/5.17 return i.previousIndex() - offset;
15.62/5.17 }
15.62/5.17
15.62/5.17 public void remove() {
15.62/5.17 i.remove();
15.62/5.17 SubList.this.modCount = l.modCount;
15.62/5.17 size--;
15.62/5.17 }
15.62/5.17
15.62/5.17 public void set(E e) {
15.62/5.17 i.set(e);
15.62/5.17 }
15.62/5.17
15.62/5.17 public void add(E e) {
15.62/5.17 i.add(e);
15.62/5.17 SubList.this.modCount = l.modCount;
15.62/5.17 size++;
15.62/5.17 }
15.62/5.17 };
15.62/5.17 }
15.62/5.17
15.62/5.17 public List subList(int fromIndex, int toIndex) {
15.62/5.17 return new SubList(this, fromIndex, toIndex);
15.62/5.17 }
15.62/5.17
15.62/5.17 private void rangeCheck(int index) {
15.62/5.17 if (index < 0 || index >= size)
15.62/5.17 throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
15.62/5.17 }
15.62/5.17
15.62/5.17 private void rangeCheckForAdd(int index) {
15.62/5.17 if (index < 0 || index > size)
15.62/5.17 throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
15.62/5.17 }
15.62/5.17
15.62/5.17 private String outOfBoundsMsg(int index) {
15.62/5.17 return "";
15.62/5.17 }
15.62/5.17
15.62/5.17 private void checkForComodification() {
15.62/5.17 if (this.modCount != l.modCount)
15.62/5.17 throw new ConcurrentModificationException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 class RandomAccessSubList extends SubList implements RandomAccess {
15.62/5.17 RandomAccessSubList(AbstractList list, int fromIndex, int toIndex) {
15.62/5.17 super(list, fromIndex, toIndex);
15.62/5.17 }
15.62/5.17
15.62/5.17 public List subList(int fromIndex, int toIndex) {
15.62/5.17 return new RandomAccessSubList(this, fromIndex, toIndex);
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 /*
15.62/5.17 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.17 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.17 *
15.62/5.17 * This code is free software; you can redistribute it and/or modify it
15.62/5.17 * under the terms of the GNU General Public License version 2 only, as
15.62/5.17 * published by the Free Software Foundation. Sun designates this
15.62/5.17 * particular file as subject to the "Classpath" exception as provided
15.62/5.17 * by Sun in the LICENSE file that accompanied this code.
15.62/5.17 *
15.62/5.17 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.17 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.17 * accompanied this code).
15.62/5.17 *
15.62/5.17 * You should have received a copy of the GNU General Public License version
15.62/5.17 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.17 *
15.62/5.17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.17 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.17 * have any questions.
15.62/5.17 */
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * This class provides a skeletal implementation of the List
15.62/5.17 * interface to minimize the effort required to implement this interface
15.62/5.17 * backed by a "sequential access" data store (such as a linked list). For
15.62/5.17 * random access data (such as an array), AbstractList should be used
15.62/5.17 * in preference to this class.
15.62/5.17 *
15.62/5.17 * This class is the opposite of the AbstractList class in the sense
15.62/5.17 * that it implements the "random access" methods (get(int index),
15.62/5.17 * set(int index, E element), add(int index, E element) and
15.62/5.17 * remove(int index)) on top of the list's list iterator, instead of
15.62/5.17 * the other way around.
15.62/5.17 *
15.62/5.17 * To implement a list the programmer needs only to extend this class and
15.62/5.17 * provide implementations for the listIterator and size
15.62/5.17 * methods. For an unmodifiable list, the programmer need only implement the
15.62/5.17 * list iterator's hasNext, next, hasPrevious,
15.62/5.17 * previous and index methods.
15.62/5.17 *
15.62/5.17 * For a modifiable list the programmer should additionally implement the list
15.62/5.17 * iterator's set method. For a variable-size list the programmer
15.62/5.17 * should additionally implement the list iterator's remove and
15.62/5.17 * add methods.
15.62/5.17 *
15.62/5.17 * The programmer should generally provide a void (no argument) and collection
15.62/5.17 * constructor, as per the recommendation in the Collection interface
15.62/5.17 * specification.
15.62/5.17 *
15.62/5.17 * This class is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @author Josh Bloch
15.62/5.17 * @author Neal Gafter
15.62/5.17 * @see Collection
15.62/5.17 * @see List
15.62/5.17 * @see AbstractList
15.62/5.17 * @see AbstractCollection
15.62/5.17 * @since 1.2
15.62/5.17 */
15.62/5.17
15.62/5.17 public abstract class AbstractSequentialList extends AbstractList {
15.62/5.17 /**
15.62/5.17 * Sole constructor. (For invocation by subclass constructors, typically
15.62/5.17 * implicit.)
15.62/5.17 */
15.62/5.17 protected AbstractSequentialList() {
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns the element at the specified position in this list.
15.62/5.17 *
15.62/5.17 * This implementation first gets a list iterator pointing to the
15.62/5.17 * indexed element (with listIterator(index)). Then, it gets
15.62/5.17 * the element using ListIterator.next and returns it.
15.62/5.17 *
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public E get(int index) {
15.62/5.17 try {
15.62/5.17 return listIterator(index).next();
15.62/5.17 } catch (NoSuchElementException exc) {
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Replaces the element at the specified position in this list with the
15.62/5.17 * specified element (optional operation).
15.62/5.17 *
15.62/5.17 *
This implementation first gets a list iterator pointing to the
15.62/5.17 * indexed element (with listIterator(index)). Then, it gets
15.62/5.17 * the current element using ListIterator.next and replaces it
15.62/5.17 * with ListIterator.set.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the list iterator does not
15.62/5.17 * implement the set operation.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public E set(int index, E element) {
15.62/5.17 try {
15.62/5.17 ListIterator e = listIterator(index);
15.62/5.17 E oldVal = e.next();
15.62/5.17 e.set(element);
15.62/5.17 return oldVal;
15.62/5.17 } catch (NoSuchElementException exc) {
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Inserts the specified element at the specified position in this list
15.62/5.17 * (optional operation). Shifts the element currently at that position
15.62/5.17 * (if any) and any subsequent elements to the right (adds one to their
15.62/5.17 * indices).
15.62/5.17 *
15.62/5.17 * This implementation first gets a list iterator pointing to the
15.62/5.17 * indexed element (with listIterator(index)). Then, it
15.62/5.17 * inserts the specified element with ListIterator.add.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the list iterator does not
15.62/5.17 * implement the add operation.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public void add(int index, E element) {
15.62/5.17 try {
15.62/5.17 listIterator(index).add(element);
15.62/5.17 } catch (NoSuchElementException exc) {
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Removes the element at the specified position in this list (optional
15.62/5.17 * operation). Shifts any subsequent elements to the left (subtracts one
15.62/5.17 * from their indices). Returns the element that was removed from the
15.62/5.17 * list.
15.62/5.17 *
15.62/5.17 *
This implementation first gets a list iterator pointing to the
15.62/5.17 * indexed element (with listIterator(index)). Then, it removes
15.62/5.17 * the element with ListIterator.remove.
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the list iterator does not
15.62/5.17 * implement the remove operation.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public E remove(int index) {
15.62/5.17 try {
15.62/5.17 ListIterator e = listIterator(index);
15.62/5.17 E outCast = e.next();
15.62/5.17 e.remove();
15.62/5.17 return outCast;
15.62/5.17 } catch (NoSuchElementException exc) {
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // Bulk Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Inserts all of the elements in the specified collection into this
15.62/5.17 * list at the specified position (optional operation). Shifts the
15.62/5.17 * element currently at that position (if any) and any subsequent
15.62/5.17 * elements to the right (increases their indices). The new elements
15.62/5.17 * will appear in this list in the order that they are returned by the
15.62/5.17 * specified collection's iterator. The behavior of this operation is
15.62/5.17 * undefined if the specified collection is modified while the
15.62/5.17 * operation is in progress. (Note that this will occur if the specified
15.62/5.17 * collection is this list, and it's nonempty.)
15.62/5.17 *
15.62/5.17 * This implementation gets an iterator over the specified collection and
15.62/5.17 * a list iterator over this list pointing to the indexed element (with
15.62/5.17 * listIterator(index)). Then, it iterates over the specified
15.62/5.17 * collection, inserting the elements obtained from the iterator into this
15.62/5.17 * list, one at a time, using ListIterator.add followed by
15.62/5.17 * ListIterator.next (to skip over the added element).
15.62/5.17 *
15.62/5.17 *
Note that this implementation will throw an
15.62/5.17 * UnsupportedOperationException if the list iterator returned by
15.62/5.17 * the listIterator method does not implement the add
15.62/5.17 * operation.
15.62/5.17 *
15.62/5.17 * @throws UnsupportedOperationException {@inheritDoc}
15.62/5.17 * @throws ClassCastException {@inheritDoc}
15.62/5.17 * @throws NullPointerException {@inheritDoc}
15.62/5.17 * @throws IllegalArgumentException {@inheritDoc}
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public boolean addAll(int index, Collection c) {
15.62/5.17 try {
15.62/5.17 boolean modified = false;
15.62/5.17 ListIterator e1 = listIterator(index);
15.62/5.17 Iterator e2 = c.iterator();
15.62/5.17 while (e2.hasNext()) {
15.62/5.17 e1.add(e2.next());
15.62/5.17 modified = true;
15.62/5.17 }
15.62/5.17 return modified;
15.62/5.17 } catch (NoSuchElementException exc) {
15.62/5.17 throw new IndexOutOfBoundsException();
15.62/5.17 }
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 // Iterators
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns an iterator over the elements in this list (in proper
15.62/5.17 * sequence).
15.62/5.17 *
15.62/5.17 * This implementation merely returns a list iterator over the list.
15.62/5.17 *
15.62/5.17 * @return an iterator over the elements in this list (in proper sequence)
15.62/5.17 */
15.62/5.17 public Iterator iterator() {
15.62/5.17 return listIterator();
15.62/5.17 }
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns a list iterator over the elements in this list (in proper
15.62/5.17 * sequence).
15.62/5.17 *
15.62/5.17 * @param index index of first element to be returned from the list
15.62/5.17 * iterator (by a call to the next method)
15.62/5.17 * @return a list iterator over the elements in this list (in proper
15.62/5.17 * sequence)
15.62/5.17 * @throws IndexOutOfBoundsException {@inheritDoc}
15.62/5.17 */
15.62/5.17 public abstract ListIterator listIterator(int index);
15.62/5.17 }
15.62/5.17
15.62/5.17
15.62/5.17 /*
15.62/5.17 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.17 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.17 *
15.62/5.17 * This code is free software; you can redistribute it and/or modify it
15.62/5.17 * under the terms of the GNU General Public License version 2 only, as
15.62/5.17 * published by the Free Software Foundation. Sun designates this
15.62/5.17 * particular file as subject to the "Classpath" exception as provided
15.62/5.17 * by Sun in the LICENSE file that accompanied this code.
15.62/5.17 *
15.62/5.17 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.17 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.17 * accompanied this code).
15.62/5.17 *
15.62/5.17 * You should have received a copy of the GNU General Public License version
15.62/5.17 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.17 *
15.62/5.17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.17 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.17 * have any questions.
15.62/5.17 */
15.62/5.17
15.62/5.17 package javaUtilEx;
15.62/5.17
15.62/5.17 /**
15.62/5.17 * The root interface in the collection hierarchy. A collection
15.62/5.17 * represents a group of objects, known as its elements. Some
15.62/5.17 * collections allow duplicate elements and others do not. Some are ordered
15.62/5.17 * and others unordered. The JDK does not provide any direct
15.62/5.17 * implementations of this interface: it provides implementations of more
15.62/5.17 * specific subinterfaces like Set and List. This interface
15.62/5.17 * is typically used to pass collections around and manipulate them where
15.62/5.17 * maximum generality is desired.
15.62/5.17 *
15.62/5.17 * Bags or multisets (unordered collections that may contain
15.62/5.17 * duplicate elements) should implement this interface directly.
15.62/5.17 *
15.62/5.17 *
All general-purpose Collection implementation classes (which
15.62/5.17 * typically implement Collection indirectly through one of its
15.62/5.17 * subinterfaces) should provide two "standard" constructors: a void (no
15.62/5.17 * arguments) constructor, which creates an empty collection, and a
15.62/5.17 * constructor with a single argument of type Collection, which
15.62/5.17 * creates a new collection with the same elements as its argument. In
15.62/5.17 * effect, the latter constructor allows the user to copy any collection,
15.62/5.17 * producing an equivalent collection of the desired implementation type.
15.62/5.17 * There is no way to enforce this convention (as interfaces cannot contain
15.62/5.17 * constructors) but all of the general-purpose Collection
15.62/5.17 * implementations in the Java platform libraries comply.
15.62/5.17 *
15.62/5.17 *
The "destructive" methods contained in this interface, that is, the
15.62/5.17 * methods that modify the collection on which they operate, are specified to
15.62/5.17 * throw UnsupportedOperationException if this collection does not
15.62/5.17 * support the operation. If this is the case, these methods may, but are not
15.62/5.17 * required to, throw an UnsupportedOperationException if the
15.62/5.17 * invocation would have no effect on the collection. For example, invoking
15.62/5.17 * the {@link #addAll(Collection)} method on an unmodifiable collection may,
15.62/5.17 * but is not required to, throw the exception if the collection to be added
15.62/5.17 * is empty.
15.62/5.17 *
15.62/5.17 *
Some collection implementations have restrictions on the elements that
15.62/5.17 * they may contain. For example, some implementations prohibit null elements,
15.62/5.17 * and some have restrictions on the types of their elements. Attempting to
15.62/5.17 * add an ineligible element throws an unchecked exception, typically
15.62/5.17 * NullPointerException or ClassCastException. Attempting
15.62/5.17 * to query the presence of an ineligible element may throw an exception,
15.62/5.17 * or it may simply return false; some implementations will exhibit the former
15.62/5.17 * behavior and some will exhibit the latter. More generally, attempting an
15.62/5.17 * operation on an ineligible element whose completion would not result in
15.62/5.17 * the insertion of an ineligible element into the collection may throw an
15.62/5.17 * exception or it may succeed, at the option of the implementation.
15.62/5.17 * Such exceptions are marked as "optional" in the specification for this
15.62/5.17 * interface.
15.62/5.17 *
15.62/5.17 *
It is up to each collection to determine its own synchronization
15.62/5.17 * policy. In the absence of a stronger guarantee by the
15.62/5.17 * implementation, undefined behavior may result from the invocation
15.62/5.17 * of any method on a collection that is being mutated by another
15.62/5.17 * thread; this includes direct invocations, passing the collection to
15.62/5.17 * a method that might perform invocations, and using an existing
15.62/5.17 * iterator to examine the collection.
15.62/5.17 *
15.62/5.17 *
Many methods in Collections Framework interfaces are defined in
15.62/5.17 * terms of the {@link Object#equals(Object) equals} method. For example,
15.62/5.17 * the specification for the {@link #contains(Object) contains(Object o)}
15.62/5.17 * method says: "returns true if and only if this collection
15.62/5.17 * contains at least one element e such that
15.62/5.17 * (o==null ? e==null : o.equals(e))." This specification should
15.62/5.17 * not be construed to imply that invoking Collection.contains
15.62/5.17 * with a non-null argument o will cause o.equals(e) to be
15.62/5.17 * invoked for any element e. Implementations are free to implement
15.62/5.17 * optimizations whereby the equals invocation is avoided, for
15.62/5.17 * example, by first comparing the hash codes of the two elements. (The
15.62/5.17 * {@link Object#hashCode()} specification guarantees that two objects with
15.62/5.17 * unequal hash codes cannot be equal.) More generally, implementations of
15.62/5.17 * the various Collections Framework interfaces are free to take advantage of
15.62/5.17 * the specified behavior of underlying {@link Object} methods wherever the
15.62/5.17 * implementor deems it appropriate.
15.62/5.17 *
15.62/5.17 *
This interface is a member of the
15.62/5.17 *
15.62/5.17 * Java Collections Framework.
15.62/5.17 *
15.62/5.17 * @author Josh Bloch
15.62/5.17 * @author Neal Gafter
15.62/5.17 * @see Set
15.62/5.17 * @see List
15.62/5.17 * @see Map
15.62/5.17 * @see SortedSet
15.62/5.17 * @see SortedMap
15.62/5.17 * @see HashSet
15.62/5.17 * @see TreeSet
15.62/5.17 * @see ArrayList
15.62/5.17 * @see LinkedList
15.62/5.17 * @see Vector
15.62/5.17 * @see Collections
15.62/5.17 * @see Arrays
15.62/5.17 * @see AbstractCollection
15.62/5.17 * @since 1.2
15.62/5.17 */
15.62/5.17
15.62/5.17 public interface Collection {
15.62/5.17 // Query Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns the number of elements in this collection. If this collection
15.62/5.17 * contains more than Integer.MAX_VALUE elements, returns
15.62/5.17 * Integer.MAX_VALUE.
15.62/5.17 *
15.62/5.17 * @return the number of elements in this collection
15.62/5.17 */
15.62/5.17 int size();
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns true if this collection contains no elements.
15.62/5.17 *
15.62/5.17 * @return true if this collection contains no elements
15.62/5.17 */
15.62/5.17 boolean isEmpty();
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns true if this collection contains the specified element.
15.62/5.17 * More formally, returns true if and only if this collection
15.62/5.17 * contains at least one element e such that
15.62/5.17 * (o==null ? e==null : o.equals(e)).
15.62/5.17 *
15.62/5.17 * @param o element whose presence in this collection is to be tested
15.62/5.17 * @return true if this collection contains the specified
15.62/5.17 * element
15.62/5.17 * @throws ClassCastException if the type of the specified element
15.62/5.17 * is incompatible with this collection (optional)
15.62/5.17 * @throws NullPointerException if the specified element is null and this
15.62/5.17 * collection does not permit null elements (optional)
15.62/5.17 */
15.62/5.17 boolean contains(Object o);
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns an iterator over the elements in this collection. There are no
15.62/5.17 * guarantees concerning the order in which the elements are returned
15.62/5.17 * (unless this collection is an instance of some class that provides a
15.62/5.17 * guarantee).
15.62/5.17 *
15.62/5.17 * @return an Iterator over the elements in this collection
15.62/5.17 */
15.62/5.17 Iterator iterator();
15.62/5.17
15.62/5.17 // Modification Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Ensures that this collection contains the specified element (optional
15.62/5.17 * operation). Returns true if this collection changed as a
15.62/5.17 * result of the call. (Returns false if this collection does
15.62/5.17 * not permit duplicates and already contains the specified element.)
15.62/5.17 *
15.62/5.17 * Collections that support this operation may place limitations on what
15.62/5.17 * elements may be added to this collection. In particular, some
15.62/5.17 * collections will refuse to add null elements, and others will
15.62/5.17 * impose restrictions on the type of elements that may be added.
15.62/5.17 * Collection classes should clearly specify in their documentation any
15.62/5.17 * restrictions on what elements may be added.
15.62/5.17 *
15.62/5.17 * If a collection refuses to add a particular element for any reason
15.62/5.17 * other than that it already contains the element, it must throw
15.62/5.17 * an exception (rather than returning false). This preserves
15.62/5.17 * the invariant that a collection always contains the specified element
15.62/5.17 * after this call returns.
15.62/5.17 *
15.62/5.17 * @param e element whose presence in this collection is to be ensured
15.62/5.17 * @return true if this collection changed as a result of the
15.62/5.17 * call
15.62/5.17 * @throws UnsupportedOperationException if the add operation
15.62/5.17 * is not supported by this collection
15.62/5.17 * @throws ClassCastException if the class of the specified element
15.62/5.17 * prevents it from being added to this collection
15.62/5.17 * @throws NullPointerException if the specified element is null and this
15.62/5.17 * collection does not permit null elements
15.62/5.17 * @throws IllegalArgumentException if some property of the element
15.62/5.17 * prevents it from being added to this collection
15.62/5.17 * @throws IllegalStateException if the element cannot be added at this
15.62/5.17 * time due to insertion restrictions
15.62/5.17 */
15.62/5.17 boolean add(E e);
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Removes a single instance of the specified element from this
15.62/5.17 * collection, if it is present (optional operation). More formally,
15.62/5.17 * removes an element e such that
15.62/5.17 * (o==null ? e==null : o.equals(e)), if
15.62/5.17 * this collection contains one or more such elements. Returns
15.62/5.17 * true if this collection contained the specified element (or
15.62/5.17 * equivalently, if this collection changed as a result of the call).
15.62/5.17 *
15.62/5.17 * @param o element to be removed from this collection, if present
15.62/5.17 * @return true if an element was removed as a result of this call
15.62/5.17 * @throws ClassCastException if the type of the specified element
15.62/5.17 * is incompatible with this collection (optional)
15.62/5.17 * @throws NullPointerException if the specified element is null and this
15.62/5.17 * collection does not permit null elements (optional)
15.62/5.17 * @throws UnsupportedOperationException if the remove operation
15.62/5.17 * is not supported by this collection
15.62/5.17 */
15.62/5.17 boolean remove(Object o);
15.62/5.17
15.62/5.17
15.62/5.17 // Bulk Operations
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Returns true if this collection contains all of the elements
15.62/5.17 * in the specified collection.
15.62/5.17 *
15.62/5.17 * @param c collection to be checked for containment in this collection
15.62/5.17 * @return true if this collection contains all of the elements
15.62/5.17 * in the specified collection
15.62/5.17 * @throws ClassCastException if the types of one or more elements
15.62/5.17 * in the specified collection are incompatible with this
15.62/5.17 * collection (optional)
15.62/5.17 * @throws NullPointerException if the specified collection contains one
15.62/5.17 * or more null elements and this collection does not permit null
15.62/5.17 * elements (optional), or if the specified collection is null
15.62/5.17 * @see #contains(Object)
15.62/5.17 */
15.62/5.17 boolean containsAll(Collection c);
15.62/5.17
15.62/5.17 /**
15.62/5.17 * Adds all of the elements in the specified collection to this collection
15.62/5.17 * (optional operation). The behavior of this operation is undefined if
15.62/5.17 * the specified collection is modified while the operation is in progress.
15.62/5.17 * (This implies that the behavior of this call is undefined if the
15.62/5.17 * specified collection is this collection, and this collection is
15.62/5.17 * nonempty.)
15.62/5.17 *
15.62/5.17 * @param c collection containing elements to be added to this collection
15.62/5.17 * @return true if this collection changed as a result of the call
15.62/5.17 * @throws UnsupportedOperationException if the addAll operation
15.62/5.17 * is not supported by this collection
15.62/5.17 * @throws ClassCastException if the class of an element of the specified
15.62/5.17 * collection prevents it from being added to this collection
15.62/5.17 * @throws NullPointerException if the specified collection contains a
15.62/5.17 * null element and this collection does not permit null elements,
15.62/5.17 * or if the specified collection is null
15.62/5.17 * @throws IllegalArgumentException if some property of an element of the
15.62/5.17 * specified collection prevents it from being added to this
15.62/5.17 * collection
15.62/5.17 * @throws IllegalStateException if not all the elements can be added at
15.62/5.18 * this time due to insertion restrictions
15.62/5.18 * @see #add(Object)
15.62/5.18 */
15.62/5.18 boolean addAll(Collection c);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Removes all of this collection's elements that are also contained in the
15.62/5.18 * specified collection (optional operation). After this call returns,
15.62/5.18 * this collection will contain no elements in common with the specified
15.62/5.18 * collection.
15.62/5.18 *
15.62/5.18 * @param c collection containing elements to be removed from this collection
15.62/5.18 * @return true if this collection changed as a result of the
15.62/5.18 * call
15.62/5.18 * @throws UnsupportedOperationException if the removeAll method
15.62/5.18 * is not supported by this collection
15.62/5.18 * @throws ClassCastException if the types of one or more elements
15.62/5.18 * in this collection are incompatible with the specified
15.62/5.18 * collection (optional)
15.62/5.18 * @throws NullPointerException if this collection contains one or more
15.62/5.18 * null elements and the specified collection does not support
15.62/5.18 * null elements (optional), or if the specified collection is null
15.62/5.18 * @see #remove(Object)
15.62/5.18 * @see #contains(Object)
15.62/5.18 */
15.62/5.18 boolean removeAll(Collection c);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retains only the elements in this collection that are contained in the
15.62/5.18 * specified collection (optional operation). In other words, removes from
15.62/5.18 * this collection all of its elements that are not contained in the
15.62/5.18 * specified collection.
15.62/5.18 *
15.62/5.18 * @param c collection containing elements to be retained in this collection
15.62/5.18 * @return true if this collection changed as a result of the call
15.62/5.18 * @throws UnsupportedOperationException if the retainAll operation
15.62/5.18 * is not supported by this collection
15.62/5.18 * @throws ClassCastException if the types of one or more elements
15.62/5.18 * in this collection are incompatible with the specified
15.62/5.18 * collection (optional)
15.62/5.18 * @throws NullPointerException if this collection contains one or more
15.62/5.18 * null elements and the specified collection does not permit null
15.62/5.18 * elements (optional), or if the specified collection is null
15.62/5.18 * @see #remove(Object)
15.62/5.18 * @see #contains(Object)
15.62/5.18 */
15.62/5.18 boolean retainAll(Collection c);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Removes all of the elements from this collection (optional operation).
15.62/5.18 * The collection will be empty after this method returns.
15.62/5.18 *
15.62/5.18 * @throws UnsupportedOperationException if the clear operation
15.62/5.18 * is not supported by this collection
15.62/5.18 */
15.62/5.18 void clear();
15.62/5.18
15.62/5.18
15.62/5.18 // Comparison and hashing
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Compares the specified object with this collection for equality.
15.62/5.18 *
15.62/5.18 * While the Collection interface adds no stipulations to the
15.62/5.18 * general contract for the Object.equals, programmers who
15.62/5.18 * implement the Collection interface "directly" (in other words,
15.62/5.18 * create a class that is a Collection but is not a Set
15.62/5.18 * or a List) must exercise care if they choose to override the
15.62/5.18 * Object.equals. It is not necessary to do so, and the simplest
15.62/5.18 * course of action is to rely on Object's implementation, but
15.62/5.18 * the implementor may wish to implement a "value comparison" in place of
15.62/5.18 * the default "reference comparison." (The List and
15.62/5.18 * Set interfaces mandate such value comparisons.)
15.62/5.18 *
15.62/5.18 * The general contract for the Object.equals method states that
15.62/5.18 * equals must be symmetric (in other words, a.equals(b) if and
15.62/5.18 * only if b.equals(a)). The contracts for List.equals
15.62/5.18 * and Set.equals state that lists are only equal to other lists,
15.62/5.18 * and sets to other sets. Thus, a custom equals method for a
15.62/5.18 * collection class that implements neither the List nor
15.62/5.18 * Set interface must return false when this collection
15.62/5.18 * is compared to any list or set. (By the same logic, it is not possible
15.62/5.18 * to write a class that correctly implements both the Set and
15.62/5.18 * List interfaces.)
15.62/5.18 *
15.62/5.18 * @param o object to be compared for equality with this collection
15.62/5.18 * @return true if the specified object is equal to this
15.62/5.18 * collection
15.62/5.18 *
15.62/5.18 * @see Object#equals(Object)
15.62/5.18 * @see Set#equals(Object)
15.62/5.18 * @see List#equals(Object)
15.62/5.18 */
15.62/5.18 boolean equals(Object o);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Returns the hash code value for this collection. While the
15.62/5.18 * Collection interface adds no stipulations to the general
15.62/5.18 * contract for the Object.hashCode method, programmers should
15.62/5.18 * take note that any class that overrides the Object.equals
15.62/5.18 * method must also override the Object.hashCode method in order
15.62/5.18 * to satisfy the general contract for the Object.hashCodemethod.
15.62/5.18 * In particular, c1.equals(c2) implies that
15.62/5.18 * c1.hashCode()==c2.hashCode().
15.62/5.18 *
15.62/5.18 * @return the hash code value for this collection
15.62/5.18 *
15.62/5.18 * @see Object#hashCode()
15.62/5.18 * @see Object#equals(Object)
15.62/5.18 */
15.62/5.18 int hashCode();
15.62/5.18 }
15.62/5.18
15.62/5.18
15.62/5.18 /*
15.62/5.18 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.18 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.18 *
15.62/5.18 * This code is free software; you can redistribute it and/or modify it
15.62/5.18 * under the terms of the GNU General Public License version 2 only, as
15.62/5.18 * published by the Free Software Foundation. Sun designates this
15.62/5.18 * particular file as subject to the "Classpath" exception as provided
15.62/5.18 * by Sun in the LICENSE file that accompanied this code.
15.62/5.18 *
15.62/5.18 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.18 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.18 * accompanied this code).
15.62/5.18 *
15.62/5.18 * You should have received a copy of the GNU General Public License version
15.62/5.18 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.18 *
15.62/5.18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.18 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.18 * have any questions.
15.62/5.18 */
15.62/5.18
15.62/5.18 package javaUtilEx;
15.62/5.18
15.62/5.18 /**
15.62/5.18 * This exception may be thrown by methods that have detected concurrent
15.62/5.18 * modification of an object when such modification is not permissible.
15.62/5.18 *
15.62/5.18 * For example, it is not generally permissible for one thread to modify a Collection
15.62/5.18 * while another thread is iterating over it. In general, the results of the
15.62/5.18 * iteration are undefined under these circumstances. Some Iterator
15.62/5.18 * implementations (including those of all the general purpose collection implementations
15.62/5.18 * provided by the JRE) may choose to throw this exception if this behavior is
15.62/5.18 * detected. Iterators that do this are known as fail-fast iterators,
15.62/5.18 * as they fail quickly and cleanly, rather that risking arbitrary,
15.62/5.18 * non-deterministic behavior at an undetermined time in the future.
15.62/5.18 *
15.62/5.18 * Note that this exception does not always indicate that an object has
15.62/5.18 * been concurrently modified by a different thread. If a single
15.62/5.18 * thread issues a sequence of method invocations that violates the
15.62/5.18 * contract of an object, the object may throw this exception. For
15.62/5.18 * example, if a thread modifies a collection directly while it is
15.62/5.18 * iterating over the collection with a fail-fast iterator, the iterator
15.62/5.18 * will throw this exception.
15.62/5.18 *
15.62/5.18 *
Note that fail-fast behavior cannot be guaranteed as it is, generally
15.62/5.18 * speaking, impossible to make any hard guarantees in the presence of
15.62/5.18 * unsynchronized concurrent modification. Fail-fast operations
15.62/5.18 * throw ConcurrentModificationException on a best-effort basis.
15.62/5.18 * Therefore, it would be wrong to write a program that depended on this
15.62/5.18 * exception for its correctness: ConcurrentModificationException
15.62/5.18 * should be used only to detect bugs.
15.62/5.18 *
15.62/5.18 * @author Josh Bloch
15.62/5.18 * @see Collection
15.62/5.18 * @see Iterator
15.62/5.18 * @see ListIterator
15.62/5.18 * @see Vector
15.62/5.18 * @see LinkedList
15.62/5.18 * @see HashSet
15.62/5.18 * @see Hashtable
15.62/5.18 * @see TreeMap
15.62/5.18 * @see AbstractList
15.62/5.18 * @since 1.2
15.62/5.18 */
15.62/5.18 public class ConcurrentModificationException extends RuntimeException {
15.62/5.18 /**
15.62/5.18 * Constructs a ConcurrentModificationException with no
15.62/5.18 * detail message.
15.62/5.18 */
15.62/5.18 public ConcurrentModificationException() {
15.62/5.18 }
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Constructs a ConcurrentModificationException with the
15.62/5.18 * specified detail message.
15.62/5.18 *
15.62/5.18 * @param message the detail message pertaining to this exception.
15.62/5.18 */
15.62/5.18 public ConcurrentModificationException(String message) {
15.62/5.18 super(message);
15.62/5.18 }
15.62/5.18 }
15.62/5.18
15.62/5.18
15.62/5.18 /*
15.62/5.18 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.18 *
15.62/5.18 * This code is free software; you can redistribute it and/or modify it
15.62/5.18 * under the terms of the GNU General Public License version 2 only, as
15.62/5.18 * published by the Free Software Foundation. Sun designates this
15.62/5.18 * particular file as subject to the "Classpath" exception as provided
15.62/5.18 * by Sun in the LICENSE file that accompanied this code.
15.62/5.18 *
15.62/5.18 * This code is distributed in the hope that it will be useful, but WITHOUT
15.62/5.18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.62/5.18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.62/5.18 * version 2 for more details (a copy is included in the LICENSE file that
15.62/5.18 * accompanied this code).
15.62/5.18 *
15.62/5.18 * You should have received a copy of the GNU General Public License version
15.62/5.18 * 2 along with this work; if not, write to the Free Software Foundation,
15.62/5.18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.62/5.18 *
15.62/5.18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.62/5.18 * CA 95054 USA or visit www.sun.com if you need additional information or
15.62/5.18 * have any questions.
15.62/5.18 */
15.62/5.18
15.62/5.18 /*
15.62/5.18 * This file is available under and governed by the GNU General Public
15.62/5.18 * License version 2 only, as published by the Free Software Foundation.
15.62/5.18 * However, the following notice accompanied the original version of this
15.62/5.18 * file:
15.62/5.18 *
15.62/5.18 * Written by Doug Lea and Josh Bloch with assistance from members of
15.62/5.18 * JCP JSR-166 Expert Group and released to the public domain, as explained
15.62/5.18 * at http://creativecommons.org/licenses/publicdomain
15.62/5.18 */
15.62/5.18
15.62/5.18 package javaUtilEx;
15.62/5.18
15.62/5.18 /**
15.62/5.18 * A linear collection that supports element insertion and removal at
15.62/5.18 * both ends. The name deque is short for "double ended queue"
15.62/5.18 * and is usually pronounced "deck". Most Deque
15.62/5.18 * implementations place no fixed limits on the number of elements
15.62/5.18 * they may contain, but this interface supports capacity-restricted
15.62/5.18 * deques as well as those with no fixed size limit.
15.62/5.18 *
15.62/5.18 *
This interface defines methods to access the elements at both
15.62/5.18 * ends of the deque. Methods are provided to insert, remove, and
15.62/5.18 * examine the element. Each of these methods exists in two forms:
15.62/5.18 * one throws an exception if the operation fails, the other returns a
15.62/5.18 * special value (either null or false, depending on
15.62/5.18 * the operation). The latter form of the insert operation is
15.62/5.18 * designed specifically for use with capacity-restricted
15.62/5.18 * Deque implementations; in most implementations, insert
15.62/5.18 * operations cannot fail.
15.62/5.18 *
15.62/5.18 *
The twelve methods described above are summarized in the
15.62/5.18 * following table:
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * |
15.62/5.18 * First Element (Head) |
15.62/5.18 * Last Element (Tail) |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * |
15.62/5.18 * Throws exception |
15.62/5.18 * Special value |
15.62/5.18 * Throws exception |
15.62/5.18 * Special value |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | Insert |
15.62/5.18 * {@link #addFirst addFirst(e)} |
15.62/5.18 * {@link #offerFirst offerFirst(e)} |
15.62/5.18 * {@link #addLast addLast(e)} |
15.62/5.18 * {@link #offerLast offerLast(e)} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | Remove |
15.62/5.18 * {@link #removeFirst removeFirst()} |
15.62/5.18 * {@link #pollFirst pollFirst()} |
15.62/5.18 * {@link #removeLast removeLast()} |
15.62/5.18 * {@link #pollLast pollLast()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | Examine |
15.62/5.18 * {@link #getFirst getFirst()} |
15.62/5.18 * {@link #peekFirst peekFirst()} |
15.62/5.18 * {@link #getLast getLast()} |
15.62/5.18 * {@link #peekLast peekLast()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * This interface extends the {@link Queue} interface. When a deque is
15.62/5.18 * used as a queue, FIFO (First-In-First-Out) behavior results. Elements are
15.62/5.18 * added at the end of the deque and removed from the beginning. The methods
15.62/5.18 * inherited from the Queue interface are precisely equivalent to
15.62/5.18 * Deque methods as indicated in the following table:
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | Queue Method |
15.62/5.18 * Equivalent Deque Method |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link java.util.Queue#add add(e)} |
15.62/5.18 * {@link #addLast addLast(e)} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link java.util.Queue#offer offer(e)} |
15.62/5.18 * {@link #offerLast offerLast(e)} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link java.util.Queue#remove remove()} |
15.62/5.18 * {@link #removeFirst removeFirst()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link java.util.Queue#poll poll()} |
15.62/5.18 * {@link #pollFirst pollFirst()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link java.util.Queue#element element()} |
15.62/5.18 * {@link #getFirst getFirst()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link java.util.Queue#peek peek()} |
15.62/5.18 * {@link #peek peekFirst()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * Deques can also be used as LIFO (Last-In-First-Out) stacks. This
15.62/5.18 * interface should be used in preference to the legacy {@link Stack} class.
15.62/5.18 * When a deque is used as a stack, elements are pushed and popped from the
15.62/5.18 * beginning of the deque. Stack methods are precisely equivalent to
15.62/5.18 * Deque methods as indicated in the table below:
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | Stack Method |
15.62/5.18 * Equivalent Deque Method |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link #push push(e)} |
15.62/5.18 * {@link #addFirst addFirst(e)} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link #pop pop()} |
15.62/5.18 * {@link #removeFirst removeFirst()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * | {@link #peek peek()} |
15.62/5.18 * {@link #peekFirst peekFirst()} |
15.62/5.18 *
15.62/5.18 *
15.62/5.18 *
15.62/5.18 * Note that the {@link #peek peek} method works equally well when
15.62/5.18 * a deque is used as a queue or a stack; in either case, elements are
15.62/5.18 * drawn from the beginning of the deque.
15.62/5.18 *
15.62/5.18 *
This interface provides two methods to remove interior
15.62/5.18 * elements, {@link #removeFirstOccurrence removeFirstOccurrence} and
15.62/5.18 * {@link #removeLastOccurrence removeLastOccurrence}.
15.62/5.18 *
15.62/5.18 *
Unlike the {@link List} interface, this interface does not
15.62/5.18 * provide support for indexed access to elements.
15.62/5.18 *
15.62/5.18 *
While Deque implementations are not strictly required
15.62/5.18 * to prohibit the insertion of null elements, they are strongly
15.62/5.18 * encouraged to do so. Users of any Deque implementations
15.62/5.18 * that do allow null elements are strongly encouraged not to
15.62/5.18 * take advantage of the ability to insert nulls. This is so because
15.62/5.18 * null is used as a special return value by various methods
15.62/5.18 * to indicated that the deque is empty.
15.62/5.18 *
15.62/5.18 *
Deque implementations generally do not define
15.62/5.18 * element-based versions of the equals and hashCode
15.62/5.18 * methods, but instead inherit the identity-based versions from class
15.62/5.18 * Object.
15.62/5.18 *
15.62/5.18 *
This interface is a member of the Java Collections
15.62/5.18 * Framework.
15.62/5.18 *
15.62/5.18 * @author Doug Lea
15.62/5.18 * @author Josh Bloch
15.62/5.18 * @since 1.6
15.62/5.18 * @param the type of elements held in this collection
15.62/5.18 */
15.62/5.18
15.62/5.18 public interface Deque extends Queue {
15.62/5.18 /**
15.62/5.18 * Inserts the specified element at the front of this deque if it is
15.62/5.18 * possible to do so immediately without violating capacity restrictions.
15.62/5.18 * When using a capacity-restricted deque, it is generally preferable to
15.62/5.18 * use method {@link #offerFirst}.
15.62/5.18 *
15.62/5.18 * @param e the element to add
15.62/5.18 * @throws IllegalStateException if the element cannot be added at this
15.62/5.18 * time due to capacity restrictions
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 void addFirst(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Inserts the specified element at the end of this deque if it is
15.62/5.18 * possible to do so immediately without violating capacity restrictions.
15.62/5.18 * When using a capacity-restricted deque, it is generally preferable to
15.62/5.18 * use method {@link #offerLast}.
15.62/5.18 *
15.62/5.18 * This method is equivalent to {@link #add}.
15.62/5.18 *
15.62/5.18 * @param e the element to add
15.62/5.18 * @throws IllegalStateException if the element cannot be added at this
15.62/5.18 * time due to capacity restrictions
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 void addLast(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Inserts the specified element at the front of this deque unless it would
15.62/5.18 * violate capacity restrictions. When using a capacity-restricted deque,
15.62/5.18 * this method is generally preferable to the {@link #addFirst} method,
15.62/5.18 * which can fail to insert an element only by throwing an exception.
15.62/5.18 *
15.62/5.18 * @param e the element to add
15.62/5.18 * @return true if the element was added to this deque, else
15.62/5.18 * false
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 boolean offerFirst(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Inserts the specified element at the end of this deque unless it would
15.62/5.18 * violate capacity restrictions. When using a capacity-restricted deque,
15.62/5.18 * this method is generally preferable to the {@link #addLast} method,
15.62/5.18 * which can fail to insert an element only by throwing an exception.
15.62/5.18 *
15.62/5.18 * @param e the element to add
15.62/5.18 * @return true if the element was added to this deque, else
15.62/5.18 * false
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 boolean offerLast(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves and removes the first element of this deque. This method
15.62/5.18 * differs from {@link #pollFirst pollFirst} only in that it throws an
15.62/5.18 * exception if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the head of this deque
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E removeFirst();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves and removes the last element of this deque. This method
15.62/5.18 * differs from {@link #pollLast pollLast} only in that it throws an
15.62/5.18 * exception if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the tail of this deque
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E removeLast();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves and removes the first element of this deque,
15.62/5.18 * or returns null if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the head of this deque, or null if this deque is empty
15.62/5.18 */
15.62/5.18 E pollFirst();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves and removes the last element of this deque,
15.62/5.18 * or returns null if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the tail of this deque, or null if this deque is empty
15.62/5.18 */
15.62/5.18 E pollLast();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves, but does not remove, the first element of this deque.
15.62/5.18 *
15.62/5.18 * This method differs from {@link #peekFirst peekFirst} only in that it
15.62/5.18 * throws an exception if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the head of this deque
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E getFirst();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves, but does not remove, the last element of this deque.
15.62/5.18 * This method differs from {@link #peekLast peekLast} only in that it
15.62/5.18 * throws an exception if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the tail of this deque
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E getLast();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves, but does not remove, the first element of this deque,
15.62/5.18 * or returns null if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the head of this deque, or null if this deque is empty
15.62/5.18 */
15.62/5.18 E peekFirst();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves, but does not remove, the last element of this deque,
15.62/5.18 * or returns null if this deque is empty.
15.62/5.18 *
15.62/5.18 * @return the tail of this deque, or null if this deque is empty
15.62/5.18 */
15.62/5.18 E peekLast();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Removes the first occurrence of the specified element from this deque.
15.62/5.18 * If the deque does not contain the element, it is unchanged.
15.62/5.18 * More formally, removes the first element e such that
15.62/5.18 * (o==null ? e==null : o.equals(e))
15.62/5.18 * (if such an element exists).
15.62/5.18 * Returns true if this deque contained the specified element
15.62/5.18 * (or equivalently, if this deque changed as a result of the call).
15.62/5.18 *
15.62/5.18 * @param o element to be removed from this deque, if present
15.62/5.18 * @return true if an element was removed as a result of this call
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * is incompatible with this deque (optional)
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements (optional)
15.62/5.18 */
15.62/5.18 boolean removeFirstOccurrence(Object o);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Removes the last occurrence of the specified element from this deque.
15.62/5.18 * If the deque does not contain the element, it is unchanged.
15.62/5.18 * More formally, removes the last element e such that
15.62/5.18 * (o==null ? e==null : o.equals(e))
15.62/5.18 * (if such an element exists).
15.62/5.18 * Returns true if this deque contained the specified element
15.62/5.18 * (or equivalently, if this deque changed as a result of the call).
15.62/5.18 *
15.62/5.18 * @param o element to be removed from this deque, if present
15.62/5.18 * @return true if an element was removed as a result of this call
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * is incompatible with this deque (optional)
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements (optional)
15.62/5.18 */
15.62/5.18 boolean removeLastOccurrence(Object o);
15.62/5.18
15.62/5.18 // *** Queue methods ***
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Inserts the specified element into the queue represented by this deque
15.62/5.18 * (in other words, at the tail of this deque) if it is possible to do so
15.62/5.18 * immediately without violating capacity restrictions, returning
15.62/5.18 * true upon success and throwing an
15.62/5.18 * IllegalStateException if no space is currently available.
15.62/5.18 * When using a capacity-restricted deque, it is generally preferable to
15.62/5.18 * use {@link #offer(Object) offer}.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #addLast}.
15.62/5.18 *
15.62/5.18 * @param e the element to add
15.62/5.18 * @return true (as specified by {@link Collection#add})
15.62/5.18 * @throws IllegalStateException if the element cannot be added at this
15.62/5.18 * time due to capacity restrictions
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 boolean add(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Inserts the specified element into the queue represented by this deque
15.62/5.18 * (in other words, at the tail of this deque) if it is possible to do so
15.62/5.18 * immediately without violating capacity restrictions, returning
15.62/5.18 * true upon success and false if no space is currently
15.62/5.18 * available. When using a capacity-restricted deque, this method is
15.62/5.18 * generally preferable to the {@link #add} method, which can fail to
15.62/5.18 * insert an element only by throwing an exception.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #offerLast}.
15.62/5.18 *
15.62/5.18 * @param e the element to add
15.62/5.18 * @return true if the element was added to this deque, else
15.62/5.18 * false
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 boolean offer(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves and removes the head of the queue represented by this deque
15.62/5.18 * (in other words, the first element of this deque).
15.62/5.18 * This method differs from {@link #poll poll} only in that it throws an
15.62/5.18 * exception if this deque is empty.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #removeFirst()}.
15.62/5.18 *
15.62/5.18 * @return the head of the queue represented by this deque
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E remove();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves and removes the head of the queue represented by this deque
15.62/5.18 * (in other words, the first element of this deque), or returns
15.62/5.18 * null if this deque is empty.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #pollFirst()}.
15.62/5.18 *
15.62/5.18 * @return the first element of this deque, or null if
15.62/5.18 * this deque is empty
15.62/5.18 */
15.62/5.18 E poll();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves, but does not remove, the head of the queue represented by
15.62/5.18 * this deque (in other words, the first element of this deque).
15.62/5.18 * This method differs from {@link #peek peek} only in that it throws an
15.62/5.18 * exception if this deque is empty.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #getFirst()}.
15.62/5.18 *
15.62/5.18 * @return the head of the queue represented by this deque
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E element();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Retrieves, but does not remove, the head of the queue represented by
15.62/5.18 * this deque (in other words, the first element of this deque), or
15.62/5.18 * returns null if this deque is empty.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #peekFirst()}.
15.62/5.18 *
15.62/5.18 * @return the head of the queue represented by this deque, or
15.62/5.18 * null if this deque is empty
15.62/5.18 */
15.62/5.18 E peek();
15.62/5.18
15.62/5.18
15.62/5.18 // *** Stack methods ***
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Pushes an element onto the stack represented by this deque (in other
15.62/5.18 * words, at the head of this deque) if it is possible to do so
15.62/5.18 * immediately without violating capacity restrictions, returning
15.62/5.18 * true upon success and throwing an
15.62/5.18 * IllegalStateException if no space is currently available.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #addFirst}.
15.62/5.18 *
15.62/5.18 * @param e the element to push
15.62/5.18 * @throws IllegalStateException if the element cannot be added at this
15.62/5.18 * time due to capacity restrictions
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * prevents it from being added to this deque
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements
15.62/5.18 * @throws IllegalArgumentException if some property of the specified
15.62/5.18 * element prevents it from being added to this deque
15.62/5.18 */
15.62/5.18 void push(E e);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Pops an element from the stack represented by this deque. In other
15.62/5.18 * words, removes and returns the first element of this deque.
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #removeFirst()}.
15.62/5.18 *
15.62/5.18 * @return the element at the front of this deque (which is the top
15.62/5.18 * of the stack represented by this deque)
15.62/5.18 * @throws NoSuchElementException if this deque is empty
15.62/5.18 */
15.62/5.18 E pop();
15.62/5.18
15.62/5.18
15.62/5.18 // *** Collection methods ***
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Removes the first occurrence of the specified element from this deque.
15.62/5.18 * If the deque does not contain the element, it is unchanged.
15.62/5.18 * More formally, removes the first element e such that
15.62/5.18 * (o==null ? e==null : o.equals(e))
15.62/5.18 * (if such an element exists).
15.62/5.18 * Returns true if this deque contained the specified element
15.62/5.18 * (or equivalently, if this deque changed as a result of the call).
15.62/5.18 *
15.62/5.18 *
This method is equivalent to {@link #removeFirstOccurrence}.
15.62/5.18 *
15.62/5.18 * @param o element to be removed from this deque, if present
15.62/5.18 * @return true if an element was removed as a result of this call
15.62/5.18 * @throws ClassCastException if the class of the specified element
15.62/5.18 * is incompatible with this deque (optional)
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements (optional)
15.62/5.18 */
15.62/5.18 boolean remove(Object o);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Returns true if this deque contains the specified element.
15.62/5.18 * More formally, returns true if and only if this deque contains
15.62/5.18 * at least one element e such that
15.62/5.18 * (o==null ? e==null : o.equals(e)).
15.62/5.18 *
15.62/5.18 * @param o element whose presence in this deque is to be tested
15.62/5.18 * @return true if this deque contains the specified element
15.62/5.18 * @throws ClassCastException if the type of the specified element
15.62/5.18 * is incompatible with this deque (optional)
15.62/5.18 * @throws NullPointerException if the specified element is null and this
15.62/5.18 * deque does not permit null elements (optional)
15.62/5.18 */
15.62/5.18 boolean contains(Object o);
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Returns the number of elements in this deque.
15.62/5.18 *
15.62/5.18 * @return the number of elements in this deque
15.62/5.18 */
15.62/5.18 public int size();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Returns an iterator over the elements in this deque in proper sequence.
15.62/5.18 * The elements will be returned in order from first (head) to last (tail).
15.62/5.18 *
15.62/5.18 * @return an iterator over the elements in this deque in proper sequence
15.62/5.18 */
15.62/5.18 Iterator iterator();
15.62/5.18
15.62/5.18 /**
15.62/5.18 * Returns an iterator over the elements in this deque in reverse
15.62/5.18 * sequential order. The elements will be returned in order from
15.62/5.18 * last (tail) to first (head).
15.62/5.18 *
15.62/5.18 * @return an iterator over the elements in this deque in reverse
15.62/5.18 * sequence
15.62/5.18 */
15.62/5.18 Iterator descendingIterator();
15.62/5.18
15.62/5.18 }
15.62/5.18
15.62/5.18
15.62/5.18 /*
15.62/5.18 * Copyright 1994-2003 Sun Microsystems, Inc. All Rights Reserved.
15.62/5.18 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.62/5.18 *
15.62/5.18 * This code is free software; you can redistribute it and/or modify it
15.62/5.18 * under the terms of the GNU General Public License version 2 only, as
15.85/5.18 * published by the Free Software Foundation. Sun designates this
15.85/5.18 * particular file as subject to the "Classpath" exception as provided
15.85/5.18 * by Sun in the LICENSE file that accompanied this code.
15.85/5.18 *
15.85/5.18 * This code is distributed in the hope that it will be useful, but WITHOUT
15.85/5.18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.85/5.18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.85/5.18 * version 2 for more details (a copy is included in the LICENSE file that
15.85/5.18 * accompanied this code).
15.85/5.18 *
15.85/5.18 * You should have received a copy of the GNU General Public License version
15.85/5.18 * 2 along with this work; if not, write to the Free Software Foundation,
15.85/5.18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.85/5.18 *
15.85/5.18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.85/5.18 * CA 95054 USA or visit www.sun.com if you need additional information or
15.85/5.18 * have any questions.
15.85/5.18 */
15.85/5.18
15.85/5.18 package javaUtilEx;
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Thrown to indicate that a method has been passed an illegal or
15.85/5.18 * inappropriate argument.
15.85/5.18 *
15.85/5.18 * @author unascribed
15.85/5.18 * @see java.lang.Thread#setPriority(int)
15.85/5.18 * @since JDK1.0
15.85/5.18 */
15.85/5.18 public
15.85/5.18 class IllegalArgumentException extends RuntimeException {
15.85/5.18 /**
15.85/5.18 * Constructs an IllegalArgumentException with no
15.85/5.18 * detail message.
15.85/5.18 */
15.85/5.18 public IllegalArgumentException() {
15.85/5.18 super();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs an IllegalArgumentException with the
15.85/5.18 * specified detail message.
15.85/5.18 *
15.85/5.18 * @param s the detail message.
15.85/5.18 */
15.85/5.18 public IllegalArgumentException(String s) {
15.85/5.18 super(s);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs a new exception with the specified detail message and
15.85/5.18 * cause.
15.85/5.18 *
15.85/5.18 * Note that the detail message associated with cause is
15.85/5.18 * not automatically incorporated in this exception's detail
15.85/5.18 * message.
15.85/5.18 *
15.85/5.18 * @param message the detail message (which is saved for later retrieval
15.85/5.18 * by the {@link Throwable#getMessage()} method).
15.85/5.18 * @param cause the cause (which is saved for later retrieval by the
15.85/5.18 * {@link Throwable#getCause()} method). (A null value
15.85/5.18 * is permitted, and indicates that the cause is nonexistent or
15.85/5.18 * unknown.)
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public IllegalArgumentException(String message, Throwable cause) {
15.85/5.18 super(message, cause);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs a new exception with the specified cause and a detail
15.85/5.18 * message of (cause==null ? null : cause.toString()) (which
15.85/5.18 * typically contains the class and detail message of cause).
15.85/5.18 * This constructor is useful for exceptions that are little more than
15.85/5.18 * wrappers for other throwables (for example, {@link
15.85/5.18 * java.security.PrivilegedActionException}).
15.85/5.18 *
15.85/5.18 * @param cause the cause (which is saved for later retrieval by the
15.85/5.18 * {@link Throwable#getCause()} method). (A null value is
15.85/5.18 * permitted, and indicates that the cause is nonexistent or
15.85/5.18 * unknown.)
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public IllegalArgumentException(Throwable cause) {
15.85/5.18 super(cause);
15.85/5.18 }
15.85/5.18
15.85/5.18 private static final long serialVersionUID = -5365630128856068164L;
15.85/5.18 }
15.85/5.18
15.85/5.18
15.85/5.18 /*
15.85/5.18 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
15.85/5.18 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.85/5.18 *
15.85/5.18 * This code is free software; you can redistribute it and/or modify it
15.85/5.18 * under the terms of the GNU General Public License version 2 only, as
15.85/5.18 * published by the Free Software Foundation. Sun designates this
15.85/5.18 * particular file as subject to the "Classpath" exception as provided
15.85/5.18 * by Sun in the LICENSE file that accompanied this code.
15.85/5.18 *
15.85/5.18 * This code is distributed in the hope that it will be useful, but WITHOUT
15.85/5.18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.85/5.18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.85/5.18 * version 2 for more details (a copy is included in the LICENSE file that
15.85/5.18 * accompanied this code).
15.85/5.18 *
15.85/5.18 * You should have received a copy of the GNU General Public License version
15.85/5.18 * 2 along with this work; if not, write to the Free Software Foundation,
15.85/5.18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.85/5.18 *
15.85/5.18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.85/5.18 * CA 95054 USA or visit www.sun.com if you need additional information or
15.85/5.18 * have any questions.
15.85/5.18 */
15.85/5.18
15.85/5.18 package javaUtilEx;
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Signals that a method has been invoked at an illegal or
15.85/5.18 * inappropriate time. In other words, the Java environment or
15.85/5.18 * Java application is not in an appropriate state for the requested
15.85/5.18 * operation.
15.85/5.18 *
15.85/5.18 * @author Jonni Kanerva
15.85/5.18 * @since JDK1.1
15.85/5.18 */
15.85/5.18 public
15.85/5.18 class IllegalStateException extends RuntimeException {
15.85/5.18 /**
15.85/5.18 * Constructs an IllegalStateException with no detail message.
15.85/5.18 * A detail message is a String that describes this particular exception.
15.85/5.18 */
15.85/5.18 public IllegalStateException() {
15.85/5.18 super();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs an IllegalStateException with the specified detail
15.85/5.18 * message. A detail message is a String that describes this particular
15.85/5.18 * exception.
15.85/5.18 *
15.85/5.18 * @param s the String that contains a detailed message
15.85/5.18 */
15.85/5.18 public IllegalStateException(String s) {
15.85/5.18 super(s);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs a new exception with the specified detail message and
15.85/5.18 * cause.
15.85/5.18 *
15.85/5.18 *
Note that the detail message associated with cause is
15.85/5.18 * not automatically incorporated in this exception's detail
15.85/5.18 * message.
15.85/5.18 *
15.85/5.18 * @param message the detail message (which is saved for later retrieval
15.85/5.18 * by the {@link Throwable#getMessage()} method).
15.85/5.18 * @param cause the cause (which is saved for later retrieval by the
15.85/5.18 * {@link Throwable#getCause()} method). (A null value
15.85/5.18 * is permitted, and indicates that the cause is nonexistent or
15.85/5.18 * unknown.)
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public IllegalStateException(String message, Throwable cause) {
15.85/5.18 super(message, cause);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs a new exception with the specified cause and a detail
15.85/5.18 * message of (cause==null ? null : cause.toString()) (which
15.85/5.18 * typically contains the class and detail message of cause).
15.85/5.18 * This constructor is useful for exceptions that are little more than
15.85/5.18 * wrappers for other throwables (for example, {@link
15.85/5.18 * java.security.PrivilegedActionException}).
15.85/5.18 *
15.85/5.18 * @param cause the cause (which is saved for later retrieval by the
15.85/5.18 * {@link Throwable#getCause()} method). (A null value is
15.85/5.18 * permitted, and indicates that the cause is nonexistent or
15.85/5.18 * unknown.)
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public IllegalStateException(Throwable cause) {
15.85/5.18 super(cause);
15.85/5.18 }
15.85/5.18
15.85/5.18 static final long serialVersionUID = -1848914673093119416L;
15.85/5.18 }
15.85/5.18
15.85/5.18
15.85/5.18 /*
15.85/5.18 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.85/5.18 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.85/5.18 *
15.85/5.18 * This code is free software; you can redistribute it and/or modify it
15.85/5.18 * under the terms of the GNU General Public License version 2 only, as
15.85/5.18 * published by the Free Software Foundation. Sun designates this
15.85/5.18 * particular file as subject to the "Classpath" exception as provided
15.85/5.18 * by Sun in the LICENSE file that accompanied this code.
15.85/5.18 *
15.85/5.18 * This code is distributed in the hope that it will be useful, but WITHOUT
15.85/5.18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.85/5.18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.85/5.18 * version 2 for more details (a copy is included in the LICENSE file that
15.85/5.18 * accompanied this code).
15.85/5.18 *
15.85/5.18 * You should have received a copy of the GNU General Public License version
15.85/5.18 * 2 along with this work; if not, write to the Free Software Foundation,
15.85/5.18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.85/5.18 *
15.85/5.18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.85/5.18 * CA 95054 USA or visit www.sun.com if you need additional information or
15.85/5.18 * have any questions.
15.85/5.18 */
15.85/5.18
15.85/5.18 package javaUtilEx;
15.85/5.18
15.85/5.18 /**
15.85/5.18 * An iterator over a collection. {@code Iterator} takes the place of
15.85/5.18 * {@link Enumeration} in the Java Collections Framework. Iterators
15.85/5.18 * differ from enumerations in two ways:
15.85/5.18 *
15.85/5.18 *
15.85/5.18 * - Iterators allow the caller to remove elements from the
15.85/5.18 * underlying collection during the iteration with well-defined
15.85/5.18 * semantics.
15.85/5.18 *
- Method names have been improved.
15.85/5.18 *
15.85/5.18 *
15.85/5.18 * This interface is a member of the
15.85/5.18 *
15.85/5.18 * Java Collections Framework.
15.85/5.18 *
15.85/5.18 * @author Josh Bloch
15.85/5.18 * @see Collection
15.85/5.18 * @see ListIterator
15.85/5.18 * @see Iterable
15.85/5.18 * @since 1.2
15.85/5.18 */
15.85/5.18 public interface Iterator {
15.85/5.18 /**
15.85/5.18 * Returns {@code true} if the iteration has more elements.
15.85/5.18 * (In other words, returns {@code true} if {@link #next} would
15.85/5.18 * return an element rather than throwing an exception.)
15.85/5.18 *
15.85/5.18 * @return {@code true} if the iteration has more elements
15.85/5.18 */
15.85/5.18 boolean hasNext();
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the next element in the iteration.
15.85/5.18 *
15.85/5.18 * @return the next element in the iteration
15.85/5.18 * @throws NoSuchElementException if the iteration has no more elements
15.85/5.18 */
15.85/5.18 E next();
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes from the underlying collection the last element returned
15.85/5.18 * by this iterator (optional operation). This method can be called
15.85/5.18 * only once per call to {@link #next}. The behavior of an iterator
15.85/5.18 * is unspecified if the underlying collection is modified while the
15.85/5.18 * iteration is in progress in any way other than by calling this
15.85/5.18 * method.
15.85/5.18 *
15.85/5.18 * @throws UnsupportedOperationException if the {@code remove}
15.85/5.18 * operation is not supported by this iterator
15.85/5.18 *
15.85/5.18 * @throws IllegalStateException if the {@code next} method has not
15.85/5.18 * yet been called, or the {@code remove} method has already
15.85/5.18 * been called after the last call to the {@code next}
15.85/5.18 * method
15.85/5.18 */
15.85/5.18 void remove();
15.85/5.18 }
15.85/5.18
15.85/5.18
15.85/5.18 package javaUtilEx;
15.85/5.18
15.85/5.18 public class juLinkedListCreateRemoveFirst {
15.85/5.18 public static void main(String[] args) {
15.85/5.18 Random.args = args;
15.85/5.18
15.85/5.18 LinkedList l = createList(Random.random());
15.85/5.18 l.removeFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 public static LinkedList createList(int n) {
15.85/5.18 LinkedList l = new LinkedList();
15.85/5.18 while (n > 0) {
15.85/5.18 l.addLast(new Content(Random.random()));
15.85/5.18 n--;
15.85/5.18 }
15.85/5.18 return l;
15.85/5.18 }
15.85/5.18 }
15.85/5.18
15.85/5.18 final class Content {
15.85/5.18 int val;
15.85/5.18
15.85/5.18 public Content(int v) {
15.85/5.18 this.val = v;
15.85/5.18 }
15.85/5.18
15.85/5.18 public int hashCode() {
15.85/5.18 return val^31;
15.85/5.18 }
15.85/5.18
15.85/5.18 public boolean equals(Object o) {
15.85/5.18 if (o instanceof Content) {
15.85/5.18 return this.val == ((Content) o).val;
15.85/5.18 }
15.85/5.18 return false;
15.85/5.18 }
15.85/5.18 }
15.85/5.18
15.85/5.18
15.85/5.18 /*
15.85/5.18 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
15.85/5.18 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
15.85/5.18 *
15.85/5.18 * This code is free software; you can redistribute it and/or modify it
15.85/5.18 * under the terms of the GNU General Public License version 2 only, as
15.85/5.18 * published by the Free Software Foundation. Sun designates this
15.85/5.18 * particular file as subject to the "Classpath" exception as provided
15.85/5.18 * by Sun in the LICENSE file that accompanied this code.
15.85/5.18 *
15.85/5.18 * This code is distributed in the hope that it will be useful, but WITHOUT
15.85/5.18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15.85/5.18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15.85/5.18 * version 2 for more details (a copy is included in the LICENSE file that
15.85/5.18 * accompanied this code).
15.85/5.18 *
15.85/5.18 * You should have received a copy of the GNU General Public License version
15.85/5.18 * 2 along with this work; if not, write to the Free Software Foundation,
15.85/5.18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
15.85/5.18 *
15.85/5.18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
15.85/5.18 * CA 95054 USA or visit www.sun.com if you need additional information or
15.85/5.18 * have any questions.
15.85/5.18 */
15.85/5.18
15.85/5.18 package javaUtilEx;
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Linked list implementation of the List interface. Implements all
15.85/5.18 * optional list operations, and permits all elements (including
15.85/5.18 * null). In addition to implementing the List interface,
15.85/5.18 * the LinkedList class provides uniformly named methods to
15.85/5.18 * get, remove and insert an element at the
15.85/5.18 * beginning and end of the list. These operations allow linked lists to be
15.85/5.18 * used as a stack, {@linkplain Queue queue}, or {@linkplain Deque
15.85/5.18 * double-ended queue}.
15.85/5.18 *
15.85/5.18 * The class implements the Deque interface, providing
15.85/5.18 * first-in-first-out queue operations for add,
15.85/5.18 * poll, along with other stack and deque operations.
15.85/5.18 *
15.85/5.18 * All of the operations perform as could be expected for a doubly-linked
15.85/5.18 * list. Operations that index into the list will traverse the list from
15.85/5.18 * the beginning or the end, whichever is closer to the specified index.
15.85/5.18 *
15.85/5.18 *
Note that this implementation is not synchronized.
15.85/5.18 * If multiple threads access a linked list concurrently, and at least
15.85/5.18 * one of the threads modifies the list structurally, it must be
15.85/5.18 * synchronized externally. (A structural modification is any operation
15.85/5.18 * that adds or deletes one or more elements; merely setting the value of
15.85/5.18 * an element is not a structural modification.) This is typically
15.85/5.18 * accomplished by synchronizing on some object that naturally
15.85/5.18 * encapsulates the list.
15.85/5.18 *
15.85/5.18 * If no such object exists, the list should be "wrapped" using the
15.85/5.18 * {@link Collections#synchronizedList Collections.synchronizedList}
15.85/5.18 * method. This is best done at creation time, to prevent accidental
15.85/5.18 * unsynchronized access to the list:
15.85/5.18 * List list = Collections.synchronizedList(new LinkedList(...));
15.85/5.18 *
15.85/5.18 * The iterators returned by this class's iterator and
15.85/5.18 * listIterator methods are fail-fast: if the list is
15.85/5.18 * structurally modified at any time after the iterator is created, in
15.85/5.18 * any way except through the Iterator's own remove or
15.85/5.18 * add methods, the iterator will throw a {@link
15.85/5.18 * ConcurrentModificationException}. Thus, in the face of concurrent
15.85/5.18 * modification, the iterator fails quickly and cleanly, rather than
15.85/5.18 * risking arbitrary, non-deterministic behavior at an undetermined
15.85/5.18 * time in the future.
15.85/5.18 *
15.85/5.18 *
Note that the fail-fast behavior of an iterator cannot be guaranteed
15.85/5.18 * as it is, generally speaking, impossible to make any hard guarantees in the
15.85/5.18 * presence of unsynchronized concurrent modification. Fail-fast iterators
15.85/5.18 * throw ConcurrentModificationException on a best-effort basis.
15.85/5.18 * Therefore, it would be wrong to write a program that depended on this
15.85/5.18 * exception for its correctness: the fail-fast behavior of iterators
15.85/5.18 * should be used only to detect bugs.
15.85/5.18 *
15.85/5.18 *
This class is a member of the
15.85/5.18 *
15.85/5.18 * Java Collections Framework.
15.85/5.18 *
15.85/5.18 * @author Josh Bloch
15.85/5.18 * @see List
15.85/5.18 * @see ArrayList
15.85/5.18 * @see Vector
15.85/5.18 * @since 1.2
15.85/5.18 * @param the type of elements held in this collection
15.85/5.18 */
15.85/5.18
15.85/5.18 public class LinkedList
15.85/5.18 extends AbstractSequentialList
15.85/5.18 implements List, Deque
15.85/5.18 {
15.85/5.18 private transient Entry header = new Entry(null, null, null);
15.85/5.18 private transient int size = 0;
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs an empty list.
15.85/5.18 */
15.85/5.18 public LinkedList() {
15.85/5.18 header.next = header.previous = header;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Constructs a list containing the elements of the specified
15.85/5.18 * collection, in the order they are returned by the collection's
15.85/5.18 * iterator.
15.85/5.18 *
15.85/5.18 * @param c the collection whose elements are to be placed into this list
15.85/5.18 * @throws NullPointerException if the specified collection is null
15.85/5.18 */
15.85/5.18 public LinkedList(Collection c) {
15.85/5.18 this();
15.85/5.18 addAll(c);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the first element in this list.
15.85/5.18 *
15.85/5.18 * @return the first element in this list
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 */
15.85/5.18 public E getFirst() {
15.85/5.18 if (size==0)
15.85/5.18 throw new NoSuchElementException();
15.85/5.18
15.85/5.18 return header.next.element;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the last element in this list.
15.85/5.18 *
15.85/5.18 * @return the last element in this list
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 */
15.85/5.18 public E getLast() {
15.85/5.18 if (size==0)
15.85/5.18 throw new NoSuchElementException();
15.85/5.18
15.85/5.18 return header.previous.element;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes and returns the first element from this list.
15.85/5.18 *
15.85/5.18 * @return the first element from this list
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 */
15.85/5.18 public E removeFirst() {
15.85/5.18 return remove(header.next);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes and returns the last element from this list.
15.85/5.18 *
15.85/5.18 * @return the last element from this list
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 */
15.85/5.18 public E removeLast() {
15.85/5.18 return remove(header.previous);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Inserts the specified element at the beginning of this list.
15.85/5.18 *
15.85/5.18 * @param e the element to add
15.85/5.18 */
15.85/5.18 public void addFirst(E e) {
15.85/5.18 addBefore(e, header.next);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Appends the specified element to the end of this list.
15.85/5.18 *
15.85/5.18 * This method is equivalent to {@link #add}.
15.85/5.18 *
15.85/5.18 * @param e the element to add
15.85/5.18 */
15.85/5.18 public void addLast(E e) {
15.85/5.18 addBefore(e, header);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns true if this list contains the specified element.
15.85/5.18 * More formally, returns true if and only if this list contains
15.85/5.18 * at least one element e such that
15.85/5.18 * (o==null ? e==null : o.equals(e)).
15.85/5.18 *
15.85/5.18 * @param o element whose presence in this list is to be tested
15.85/5.18 * @return true if this list contains the specified element
15.85/5.18 */
15.85/5.18 public boolean contains(Object o) {
15.85/5.18 return indexOf(o) != -1;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the number of elements in this list.
15.85/5.18 *
15.85/5.18 * @return the number of elements in this list
15.85/5.18 */
15.85/5.18 public int size() {
15.85/5.18 return size;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Appends the specified element to the end of this list.
15.85/5.18 *
15.85/5.18 *
This method is equivalent to {@link #addLast}.
15.85/5.18 *
15.85/5.18 * @param e element to be appended to this list
15.85/5.18 * @return true (as specified by {@link Collection#add})
15.85/5.18 */
15.85/5.18 public boolean add(E e) {
15.85/5.18 addBefore(e, header);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes the first occurrence of the specified element from this list,
15.85/5.18 * if it is present. If this list does not contain the element, it is
15.85/5.18 * unchanged. More formally, removes the element with the lowest index
15.85/5.18 * i such that
15.85/5.18 * (o==null ? get(i)==null : o.equals(get(i)))
15.85/5.18 * (if such an element exists). Returns true if this list
15.85/5.18 * contained the specified element (or equivalently, if this list
15.85/5.18 * changed as a result of the call).
15.85/5.18 *
15.85/5.18 * @param o element to be removed from this list, if present
15.85/5.18 * @return true if this list contained the specified element
15.85/5.18 */
15.85/5.18 public boolean remove(Object o) {
15.85/5.18 if (o==null) {
15.85/5.18 for (Entry e = header.next; e != header; e = e.next) {
15.85/5.18 if (e.element==null) {
15.85/5.18 remove(e);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18 }
15.85/5.18 } else {
15.85/5.18 for (Entry e = header.next; e != header; e = e.next) {
15.85/5.18 if (o.equals(e.element)) {
15.85/5.18 remove(e);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18 }
15.85/5.18 }
15.85/5.18 return false;
15.85/5.18 }
15.85/5.18 /**
15.85/5.18 * Removes all of the elements from this list.
15.85/5.18 */
15.85/5.18 public void clear() {
15.85/5.18 Entry e = header.next;
15.85/5.18 while (e != header) {
15.85/5.18 Entry next = e.next;
15.85/5.18 e.next = e.previous = null;
15.85/5.18 e.element = null;
15.85/5.18 e = next;
15.85/5.18 }
15.85/5.18 header.next = header.previous = header;
15.85/5.18 size = 0;
15.85/5.18 modCount++;
15.85/5.18 }
15.85/5.18
15.85/5.18
15.85/5.18 // Positional Access Operations
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the element at the specified position in this list.
15.85/5.18 *
15.85/5.18 * @param index index of the element to return
15.85/5.18 * @return the element at the specified position in this list
15.85/5.18 * @throws IndexOutOfBoundsException {@inheritDoc}
15.85/5.18 */
15.85/5.18 public E get(int index) {
15.85/5.18 return entry(index).element;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Replaces the element at the specified position in this list with the
15.85/5.18 * specified element.
15.85/5.18 *
15.85/5.18 * @param index index of the element to replace
15.85/5.18 * @param element element to be stored at the specified position
15.85/5.18 * @return the element previously at the specified position
15.85/5.18 * @throws IndexOutOfBoundsException {@inheritDoc}
15.85/5.18 */
15.85/5.18 public E set(int index, E element) {
15.85/5.18 Entry e = entry(index);
15.85/5.18 E oldVal = e.element;
15.85/5.18 e.element = element;
15.85/5.18 return oldVal;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Inserts the specified element at the specified position in this list.
15.85/5.18 * Shifts the element currently at that position (if any) and any
15.85/5.18 * subsequent elements to the right (adds one to their indices).
15.85/5.18 *
15.85/5.18 * @param index index at which the specified element is to be inserted
15.85/5.18 * @param element element to be inserted
15.85/5.18 * @throws IndexOutOfBoundsException {@inheritDoc}
15.85/5.18 */
15.85/5.18 public void add(int index, E element) {
15.85/5.18 addBefore(element, (index==size ? header : entry(index)));
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes the element at the specified position in this list. Shifts any
15.85/5.18 * subsequent elements to the left (subtracts one from their indices).
15.85/5.18 * Returns the element that was removed from the list.
15.85/5.18 *
15.85/5.18 * @param index the index of the element to be removed
15.85/5.18 * @return the element previously at the specified position
15.85/5.18 * @throws IndexOutOfBoundsException {@inheritDoc}
15.85/5.18 */
15.85/5.18 public E remove(int index) {
15.85/5.18 return remove(entry(index));
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the indexed entry.
15.85/5.18 */
15.85/5.18 private Entry entry(int index) {
15.85/5.18 if (index < 0 || index >= size)
15.85/5.18 throw new IndexOutOfBoundsException();
15.85/5.18 Entry e = header;
15.85/5.18 if (index < (size >> 1)) {
15.85/5.18 for (int i = 0; i <= index; i++)
15.85/5.18 e = e.next;
15.85/5.18 } else {
15.85/5.18 for (int i = size; i > index; i--)
15.85/5.18 e = e.previous;
15.85/5.18 }
15.85/5.18 return e;
15.85/5.18 }
15.85/5.18
15.85/5.18
15.85/5.18 // Search Operations
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the index of the first occurrence of the specified element
15.85/5.18 * in this list, or -1 if this list does not contain the element.
15.85/5.18 * More formally, returns the lowest index i such that
15.85/5.18 * (o==null ? get(i)==null : o.equals(get(i))),
15.85/5.18 * or -1 if there is no such index.
15.85/5.18 *
15.85/5.18 * @param o element to search for
15.85/5.18 * @return the index of the first occurrence of the specified element in
15.85/5.18 * this list, or -1 if this list does not contain the element
15.85/5.18 */
15.85/5.18 public int indexOf(Object o) {
15.85/5.18 int index = 0;
15.85/5.18 if (o==null) {
15.85/5.18 for (Entry e = header.next; e != header; e = e.next) {
15.85/5.18 if (e.element==null)
15.85/5.18 return index;
15.85/5.18 index++;
15.85/5.18 }
15.85/5.18 } else {
15.85/5.18 for (Entry e = header.next; e != header; e = e.next) {
15.85/5.18 if (o.equals(e.element))
15.85/5.18 return index;
15.85/5.18 index++;
15.85/5.18 }
15.85/5.18 }
15.85/5.18 return -1;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns the index of the last occurrence of the specified element
15.85/5.18 * in this list, or -1 if this list does not contain the element.
15.85/5.18 * More formally, returns the highest index i such that
15.85/5.18 * (o==null ? get(i)==null : o.equals(get(i))),
15.85/5.18 * or -1 if there is no such index.
15.85/5.18 *
15.85/5.18 * @param o element to search for
15.85/5.18 * @return the index of the last occurrence of the specified element in
15.85/5.18 * this list, or -1 if this list does not contain the element
15.85/5.18 */
15.85/5.18 public int lastIndexOf(Object o) {
15.85/5.18 int index = size;
15.85/5.18 if (o==null) {
15.85/5.18 for (Entry e = header.previous; e != header; e = e.previous) {
15.85/5.18 index--;
15.85/5.18 if (e.element==null)
15.85/5.18 return index;
15.85/5.18 }
15.85/5.18 } else {
15.85/5.18 for (Entry e = header.previous; e != header; e = e.previous) {
15.85/5.18 index--;
15.85/5.18 if (o.equals(e.element))
15.85/5.18 return index;
15.85/5.18 }
15.85/5.18 }
15.85/5.18 return -1;
15.85/5.18 }
15.85/5.18
15.85/5.18 // Queue operations.
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves, but does not remove, the head (first element) of this list.
15.85/5.18 * @return the head of this list, or null if this list is empty
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public E peek() {
15.85/5.18 if (size==0)
15.85/5.18 return null;
15.85/5.18 return getFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves, but does not remove, the head (first element) of this list.
15.85/5.18 * @return the head of this list
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public E element() {
15.85/5.18 return getFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves and removes the head (first element) of this list
15.85/5.18 * @return the head of this list, or null if this list is empty
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public E poll() {
15.85/5.18 if (size==0)
15.85/5.18 return null;
15.85/5.18 return removeFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves and removes the head (first element) of this list.
15.85/5.18 *
15.85/5.18 * @return the head of this list
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public E remove() {
15.85/5.18 return removeFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Adds the specified element as the tail (last element) of this list.
15.85/5.18 *
15.85/5.18 * @param e the element to add
15.85/5.18 * @return true (as specified by {@link Queue#offer})
15.85/5.18 * @since 1.5
15.85/5.18 */
15.85/5.18 public boolean offer(E e) {
15.85/5.18 return add(e);
15.85/5.18 }
15.85/5.18
15.85/5.18 // Deque operations
15.85/5.18 /**
15.85/5.18 * Inserts the specified element at the front of this list.
15.85/5.18 *
15.85/5.18 * @param e the element to insert
15.85/5.18 * @return true (as specified by {@link Deque#offerFirst})
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public boolean offerFirst(E e) {
15.85/5.18 addFirst(e);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Inserts the specified element at the end of this list.
15.85/5.18 *
15.85/5.18 * @param e the element to insert
15.85/5.18 * @return true (as specified by {@link Deque#offerLast})
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public boolean offerLast(E e) {
15.85/5.18 addLast(e);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves, but does not remove, the first element of this list,
15.85/5.18 * or returns null if this list is empty.
15.85/5.18 *
15.85/5.18 * @return the first element of this list, or null
15.85/5.18 * if this list is empty
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public E peekFirst() {
15.85/5.18 if (size==0)
15.85/5.18 return null;
15.85/5.18 return getFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves, but does not remove, the last element of this list,
15.85/5.18 * or returns null if this list is empty.
15.85/5.18 *
15.85/5.18 * @return the last element of this list, or null
15.85/5.18 * if this list is empty
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public E peekLast() {
15.85/5.18 if (size==0)
15.85/5.18 return null;
15.85/5.18 return getLast();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves and removes the first element of this list,
15.85/5.18 * or returns null if this list is empty.
15.85/5.18 *
15.85/5.18 * @return the first element of this list, or null if
15.85/5.18 * this list is empty
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public E pollFirst() {
15.85/5.18 if (size==0)
15.85/5.18 return null;
15.85/5.18 return removeFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Retrieves and removes the last element of this list,
15.85/5.18 * or returns null if this list is empty.
15.85/5.18 *
15.85/5.18 * @return the last element of this list, or null if
15.85/5.18 * this list is empty
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public E pollLast() {
15.85/5.18 if (size==0)
15.85/5.18 return null;
15.85/5.18 return removeLast();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Pushes an element onto the stack represented by this list. In other
15.85/5.18 * words, inserts the element at the front of this list.
15.85/5.18 *
15.85/5.18 * This method is equivalent to {@link #addFirst}.
15.85/5.18 *
15.85/5.18 * @param e the element to push
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public void push(E e) {
15.85/5.18 addFirst(e);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Pops an element from the stack represented by this list. In other
15.85/5.18 * words, removes and returns the first element of this list.
15.85/5.18 *
15.85/5.18 *
This method is equivalent to {@link #removeFirst()}.
15.85/5.18 *
15.85/5.18 * @return the element at the front of this list (which is the top
15.85/5.18 * of the stack represented by this list)
15.85/5.18 * @throws NoSuchElementException if this list is empty
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public E pop() {
15.85/5.18 return removeFirst();
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes the first occurrence of the specified element in this
15.85/5.18 * list (when traversing the list from head to tail). If the list
15.85/5.18 * does not contain the element, it is unchanged.
15.85/5.18 *
15.85/5.18 * @param o element to be removed from this list, if present
15.85/5.18 * @return true if the list contained the specified element
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public boolean removeFirstOccurrence(Object o) {
15.85/5.18 return remove(o);
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Removes the last occurrence of the specified element in this
15.85/5.18 * list (when traversing the list from head to tail). If the list
15.85/5.18 * does not contain the element, it is unchanged.
15.85/5.18 *
15.85/5.18 * @param o element to be removed from this list, if present
15.85/5.18 * @return true if the list contained the specified element
15.85/5.18 * @since 1.6
15.85/5.18 */
15.85/5.18 public boolean removeLastOccurrence(Object o) {
15.85/5.18 if (o==null) {
15.85/5.18 for (Entry e = header.previous; e != header; e = e.previous) {
15.85/5.18 if (e.element==null) {
15.85/5.18 remove(e);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18 }
15.85/5.18 } else {
15.85/5.18 for (Entry e = header.previous; e != header; e = e.previous) {
15.85/5.18 if (o.equals(e.element)) {
15.85/5.18 remove(e);
15.85/5.18 return true;
15.85/5.18 }
15.85/5.18 }
15.85/5.18 }
15.85/5.18 return false;
15.85/5.18 }
15.85/5.18
15.85/5.18 /**
15.85/5.18 * Returns a list-iterator of the elements in this list (in proper
15.85/5.18 * sequence), starting at the specified position in the list.
15.85/5.18 * Obeys the general contract of List.listIterator(int).
15.85/5.18 *
15.85/5.18 * The list-iterator is fail-fast: if the list is structurally
15.85/5.18 * modified at any time after the Iterator is created, in any way except
15.85/5.18 * through the list-iterator's own remove or add
15.85/5.18 * methods, the list-iterator will throw a
15.85/5.18 * ConcurrentModificationException. Thus, in the face of
15.85/5.18 * concurrent modification, the iterator fails quickly and cleanly, rather
15.85/5.18 * than risking arbitrary, non-deterministic behavior at an undetermined
15.85/5.18 * time in the future.
15.85/5.18 *
15.85/5.18 * @param index index of the first element to be returned from the
15.85/5.18 * list-iterator (by a call to next)
15.85/5.18 * @return a ListIterator of the elements in this list (in proper
15.85/5.18 * sequence), starting at the specified position in the list
15.85/5.18 * @throws IndexOutOfBoundsException {@inheritDoc}
15.85/5.18 * @see List#listIterator(int)
15.85/5.18 */
15.85/5.18 public ListIterator listIterator(int index) {
15.85/5.18 return new ListItr(index);
15.85/5.18 }
15.85/5.18
15.85/5.18 private class ListItr implements ListIterator {
15.85/5.18 private Entry lastReturned = header;
15.85/5.18 private Entry next;
15.85/5.18 private int nextIndex;
15.85/5.18 private int expectedModCount = modCount;
15.85/5.18
15.85/5.18 ListItr(int index) {
15.85/5.18 if (index < 0 || index > size)
15.85/5.18 throw new IndexOutOfBoundsException();
15.85/5.18 if (index < (size >> 1)) {
15.85/5.18 next = header.next;
15.85/5.18 for (nextIndex=0; nextIndexindex; nextIndex--)
15.85/5.18 next = next.previous;
15.85/5.18 }
15.85/5.18 }
15.85/5.18
15.85/5.18 public boolean hasNext() {
15.85/5.18 return nextIndex != size;
15.85/5.18 }
15.85/5.18
15.85/5.18 public E next() {
15.85/5.18 checkForComodification();
15.85/5.18 if (nextIndex == size)
15.85/5.18 throw new NoSuchElementException();
15.85/5.18
15.85/5.18 lastReturned = next;
15.85/5.18 next = next.next;
15.85/5.18 nextIndex++;
15.85/5.18 return lastReturned.element;
15.85/5.18 }
15.85/5.18
15.85/5.18 public boolean hasPrevious() {
15.85/5.18 return nextIndex != 0;
15.85/5.18 }
15.85/5.18
15.85/5.18 public E previous() {
15.85/5.18 if (nextIndex == 0)
15.85/5.18 throw new NoSuchElementException();
15.85/5.18
15.85/5.18 lastReturned = next = next.previous;
15.85/5.18 nextIndex--;
15.85/5.18 checkForComodification();
15.85/5.18 return lastReturned.element;
15.85/5.18 }
15.85/5.18
15.85/5.18 public int nextIndex() {
15.85/5.18 return nextIndex;
15.85/5.18 }
15.85/5.18
15.85/5.18 public int previousIndex() {
15.85/5.18 return nextIndex-1;
15.85/5.18 }
15.85/5.18
15.85/5.18 public void remove() {
15.85/5.18 checkForComodification();
15.85/5.18 Entry lastNext = lastReturned.next;
15.85/5.18 try {
15.85/5.18 LinkedList.this.remove(lastReturned);
15.85/5.18 } catch (NoSuchElementException e) {
15.85/5.18 throw new IllegalStateException();
15.85/5.18 }
15.85/5.18 if (next==lastReturned)
15.85/5.18 next = lastNext;
15.85/5.18 else
15.85/5.18 nextIndex--;
15.85/5.18 lastReturned = header;
15.85/5.18 expectedModCount++;
15.85/5.18 }
15.85/5.18
15.85/5.18 public void set(E e) {
15.85/5.18 if (lastReturned == header)
15.85/5.18 throw new IllegalStateException();
15.85/5.18 checkForComodification();
15.85/5.18 lastReturned.element = e;
15.85/5.18 }
15.85/5.18
15.85/5.18 public void add(E e) {
15.85/5.18 checkForComodification();
15.85/5.18 lastReturned = header;
15.85/5.18 addBefore(e, next);
15.85/5.18 nextIndex++;
15.85/5.18 expectedModCount++;
15.85/5.18 }
15.85/5.18
15.85/5.18 final void checkForComodification() {
15.85/5.18 if (modCount != expectedModCount)
15.85/5.18 throw new ConcurrentModificationException();
15.85/5.18 }
15.85/5.18 }
15.85/5.18
15.85/5.18 private static class Entry {
15.85/5.18 E element;
15.85/5.18 Entry next;
15.85/5.18 Entry previous;
15.85/5.18
15.85/5.18 Entry(E element, Entry next, Entry