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