26.16/8.21 * 26.16/8.21 * To implement an unmodifiable collection, the programmer needs only to 26.16/8.21 * extend this class and provide implementations for the iterator and 26.16/8.21 * size methods. (The iterator returned by the iterator 26.16/8.21 * method must implement hasNext and next.)
26.16/8.21 * 26.16/8.21 * To implement a modifiable collection, the programmer must additionally 26.16/8.21 * override this class's add method (which otherwise throws an 26.16/8.21 * UnsupportedOperationException), and the iterator returned by the 26.16/8.21 * iterator method must additionally implement its remove 26.16/8.21 * method.
26.16/8.21 * 26.16/8.21 * The programmer should generally provide a void (no argument) and 26.16/8.21 * Collection constructor, as per the recommendation in the 26.16/8.21 * Collection interface specification.
26.16/8.21 * 26.16/8.21 * The documentation for each non-abstract method in this class describes its 26.16/8.21 * implementation in detail. Each of these methods may be overridden if 26.16/8.21 * the collection being implemented admits a more efficient implementation.
26.16/8.21 *
26.16/8.21 * This class is a member of the
26.16/8.21 *
26.16/8.21 * Java Collections Framework.
26.16/8.21 *
26.16/8.21 * @author Josh Bloch
26.16/8.21 * @author Neal Gafter
26.16/8.21 * @see Collection
26.16/8.21 * @since 1.2
26.16/8.21 */
26.16/8.21
26.16/8.21 public abstract class AbstractCollection This implementation returns size() == 0.
26.16/8.21 */
26.16/8.21 public boolean isEmpty() {
26.16/8.21 return size() == 0;
26.16/8.21 }
26.16/8.21
26.16/8.21 /**
26.16/8.21 * {@inheritDoc}
26.16/8.21 *
26.16/8.21 * This implementation iterates over the elements in the collection,
26.16/8.21 * checking each element in turn for equality with the specified element.
26.16/8.21 *
26.16/8.21 * @throws ClassCastException {@inheritDoc}
26.16/8.21 * @throws NullPointerException {@inheritDoc}
26.16/8.21 */
26.16/8.21 public boolean contains(Object o) {
26.16/8.21 Iterator This implementation always throws an
26.16/8.21 * UnsupportedOperationException.
26.16/8.21 *
26.16/8.21 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.21 * @throws ClassCastException {@inheritDoc}
26.16/8.21 * @throws NullPointerException {@inheritDoc}
26.16/8.21 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.21 * @throws IllegalStateException {@inheritDoc}
26.16/8.21 */
26.16/8.21 public boolean add(E e) {
26.16/8.21 throw new UnsupportedOperationException();
26.16/8.21 }
26.16/8.21
26.16/8.21 /**
26.16/8.21 * {@inheritDoc}
26.16/8.21 *
26.16/8.21 * This implementation iterates over the collection looking for the
26.16/8.21 * specified element. If it finds the element, it removes the element
26.16/8.21 * from the collection using the iterator's remove method.
26.16/8.21 *
26.16/8.21 * Note that this implementation throws an
26.16/8.21 * UnsupportedOperationException if the iterator returned by this
26.16/8.21 * collection's iterator method does not implement the remove
26.16/8.21 * method and this collection contains the specified object.
26.16/8.21 *
26.16/8.21 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.21 * @throws ClassCastException {@inheritDoc}
26.16/8.21 * @throws NullPointerException {@inheritDoc}
26.16/8.21 */
26.16/8.21 public boolean remove(Object o) {
26.16/8.21 Iterator This implementation iterates over the specified collection,
26.16/8.21 * checking each element returned by the iterator in turn to see
26.16/8.21 * if it's contained in this collection. If all elements are so
26.16/8.21 * contained true is returned, otherwise false.
26.16/8.21 *
26.16/8.21 * @throws ClassCastException {@inheritDoc}
26.16/8.21 * @throws NullPointerException {@inheritDoc}
26.16/8.21 * @see #contains(Object)
26.16/8.21 */
26.16/8.21 public boolean containsAll(Collection c) {
26.16/8.21 Iterator e = c.iterator();
26.16/8.21 while (e.hasNext())
26.16/8.21 if (!contains(e.next()))
26.16/8.21 return false;
26.16/8.21 return true;
26.16/8.21 }
26.16/8.21
26.16/8.21 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation iterates over the specified collection, and adds
26.16/8.22 * each object returned by the iterator to this collection, in turn.
26.16/8.22 *
26.16/8.22 * Note that this implementation will throw an
26.16/8.22 * UnsupportedOperationException unless add is
26.16/8.22 * overridden (assuming the specified collection is non-empty).
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.22 * @throws IllegalStateException {@inheritDoc}
26.16/8.22 *
26.16/8.22 * @see #add(Object)
26.16/8.22 */
26.16/8.22 public boolean addAll(Collection c) {
26.16/8.22 boolean modified = false;
26.16/8.22 Iterator e = c.iterator();
26.16/8.22 while (e.hasNext()) {
26.16/8.22 if (add(e.next()))
26.16/8.22 modified = true;
26.16/8.22 }
26.16/8.22 return modified;
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation iterates over this collection, checking each
26.16/8.22 * element returned by the iterator in turn to see if it's contained
26.16/8.22 * in the specified collection. If it's so contained, it's removed from
26.16/8.22 * this collection with the iterator's remove method.
26.16/8.22 *
26.16/8.22 * Note that this implementation will throw an
26.16/8.22 * UnsupportedOperationException if the iterator returned by the
26.16/8.22 * iterator method does not implement the remove method
26.16/8.22 * and this collection contains one or more elements in common with the
26.16/8.22 * specified collection.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 *
26.16/8.22 * @see #remove(Object)
26.16/8.22 * @see #contains(Object)
26.16/8.22 */
26.16/8.22 public boolean removeAll(Collection c) {
26.16/8.22 boolean modified = false;
26.16/8.22 Iterator e = iterator();
26.16/8.22 while (e.hasNext()) {
26.16/8.22 if (c.contains(e.next())) {
26.16/8.22 e.remove();
26.16/8.22 modified = true;
26.16/8.22 }
26.16/8.22 }
26.16/8.22 return modified;
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation iterates over this collection, checking each
26.16/8.22 * element returned by the iterator in turn to see if it's contained
26.16/8.22 * in the specified collection. If it's not so contained, it's removed
26.16/8.22 * from this collection with the iterator's remove method.
26.16/8.22 *
26.16/8.22 * Note that this implementation will throw an
26.16/8.22 * UnsupportedOperationException if the iterator returned by the
26.16/8.22 * iterator method does not implement the remove method
26.16/8.22 * and this collection contains one or more elements not present in the
26.16/8.22 * specified collection.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 *
26.16/8.22 * @see #remove(Object)
26.16/8.22 * @see #contains(Object)
26.16/8.22 */
26.16/8.22 public boolean retainAll(Collection c) {
26.16/8.22 boolean modified = false;
26.16/8.22 Iterator This implementation iterates over this collection, removing each
26.16/8.22 * element using the Iterator.remove operation. Most
26.16/8.22 * implementations will probably choose to override this method for
26.16/8.22 * efficiency.
26.16/8.22 *
26.16/8.22 * Note that this implementation will throw an
26.16/8.22 * UnsupportedOperationException if the iterator returned by this
26.16/8.22 * collection's iterator method does not implement the
26.16/8.22 * remove method and this collection is non-empty.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public void clear() {
26.16/8.22 Iterator To implement an unmodifiable map, the programmer needs only to extend this
26.16/8.22 * class and provide an implementation for the entrySet method, which
26.16/8.22 * returns a set-view of the map's mappings. Typically, the returned set
26.16/8.22 * will, in turn, be implemented atop AbstractSet. This set should
26.16/8.22 * not support the add or remove methods, and its iterator
26.16/8.22 * should not support the remove method.
26.16/8.22 *
26.16/8.22 * To implement a modifiable map, the programmer must additionally override
26.16/8.22 * this class's put method (which otherwise throws an
26.16/8.22 * UnsupportedOperationException), and the iterator returned by
26.16/8.22 * entrySet().iterator() must additionally implement its
26.16/8.22 * remove method.
26.16/8.22 *
26.16/8.22 * The programmer should generally provide a void (no argument) and map
26.16/8.22 * constructor, as per the recommendation in the Map interface
26.16/8.22 * specification.
26.16/8.22 *
26.16/8.22 * The documentation for each non-abstract method in this class describes its
26.16/8.22 * implementation in detail. Each of these methods may be overridden if the
26.16/8.22 * map being implemented admits a more efficient implementation.
26.16/8.22 *
26.16/8.22 * This class is a member of the
26.16/8.22 *
26.16/8.22 * Java Collections Framework.
26.16/8.22 *
26.16/8.22 * @param This implementation returns entrySet().size().
26.16/8.22 */
26.16/8.22 public int size() {
26.16/8.22 return entrySet().size();
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation returns size() == 0.
26.16/8.22 */
26.16/8.22 public boolean isEmpty() {
26.16/8.22 return size() == 0;
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation iterates over entrySet() searching
26.16/8.22 * for an entry with the specified value. If such an entry is found,
26.16/8.22 * true is returned. If the iteration terminates without
26.16/8.22 * finding such an entry, false is returned. Note that this
26.16/8.22 * implementation requires linear time in the size of the map.
26.16/8.22 *
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public boolean containsValue(Object value) {
26.16/8.22 Iterator This implementation iterates over entrySet() searching
26.16/8.22 * for an entry with the specified key. If such an entry is found,
26.16/8.22 * true is returned. If the iteration terminates without
26.16/8.22 * finding such an entry, false is returned. Note that this
26.16/8.22 * implementation requires linear time in the size of the map; many
26.16/8.22 * implementations will override this method.
26.16/8.22 *
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public boolean containsKey(Object key) {
26.16/8.22 Iterator This implementation iterates over entrySet() searching
26.16/8.22 * for an entry with the specified key. If such an entry is found,
26.16/8.22 * the entry's value is returned. If the iteration terminates without
26.16/8.22 * finding such an entry, null is returned. Note that this
26.16/8.22 * implementation requires linear time in the size of the map; many
26.16/8.22 * implementations will override this method.
26.16/8.22 *
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public V get(Object key) {
26.16/8.22 Iterator This implementation always throws an
26.16/8.22 * UnsupportedOperationException.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public V put(K key, V value) {
26.16/8.22 throw new UnsupportedOperationException();
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation iterates over entrySet() searching for an
26.16/8.22 * entry with the specified key. If such an entry is found, its value is
26.16/8.22 * obtained with its getValue operation, the entry is removed
26.16/8.22 * from the collection (and the backing map) with the iterator's
26.16/8.22 * remove operation, and the saved value is returned. If the
26.16/8.22 * iteration terminates without finding such an entry, null is
26.16/8.22 * returned. Note that this implementation requires linear time in the
26.16/8.22 * size of the map; many implementations will override this method.
26.16/8.22 *
26.16/8.22 * Note that this implementation throws an
26.16/8.22 * UnsupportedOperationException if the entrySet
26.16/8.22 * iterator does not support the remove method and this map
26.16/8.22 * contains a mapping for the specified key.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public V remove(Object key) {
26.16/8.22 Iterator This implementation iterates over the specified map's
26.16/8.22 * entrySet() collection, and calls this map's put
26.16/8.22 * operation once for each entry returned by the iteration.
26.16/8.22 *
26.16/8.22 * Note that this implementation throws an
26.16/8.22 * UnsupportedOperationException if this map does not support
26.16/8.22 * the put operation and the specified map is nonempty.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 * @throws ClassCastException {@inheritDoc}
26.16/8.22 * @throws NullPointerException {@inheritDoc}
26.16/8.22 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public void putAll(Map m) {
26.16/8.22 Iterator it = m.entrySet().iterator();
26.16/8.22 while (it.hasNext()) {
26.16/8.22 Map.Entry e = (Map.Entry) it.next();
26.16/8.22 put((K) e.getKey(), (V) e.getValue());
26.16/8.22 }
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * {@inheritDoc}
26.16/8.22 *
26.16/8.22 * This implementation calls entrySet().clear().
26.16/8.22 *
26.16/8.22 * Note that this implementation throws an
26.16/8.22 * UnsupportedOperationException if the entrySet
26.16/8.22 * does not support the clear operation.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.22 */
26.16/8.22 public void clear() {
26.16/8.22 entrySet().clear();
26.16/8.22 }
26.16/8.22
26.16/8.22
26.16/8.22 // Views
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Each of these fields are initialized to contain an instance of the
26.16/8.22 * appropriate view the first time this view is requested. The views are
26.16/8.22 * stateless, so there's no reason to create more than one of each.
26.16/8.22 */
26.16/8.22 transient volatile Set This implementation returns a set that subclasses {@link AbstractSet}.
26.16/8.22 * The subclass's iterator method returns a "wrapper object" over this
26.16/8.22 * map's entrySet() iterator. The size method
26.16/8.22 * delegates to this map's size method and the
26.16/8.22 * contains method delegates to this map's
26.16/8.22 * containsKey method.
26.16/8.22 *
26.16/8.22 * The set is created the first time this method is called,
26.16/8.22 * and returned in response to all subsequent calls. No synchronization
26.16/8.22 * is performed, so there is a slight chance that multiple calls to this
26.16/8.22 * method will not all return the same set.
26.16/8.22 */
26.16/8.22 public Set This implementation returns a collection that subclasses {@link
26.16/8.22 * AbstractCollection}. The subclass's iterator method returns a
26.16/8.22 * "wrapper object" over this map's entrySet() iterator.
26.16/8.22 * The size method delegates to this map's size
26.16/8.22 * method and the contains method delegates to this map's
26.16/8.22 * containsValue method.
26.16/8.22 *
26.16/8.22 * The collection is created the first time this method is called, and
26.16/8.22 * returned in response to all subsequent calls. No synchronization is
26.16/8.22 * performed, so there is a slight chance that multiple calls to this
26.16/8.22 * method will not all return the same collection.
26.16/8.22 */
26.16/8.22 public Collection This implementation first checks if the specified object is this map;
26.16/8.22 * if so it returns true. Then, it checks if the specified
26.16/8.22 * object is a map whose size is identical to the size of this map; if
26.16/8.22 * not, it returns false. If so, it iterates over this map's
26.16/8.22 * entrySet collection, and checks that the specified map
26.16/8.22 * contains each mapping that this map contains. If the specified map
26.16/8.22 * fails to contain such a mapping, false is returned. If the
26.16/8.22 * iteration completes, true is returned.
26.16/8.22 *
26.16/8.22 * @param o object to be compared for equality with this map
26.16/8.22 * @return true if the specified object is equal to this map
26.16/8.22 */
26.16/8.22 public boolean equals(Object o) {
26.16/8.22 if (o == this)
26.16/8.22 return true;
26.16/8.22
26.16/8.22 if (!(o instanceof Map))
26.16/8.22 return false;
26.16/8.22 Map This implementation iterates over entrySet(), calling
26.16/8.22 * {@link Map.Entry#hashCode hashCode()} on each element (entry) in the
26.16/8.22 * set, and adding up the results.
26.16/8.22 *
26.16/8.22 * @return the hash code value for this map
26.16/8.22 * @see Map.Entry#hashCode()
26.16/8.22 * @see Object#equals(Object)
26.16/8.22 * @see Set#equals(Object)
26.16/8.22 */
26.16/8.22 public int hashCode() {
26.16/8.22 int h = 0;
26.16/8.22 Iterator
26.16/8.22 *
26.16/8.22 * The process of implementing a set by extending this class is identical
26.16/8.22 * to that of implementing a Collection by extending AbstractCollection,
26.16/8.22 * except that all of the methods and constructors in subclasses of this
26.16/8.22 * class must obey the additional constraints imposed by the Set
26.16/8.22 * interface (for instance, the add method must not permit addition of
26.16/8.22 * multiple instances of an object to a set).
26.16/8.22 *
26.16/8.22 * Note that this class does not override any of the implementations from
26.16/8.22 * the AbstractCollection class. It merely adds implementations
26.16/8.22 * for equals and hashCode.
26.16/8.22 *
26.16/8.22 * This class is a member of the
26.16/8.22 *
26.16/8.22 * Java Collections Framework.
26.16/8.22 *
26.16/8.22 * @param
26.16/8.22 *
26.16/8.22 * This implementation first checks if the specified object is this
26.16/8.22 * set; if so it returns true. Then, it checks if the
26.16/8.22 * specified object is a set whose size is identical to the size of
26.16/8.22 * this set; if not, it returns false. If so, it returns
26.16/8.22 * containsAll((Collection) o).
26.16/8.22 *
26.16/8.22 * @param o object to be compared for equality with this set
26.16/8.22 * @return true if the specified object is equal to this set
26.16/8.22 */
26.16/8.22 public boolean equals(Object o) {
26.16/8.22 if (o == this)
26.16/8.22 return true;
26.16/8.22
26.16/8.22 if (!(o instanceof Set))
26.16/8.22 return false;
26.16/8.22 Collection c = (Collection) o;
26.16/8.22 if (c.size() != size())
26.16/8.22 return false;
26.16/8.22 try {
26.16/8.22 return containsAll(c);
26.16/8.22 } catch (ClassCastException unused) {
26.16/8.22 return false;
26.16/8.22 } catch (NullPointerException unused) {
26.16/8.22 return false;
26.16/8.22 }
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns the hash code value for this set. The hash code of a set is
26.16/8.22 * defined to be the sum of the hash codes of the elements in the set,
26.16/8.22 * where the hash code of a null element is defined to be zero.
26.16/8.22 * This ensures that s1.equals(s2) implies that
26.16/8.22 * s1.hashCode()==s2.hashCode() for any two sets s1
26.16/8.22 * and s2, as required by the general contract of
26.16/8.22 * {@link Object#hashCode}.
26.16/8.22 *
26.16/8.22 * This implementation iterates over the set, calling the
26.16/8.22 * hashCode method on each element in the set, and adding up
26.16/8.22 * the results.
26.16/8.22 *
26.16/8.22 * @return the hash code value for this set
26.16/8.22 * @see Object#equals(Object)
26.16/8.22 * @see Set#equals(Object)
26.16/8.22 */
26.16/8.22 public int hashCode() {
26.16/8.22 int h = 0;
26.16/8.22 Iterator This implementation determines which is the smaller of this set
26.16/8.22 * and the specified collection, by invoking the size
26.16/8.22 * method on each. If this set has fewer elements, then the
26.16/8.22 * implementation iterates over this set, checking each element
26.16/8.22 * returned by the iterator in turn to see if it is contained in
26.16/8.22 * the specified collection. If it is so contained, it is removed
26.16/8.22 * from this set with the iterator's remove method. If
26.16/8.22 * the specified collection has fewer elements, then the
26.16/8.22 * implementation iterates over the specified collection, removing
26.16/8.22 * from this set each element returned by the iterator, using this
26.16/8.22 * set's remove method.
26.16/8.22 *
26.16/8.22 * Note that this implementation will throw an
26.16/8.22 * UnsupportedOperationException if the iterator returned by the
26.16/8.22 * iterator method does not implement the remove method.
26.16/8.22 *
26.16/8.22 * @param c collection containing elements to be removed from this set
26.16/8.22 * @return true if this set changed as a result of the call
26.16/8.22 * @throws UnsupportedOperationException if the removeAll operation
26.16/8.22 * is not supported by this set
26.16/8.22 * @throws ClassCastException if the class of an element of this set
26.16/8.22 * is incompatible with the specified collection (optional)
26.16/8.22 * @throws NullPointerException if this set contains a null element and the
26.16/8.22 * specified collection does not permit null elements (optional),
26.16/8.22 * or if the specified collection is null
26.16/8.22 * @see #remove(Object)
26.16/8.22 * @see #contains(Object)
26.16/8.22 */
26.16/8.22 public boolean removeAll(Collection c) {
26.16/8.22 boolean modified = false;
26.16/8.22
26.16/8.22 if (size() > c.size()) {
26.16/8.22 for (Iterator i = c.iterator(); i.hasNext(); )
26.16/8.22 modified |= remove(i.next());
26.16/8.22 } else {
26.16/8.22 for (Iterator i = iterator(); i.hasNext(); ) {
26.16/8.22 if (c.contains(i.next())) {
26.16/8.22 i.remove();
26.16/8.22 modified = true;
26.16/8.22 }
26.16/8.22 }
26.16/8.22 }
26.16/8.22 return modified;
26.16/8.22 }
26.16/8.22
26.16/8.22 }
26.16/8.22
26.16/8.22
26.16/8.22 /*
26.16/8.22 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.22 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.22 *
26.16/8.22 * This code is free software; you can redistribute it and/or modify it
26.16/8.22 * under the terms of the GNU General Public License version 2 only, as
26.16/8.22 * published by the Free Software Foundation. Sun designates this
26.16/8.22 * particular file as subject to the "Classpath" exception as provided
26.16/8.22 * by Sun in the LICENSE file that accompanied this code.
26.16/8.22 *
26.16/8.22 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.22 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.22 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.22 * accompanied this code).
26.16/8.22 *
26.16/8.22 * You should have received a copy of the GNU General Public License version
26.16/8.22 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.22 *
26.16/8.22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.22 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.22 * have any questions.
26.16/8.22 */
26.16/8.22
26.16/8.22 package javaUtilEx;
26.16/8.22
26.16/8.22 /**
26.16/8.22 * The root interface in the collection hierarchy. A collection
26.16/8.22 * represents a group of objects, known as its elements. Some
26.16/8.22 * collections allow duplicate elements and others do not. Some are ordered
26.16/8.22 * and others unordered. The JDK does not provide any direct
26.16/8.22 * implementations of this interface: it provides implementations of more
26.16/8.22 * specific subinterfaces like Set and List. This interface
26.16/8.22 * is typically used to pass collections around and manipulate them where
26.16/8.22 * maximum generality is desired.
26.16/8.22 *
26.16/8.22 * Bags or multisets (unordered collections that may contain
26.16/8.22 * duplicate elements) should implement this interface directly.
26.16/8.22 *
26.16/8.22 * All general-purpose Collection implementation classes (which
26.16/8.22 * typically implement Collection indirectly through one of its
26.16/8.22 * subinterfaces) should provide two "standard" constructors: a void (no
26.16/8.22 * arguments) constructor, which creates an empty collection, and a
26.16/8.22 * constructor with a single argument of type Collection, which
26.16/8.22 * creates a new collection with the same elements as its argument. In
26.16/8.22 * effect, the latter constructor allows the user to copy any collection,
26.16/8.22 * producing an equivalent collection of the desired implementation type.
26.16/8.22 * There is no way to enforce this convention (as interfaces cannot contain
26.16/8.22 * constructors) but all of the general-purpose Collection
26.16/8.22 * implementations in the Java platform libraries comply.
26.16/8.22 *
26.16/8.22 * The "destructive" methods contained in this interface, that is, the
26.16/8.22 * methods that modify the collection on which they operate, are specified to
26.16/8.22 * throw UnsupportedOperationException if this collection does not
26.16/8.22 * support the operation. If this is the case, these methods may, but are not
26.16/8.22 * required to, throw an UnsupportedOperationException if the
26.16/8.22 * invocation would have no effect on the collection. For example, invoking
26.16/8.22 * the {@link #addAll(Collection)} method on an unmodifiable collection may,
26.16/8.22 * but is not required to, throw the exception if the collection to be added
26.16/8.22 * is empty.
26.16/8.22 *
26.16/8.22 * Some collection implementations have restrictions on the elements that
26.16/8.22 * they may contain. For example, some implementations prohibit null elements,
26.16/8.22 * and some have restrictions on the types of their elements. Attempting to
26.16/8.22 * add an ineligible element throws an unchecked exception, typically
26.16/8.22 * NullPointerException or ClassCastException. Attempting
26.16/8.22 * to query the presence of an ineligible element may throw an exception,
26.16/8.22 * or it may simply return false; some implementations will exhibit the former
26.16/8.22 * behavior and some will exhibit the latter. More generally, attempting an
26.16/8.22 * operation on an ineligible element whose completion would not result in
26.16/8.22 * the insertion of an ineligible element into the collection may throw an
26.16/8.22 * exception or it may succeed, at the option of the implementation.
26.16/8.22 * Such exceptions are marked as "optional" in the specification for this
26.16/8.22 * interface.
26.16/8.22 *
26.16/8.22 * It is up to each collection to determine its own synchronization
26.16/8.22 * policy. In the absence of a stronger guarantee by the
26.16/8.22 * implementation, undefined behavior may result from the invocation
26.16/8.22 * of any method on a collection that is being mutated by another
26.16/8.22 * thread; this includes direct invocations, passing the collection to
26.16/8.22 * a method that might perform invocations, and using an existing
26.16/8.22 * iterator to examine the collection.
26.16/8.22 *
26.16/8.22 * Many methods in Collections Framework interfaces are defined in
26.16/8.22 * terms of the {@link Object#equals(Object) equals} method. For example,
26.16/8.22 * the specification for the {@link #contains(Object) contains(Object o)}
26.16/8.22 * method says: "returns true if and only if this collection
26.16/8.22 * contains at least one element e such that
26.16/8.22 * (o==null ? e==null : o.equals(e))." This specification should
26.16/8.22 * not be construed to imply that invoking Collection.contains
26.16/8.22 * with a non-null argument o will cause o.equals(e) to be
26.16/8.22 * invoked for any element e. Implementations are free to implement
26.16/8.22 * optimizations whereby the equals invocation is avoided, for
26.16/8.22 * example, by first comparing the hash codes of the two elements. (The
26.16/8.22 * {@link Object#hashCode()} specification guarantees that two objects with
26.16/8.22 * unequal hash codes cannot be equal.) More generally, implementations of
26.16/8.22 * the various Collections Framework interfaces are free to take advantage of
26.16/8.22 * the specified behavior of underlying {@link Object} methods wherever the
26.16/8.22 * implementor deems it appropriate.
26.16/8.22 *
26.16/8.22 * This interface is a member of the
26.16/8.22 *
26.16/8.22 * Java Collections Framework.
26.16/8.22 *
26.16/8.22 * @author Josh Bloch
26.16/8.22 * @author Neal Gafter
26.16/8.22 * @see Set
26.16/8.22 * @see List
26.16/8.22 * @see Map
26.16/8.22 * @see SortedSet
26.16/8.22 * @see SortedMap
26.16/8.22 * @see HashSet
26.16/8.22 * @see TreeSet
26.16/8.22 * @see ArrayList
26.16/8.22 * @see LinkedList
26.16/8.22 * @see Vector
26.16/8.22 * @see Collections
26.16/8.22 * @see Arrays
26.16/8.22 * @see AbstractCollection
26.16/8.22 * @since 1.2
26.16/8.22 */
26.16/8.22
26.16/8.22 public interface Collection
26.16/8.22 *
26.16/8.22 * Collections that support this operation may place limitations on what
26.16/8.22 * elements may be added to this collection. In particular, some
26.16/8.22 * collections will refuse to add null elements, and others will
26.16/8.22 * impose restrictions on the type of elements that may be added.
26.16/8.22 * Collection classes should clearly specify in their documentation any
26.16/8.22 * restrictions on what elements may be added.
26.16/8.22 *
26.16/8.22 * If a collection refuses to add a particular element for any reason
26.16/8.22 * other than that it already contains the element, it must throw
26.16/8.22 * an exception (rather than returning false). This preserves
26.16/8.22 * the invariant that a collection always contains the specified element
26.16/8.22 * after this call returns.
26.16/8.22 *
26.16/8.22 * @param e element whose presence in this collection is to be ensured
26.16/8.22 * @return true if this collection changed as a result of the
26.16/8.22 * call
26.16/8.22 * @throws UnsupportedOperationException if the add operation
26.16/8.22 * is not supported by this collection
26.16/8.22 * @throws ClassCastException if the class of the specified element
26.16/8.22 * prevents it from being added to this collection
26.16/8.22 * @throws NullPointerException if the specified element is null and this
26.16/8.22 * collection does not permit null elements
26.16/8.22 * @throws IllegalArgumentException if some property of the element
26.16/8.22 * prevents it from being added to this collection
26.16/8.22 * @throws IllegalStateException if the element cannot be added at this
26.16/8.22 * time due to insertion restrictions
26.16/8.22 */
26.16/8.22 boolean add(E e);
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Removes a single instance of the specified element from this
26.16/8.22 * collection, if it is present (optional operation). More formally,
26.16/8.22 * removes an element e such that
26.16/8.22 * (o==null ? e==null : o.equals(e)), if
26.16/8.22 * this collection contains one or more such elements. Returns
26.16/8.22 * true if this collection contained the specified element (or
26.16/8.22 * equivalently, if this collection changed as a result of the call).
26.16/8.22 *
26.16/8.22 * @param o element to be removed from this collection, if present
26.16/8.22 * @return true if an element was removed as a result of this call
26.16/8.22 * @throws ClassCastException if the type of the specified element
26.16/8.22 * is incompatible with this collection (optional)
26.16/8.22 * @throws NullPointerException if the specified element is null and this
26.16/8.22 * collection does not permit null elements (optional)
26.16/8.22 * @throws UnsupportedOperationException if the remove operation
26.16/8.22 * is not supported by this collection
26.16/8.22 */
26.16/8.22 boolean remove(Object o);
26.16/8.22
26.16/8.22
26.16/8.22 // Bulk Operations
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns true if this collection contains all of the elements
26.16/8.22 * in the specified collection.
26.16/8.22 *
26.16/8.22 * @param c collection to be checked for containment in this collection
26.16/8.22 * @return true if this collection contains all of the elements
26.16/8.22 * in the specified collection
26.16/8.22 * @throws ClassCastException if the types of one or more elements
26.16/8.22 * in the specified collection are incompatible with this
26.16/8.22 * collection (optional)
26.16/8.22 * @throws NullPointerException if the specified collection contains one
26.16/8.22 * or more null elements and this collection does not permit null
26.16/8.22 * elements (optional), or if the specified collection is null
26.16/8.22 * @see #contains(Object)
26.16/8.22 */
26.16/8.22 boolean containsAll(Collection c);
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Adds all of the elements in the specified collection to this collection
26.16/8.22 * (optional operation). The behavior of this operation is undefined if
26.16/8.22 * the specified collection is modified while the operation is in progress.
26.16/8.22 * (This implies that the behavior of this call is undefined if the
26.16/8.22 * specified collection is this collection, and this collection is
26.16/8.22 * nonempty.)
26.16/8.22 *
26.16/8.22 * @param c collection containing elements to be added to this collection
26.16/8.22 * @return true if this collection changed as a result of the call
26.16/8.22 * @throws UnsupportedOperationException if the addAll operation
26.16/8.22 * is not supported by this collection
26.16/8.22 * @throws ClassCastException if the class of an element of the specified
26.16/8.22 * collection prevents it from being added to this collection
26.16/8.22 * @throws NullPointerException if the specified collection contains a
26.16/8.22 * null element and this collection does not permit null elements,
26.16/8.22 * or if the specified collection is null
26.16/8.22 * @throws IllegalArgumentException if some property of an element of the
26.16/8.22 * specified collection prevents it from being added to this
26.16/8.22 * collection
26.16/8.22 * @throws IllegalStateException if not all the elements can be added at
26.16/8.22 * this time due to insertion restrictions
26.16/8.22 * @see #add(Object)
26.16/8.22 */
26.16/8.22 boolean addAll(Collection c);
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Removes all of this collection's elements that are also contained in the
26.16/8.22 * specified collection (optional operation). After this call returns,
26.16/8.22 * this collection will contain no elements in common with the specified
26.16/8.22 * collection.
26.16/8.22 *
26.16/8.22 * @param c collection containing elements to be removed from this collection
26.16/8.22 * @return true if this collection changed as a result of the
26.16/8.22 * call
26.16/8.22 * @throws UnsupportedOperationException if the removeAll method
26.16/8.22 * is not supported by this collection
26.16/8.22 * @throws ClassCastException if the types of one or more elements
26.16/8.22 * in this collection are incompatible with the specified
26.16/8.22 * collection (optional)
26.16/8.22 * @throws NullPointerException if this collection contains one or more
26.16/8.22 * null elements and the specified collection does not support
26.16/8.22 * null elements (optional), or if the specified collection is null
26.16/8.22 * @see #remove(Object)
26.16/8.22 * @see #contains(Object)
26.16/8.22 */
26.16/8.22 boolean removeAll(Collection c);
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Retains only the elements in this collection that are contained in the
26.16/8.22 * specified collection (optional operation). In other words, removes from
26.16/8.22 * this collection all of its elements that are not contained in the
26.16/8.22 * specified collection.
26.16/8.22 *
26.16/8.22 * @param c collection containing elements to be retained in this collection
26.16/8.22 * @return true if this collection changed as a result of the call
26.16/8.22 * @throws UnsupportedOperationException if the retainAll operation
26.16/8.22 * is not supported by this collection
26.16/8.22 * @throws ClassCastException if the types of one or more elements
26.16/8.22 * in this collection are incompatible with the specified
26.16/8.22 * collection (optional)
26.16/8.22 * @throws NullPointerException if this collection contains one or more
26.16/8.22 * null elements and the specified collection does not permit null
26.16/8.22 * elements (optional), or if the specified collection is null
26.16/8.22 * @see #remove(Object)
26.16/8.22 * @see #contains(Object)
26.16/8.22 */
26.16/8.22 boolean retainAll(Collection c);
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Removes all of the elements from this collection (optional operation).
26.16/8.22 * The collection will be empty after this method returns.
26.16/8.22 *
26.16/8.22 * @throws UnsupportedOperationException if the clear operation
26.16/8.22 * is not supported by this collection
26.16/8.22 */
26.16/8.22 void clear();
26.16/8.22
26.16/8.22
26.16/8.22 // Comparison and hashing
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Compares the specified object with this collection for equality.
26.16/8.22 *
26.16/8.22 * While the Collection interface adds no stipulations to the
26.16/8.22 * general contract for the Object.equals, programmers who
26.16/8.22 * implement the Collection interface "directly" (in other words,
26.16/8.22 * create a class that is a Collection but is not a Set
26.16/8.22 * or a List) must exercise care if they choose to override the
26.16/8.22 * Object.equals. It is not necessary to do so, and the simplest
26.16/8.22 * course of action is to rely on Object's implementation, but
26.16/8.22 * the implementor may wish to implement a "value comparison" in place of
26.16/8.22 * the default "reference comparison." (The List and
26.16/8.22 * Set interfaces mandate such value comparisons.)
26.16/8.22 *
26.16/8.22 * The general contract for the Object.equals method states that
26.16/8.22 * equals must be symmetric (in other words, a.equals(b) if and
26.16/8.22 * only if b.equals(a)). The contracts for List.equals
26.16/8.22 * and Set.equals state that lists are only equal to other lists,
26.16/8.22 * and sets to other sets. Thus, a custom equals method for a
26.16/8.22 * collection class that implements neither the List nor
26.16/8.22 * Set interface must return false when this collection
26.16/8.22 * is compared to any list or set. (By the same logic, it is not possible
26.16/8.22 * to write a class that correctly implements both the Set and
26.16/8.22 * List interfaces.)
26.16/8.22 *
26.16/8.22 * @param o object to be compared for equality with this collection
26.16/8.22 * @return true if the specified object is equal to this
26.16/8.22 * collection
26.16/8.22 *
26.16/8.22 * @see Object#equals(Object)
26.16/8.22 * @see Set#equals(Object)
26.16/8.22 * @see List#equals(Object)
26.16/8.22 */
26.16/8.22 boolean equals(Object o);
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns the hash code value for this collection. While the
26.16/8.22 * Collection interface adds no stipulations to the general
26.16/8.22 * contract for the Object.hashCode method, programmers should
26.16/8.22 * take note that any class that overrides the Object.equals
26.16/8.22 * method must also override the Object.hashCode method in order
26.16/8.22 * to satisfy the general contract for the Object.hashCodemethod.
26.16/8.22 * In particular, c1.equals(c2) implies that
26.16/8.22 * c1.hashCode()==c2.hashCode().
26.16/8.22 *
26.16/8.22 * @return the hash code value for this collection
26.16/8.22 *
26.16/8.22 * @see Object#hashCode()
26.16/8.22 * @see Object#equals(Object)
26.16/8.22 */
26.16/8.22 int hashCode();
26.16/8.22 }
26.16/8.22
26.16/8.22
26.16/8.22 /*
26.16/8.22 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.22 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.22 *
26.16/8.22 * This code is free software; you can redistribute it and/or modify it
26.16/8.22 * under the terms of the GNU General Public License version 2 only, as
26.16/8.22 * published by the Free Software Foundation. Sun designates this
26.16/8.22 * particular file as subject to the "Classpath" exception as provided
26.16/8.22 * by Sun in the LICENSE file that accompanied this code.
26.16/8.22 *
26.16/8.22 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.22 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.22 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.22 * accompanied this code).
26.16/8.22 *
26.16/8.22 * You should have received a copy of the GNU General Public License version
26.16/8.22 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.22 *
26.16/8.22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.22 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.22 * have any questions.
26.16/8.22 */
26.16/8.22
26.16/8.22 package javaUtilEx;
26.16/8.22
26.16/8.22 /**
26.16/8.22 * This exception may be thrown by methods that have detected concurrent
26.16/8.22 * modification of an object when such modification is not permissible.
26.16/8.22 *
26.16/8.22 * For example, it is not generally permissible for one thread to modify a Collection
26.16/8.22 * while another thread is iterating over it. In general, the results of the
26.16/8.22 * iteration are undefined under these circumstances. Some Iterator
26.16/8.22 * implementations (including those of all the general purpose collection implementations
26.16/8.22 * provided by the JRE) may choose to throw this exception if this behavior is
26.16/8.22 * detected. Iterators that do this are known as fail-fast iterators,
26.16/8.22 * as they fail quickly and cleanly, rather that risking arbitrary,
26.16/8.22 * non-deterministic behavior at an undetermined time in the future.
26.16/8.22 *
26.16/8.22 * Note that this exception does not always indicate that an object has
26.16/8.22 * been concurrently modified by a different thread. If a single
26.16/8.22 * thread issues a sequence of method invocations that violates the
26.16/8.22 * contract of an object, the object may throw this exception. For
26.16/8.22 * example, if a thread modifies a collection directly while it is
26.16/8.22 * iterating over the collection with a fail-fast iterator, the iterator
26.16/8.22 * will throw this exception.
26.16/8.22 *
26.16/8.22 * Note that fail-fast behavior cannot be guaranteed as it is, generally
26.16/8.22 * speaking, impossible to make any hard guarantees in the presence of
26.16/8.22 * unsynchronized concurrent modification. Fail-fast operations
26.16/8.22 * throw ConcurrentModificationException on a best-effort basis.
26.16/8.22 * Therefore, it would be wrong to write a program that depended on this
26.16/8.22 * exception for its correctness: ConcurrentModificationException
26.16/8.22 * should be used only to detect bugs.
26.16/8.22 *
26.16/8.22 * @author Josh Bloch
26.16/8.22 * @see Collection
26.16/8.22 * @see Iterator
26.16/8.22 * @see ListIterator
26.16/8.22 * @see Vector
26.16/8.22 * @see LinkedList
26.16/8.22 * @see HashSet
26.16/8.22 * @see Hashtable
26.16/8.22 * @see TreeMap
26.16/8.22 * @see AbstractList
26.16/8.22 * @since 1.2
26.16/8.22 */
26.16/8.22 public class ConcurrentModificationException extends RuntimeException {
26.16/8.22 /**
26.16/8.22 * Constructs a ConcurrentModificationException with no
26.16/8.22 * detail message.
26.16/8.22 */
26.16/8.22 public ConcurrentModificationException() {
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Constructs a ConcurrentModificationException with the
26.16/8.22 * specified detail message.
26.16/8.22 *
26.16/8.22 * @param message the detail message pertaining to this exception.
26.16/8.22 */
26.16/8.22 public ConcurrentModificationException(String message) {
26.16/8.22 super(message);
26.16/8.22 }
26.16/8.22 }
26.16/8.22
26.16/8.22
26.16/8.22 /*
26.16/8.22 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.22 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.22 *
26.16/8.22 * This code is free software; you can redistribute it and/or modify it
26.16/8.22 * under the terms of the GNU General Public License version 2 only, as
26.16/8.22 * published by the Free Software Foundation. Sun designates this
26.16/8.22 * particular file as subject to the "Classpath" exception as provided
26.16/8.22 * by Sun in the LICENSE file that accompanied this code.
26.16/8.22 *
26.16/8.22 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.22 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.22 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.22 * accompanied this code).
26.16/8.22 *
26.16/8.22 * You should have received a copy of the GNU General Public License version
26.16/8.22 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.22 *
26.16/8.22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.22 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.22 * have any questions.
26.16/8.22 */
26.16/8.22
26.16/8.22 package javaUtilEx;
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Hash table based implementation of the Map interface. This
26.16/8.22 * implementation provides all of the optional map operations, and permits
26.16/8.22 * null values and the null key. (The HashMap
26.16/8.22 * class is roughly equivalent to Hashtable, except that it is
26.16/8.22 * unsynchronized and permits nulls.) This class makes no guarantees as to
26.16/8.22 * the order of the map; in particular, it does not guarantee that the order
26.16/8.22 * will remain constant over time.
26.16/8.22 *
26.16/8.22 * This implementation provides constant-time performance for the basic
26.16/8.22 * operations (get and put), assuming the hash function
26.16/8.22 * disperses the elements properly among the buckets. Iteration over
26.16/8.22 * collection views requires time proportional to the "capacity" of the
26.16/8.22 * HashMap instance (the number of buckets) plus its size (the number
26.16/8.22 * of key-value mappings). Thus, it's very important not to set the initial
26.16/8.22 * capacity too high (or the load factor too low) if iteration performance is
26.16/8.22 * important.
26.16/8.22 *
26.16/8.22 * An instance of HashMap has two parameters that affect its
26.16/8.22 * performance: initial capacity and load factor. The
26.16/8.22 * capacity is the number of buckets in the hash table, and the initial
26.16/8.22 * capacity is simply the capacity at the time the hash table is created. The
26.16/8.22 * load factor is a measure of how full the hash table is allowed to
26.16/8.22 * get before its capacity is automatically increased. When the number of
26.16/8.22 * entries in the hash table exceeds the product of the load factor and the
26.16/8.22 * current capacity, the hash table is rehashed (that is, internal data
26.16/8.22 * structures are rebuilt) so that the hash table has approximately twice the
26.16/8.22 * number of buckets.
26.16/8.22 *
26.16/8.22 * As a general rule, the default load factor (.75) offers a good tradeoff
26.16/8.22 * between time and space costs. Higher values decrease the space overhead
26.16/8.22 * but increase the lookup cost (reflected in most of the operations of the
26.16/8.22 * HashMap class, including get and put). The
26.16/8.22 * expected number of entries in the map and its load factor should be taken
26.16/8.22 * into account when setting its initial capacity, so as to minimize the
26.16/8.22 * number of rehash operations. If the initial capacity is greater
26.16/8.22 * than the maximum number of entries divided by the load factor, no
26.16/8.22 * rehash operations will ever occur.
26.16/8.22 *
26.16/8.22 * If many mappings are to be stored in a HashMap instance,
26.16/8.22 * creating it with a sufficiently large capacity will allow the mappings to
26.16/8.22 * be stored more efficiently than letting it perform automatic rehashing as
26.16/8.22 * needed to grow the table.
26.16/8.22 *
26.16/8.22 * Note that this implementation is not synchronized.
26.16/8.22 * If multiple threads access a hash map concurrently, and at least one of
26.16/8.22 * the threads modifies the map structurally, it must be
26.16/8.22 * synchronized externally. (A structural modification is any operation
26.16/8.22 * that adds or deletes one or more mappings; merely changing the value
26.16/8.22 * associated with a key that an instance already contains is not a
26.16/8.22 * structural modification.) This is typically accomplished by
26.16/8.22 * synchronizing on some object that naturally encapsulates the map.
26.16/8.22 *
26.16/8.22 * If no such object exists, the map should be "wrapped" using the
26.16/8.22 * {@link Collections#synchronizedMap Collections.synchronizedMap}
26.16/8.22 * method. This is best done at creation time, to prevent accidental
26.16/8.22 * unsynchronized access to the map: The iterators returned by all of this class's "collection view methods"
26.16/8.22 * are fail-fast: if the map is structurally modified at any time after
26.16/8.22 * the iterator is created, in any way except through the iterator's own
26.16/8.22 * remove method, the iterator will throw a
26.16/8.22 * {@link ConcurrentModificationException}. Thus, in the face of concurrent
26.16/8.22 * modification, the iterator fails quickly and cleanly, rather than risking
26.16/8.22 * arbitrary, non-deterministic behavior at an undetermined time in the
26.16/8.22 * future.
26.16/8.22 *
26.16/8.22 * Note that the fail-fast behavior of an iterator cannot be guaranteed
26.16/8.22 * as it is, generally speaking, impossible to make any hard guarantees in the
26.16/8.22 * presence of unsynchronized concurrent modification. Fail-fast iterators
26.16/8.22 * throw ConcurrentModificationException on a best-effort basis.
26.16/8.22 * Therefore, it would be wrong to write a program that depended on this
26.16/8.22 * exception for its correctness: the fail-fast behavior of iterators
26.16/8.22 * should be used only to detect bugs.
26.16/8.22 *
26.16/8.22 * This class is a member of the
26.16/8.22 *
26.16/8.22 * Java Collections Framework.
26.16/8.22 *
26.16/8.22 * @param More formally, if this map contains a mapping from a key
26.16/8.22 * {@code k} to a value {@code v} such that {@code (key==null ? k==null :
26.16/8.22 * key.equals(k))}, then this method returns {@code v}; otherwise
26.16/8.22 * it returns {@code null}. (There can be at most one such mapping.)
26.16/8.22 *
26.16/8.22 * A return value of {@code null} does not necessarily
26.16/8.22 * indicate that the map contains no mapping for the key; it's also
26.16/8.22 * possible that the map explicitly maps the key to {@code null}.
26.16/8.22 * The {@link #containsKey containsKey} operation may be used to
26.16/8.22 * distinguish these two cases.
26.16/8.22 *
26.16/8.22 * @see #put(Object, Object)
26.16/8.22 */
26.16/8.22 public V get(Object key) {
26.16/8.22 if (key == null)
26.16/8.22 return getForNullKey();
26.16/8.22 int hash = hash(key.hashCode());
26.16/8.22 for (Entry Note that the detail message associated with Note that the detail message associated with This interface is a member of the
26.16/8.23 *
26.16/8.23 * Java Collections Framework.
26.16/8.23 *
26.16/8.23 * @author Josh Bloch
26.16/8.23 * @see Collection
26.16/8.23 * @see ListIterator
26.16/8.23 * @see Iterable
26.16/8.23 * @since 1.2
26.16/8.23 */
26.16/8.23 public interface Iterator This interface takes the place of the Dictionary class, which
26.16/8.23 * was a totally abstract class rather than an interface.
26.16/8.23 *
26.16/8.23 * The Map interface provides three collection views, which
26.16/8.23 * allow a map's contents to be viewed as a set of keys, collection of values,
26.16/8.23 * or set of key-value mappings. The order of a map is defined as
26.16/8.23 * the order in which the iterators on the map's collection views return their
26.16/8.23 * elements. Some map implementations, like the TreeMap class, make
26.16/8.23 * specific guarantees as to their order; others, like the HashMap
26.16/8.23 * class, do not.
26.16/8.23 *
26.16/8.23 * Note: great care must be exercised if mutable objects are used as map
26.16/8.23 * keys. The behavior of a map is not specified if the value of an object is
26.16/8.23 * changed in a manner that affects equals comparisons while the
26.16/8.23 * object is a key in the map. A special case of this prohibition is that it
26.16/8.23 * is not permissible for a map to contain itself as a key. While it is
26.16/8.23 * permissible for a map to contain itself as a value, extreme caution is
26.16/8.23 * advised: the equals and hashCode methods are no longer
26.16/8.23 * well defined on such a map.
26.16/8.23 *
26.16/8.23 * All general-purpose map implementation classes should provide two
26.16/8.23 * "standard" constructors: a void (no arguments) constructor which creates an
26.16/8.23 * empty map, and a constructor with a single argument of type Map,
26.16/8.23 * which creates a new map with the same key-value mappings as its argument.
26.16/8.23 * In effect, the latter constructor allows the user to copy any map,
26.16/8.23 * producing an equivalent map of the desired class. There is no way to
26.16/8.23 * enforce this recommendation (as interfaces cannot contain constructors) but
26.16/8.23 * all of the general-purpose map implementations in the JDK comply.
26.16/8.23 *
26.16/8.23 * The "destructive" methods contained in this interface, that is, the
26.16/8.23 * methods that modify the map on which they operate, are specified to throw
26.16/8.23 * UnsupportedOperationException if this map does not support the
26.16/8.23 * operation. If this is the case, these methods may, but are not required
26.16/8.23 * to, throw an UnsupportedOperationException if the invocation would
26.16/8.23 * have no effect on the map. For example, invoking the {@link #putAll(Map)}
26.16/8.23 * method on an unmodifiable map may, but is not required to, throw the
26.16/8.23 * exception if the map whose mappings are to be "superimposed" is empty.
26.16/8.23 *
26.16/8.23 * Some map implementations have restrictions on the keys and values they
26.16/8.23 * may contain. For example, some implementations prohibit null keys and
26.16/8.23 * values, and some have restrictions on the types of their keys. Attempting
26.16/8.23 * to insert an ineligible key or value throws an unchecked exception,
26.16/8.23 * typically NullPointerException or ClassCastException.
26.16/8.23 * Attempting to query the presence of an ineligible key or value may throw an
26.16/8.23 * exception, or it may simply return false; some implementations will exhibit
26.16/8.23 * the former behavior and some will exhibit the latter. More generally,
26.16/8.23 * attempting an operation on an ineligible key or value whose completion
26.16/8.23 * would not result in the insertion of an ineligible element into the map may
26.16/8.23 * throw an exception or it may succeed, at the option of the implementation.
26.16/8.23 * Such exceptions are marked as "optional" in the specification for this
26.16/8.23 * interface.
26.16/8.23 *
26.16/8.23 * This interface is a member of the
26.16/8.23 *
26.16/8.23 * Java Collections Framework.
26.16/8.23 *
26.16/8.23 * Many methods in Collections Framework interfaces are defined
26.16/8.23 * in terms of the {@link Object#equals(Object) equals} method. For
26.16/8.23 * example, the specification for the {@link #containsKey(Object)
26.16/8.23 * containsKey(Object key)} method says: "returns true if and
26.16/8.23 * only if this map contains a mapping for a key k such that
26.16/8.23 * (key==null ? k==null : key.equals(k))." This specification should
26.16/8.23 * not be construed to imply that invoking Map.containsKey
26.16/8.23 * with a non-null argument key will cause key.equals(k) to
26.16/8.23 * be invoked for any key k. Implementations are free to
26.16/8.23 * implement optimizations whereby the equals invocation is avoided,
26.16/8.23 * for example, by first comparing the hash codes of the two keys. (The
26.16/8.23 * {@link Object#hashCode()} specification guarantees that two objects with
26.16/8.23 * unequal hash codes cannot be equal.) More generally, implementations of
26.16/8.23 * the various Collections Framework interfaces are free to take advantage of
26.16/8.23 * the specified behavior of underlying {@link Object} methods wherever the
26.16/8.23 * implementor deems it appropriate.
26.16/8.23 *
26.16/8.23 * @param More formally, if this map contains a mapping from a key
26.16/8.23 * {@code k} to a value {@code v} such that {@code (key==null ? k==null :
26.16/8.23 * key.equals(k))}, then this method returns {@code v}; otherwise
26.16/8.23 * it returns {@code null}. (There can be at most one such mapping.)
26.16/8.23 *
26.16/8.23 * If this map permits null values, then a return value of
26.16/8.23 * {@code null} does not necessarily indicate that the map
26.16/8.23 * contains no mapping for the key; it's also possible that the map
26.16/8.23 * explicitly maps the key to {@code null}. The {@link #containsKey
26.16/8.23 * containsKey} operation may be used to distinguish these two cases.
26.16/8.23 *
26.16/8.23 * @param key the key whose associated value is to be returned
26.16/8.23 * @return the value to which the specified key is mapped, or
26.16/8.23 * {@code null} if this map contains no mapping for the key
26.16/8.23 * @throws ClassCastException if the key is of an inappropriate type for
26.16/8.23 * this map (optional)
26.16/8.23 * @throws NullPointerException if the specified key is null and this map
26.16/8.23 * does not permit null keys (optional)
26.16/8.23 */
26.16/8.23 V get(Object key);
26.16/8.23
26.16/8.23 // Modification Operations
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Associates the specified value with the specified key in this map
26.16/8.23 * (optional operation). If the map previously contained a mapping for
26.16/8.23 * the key, the old value is replaced by the specified value. (A map
26.16/8.23 * m is said to contain a mapping for a key k if and only
26.16/8.23 * if {@link #containsKey(Object) m.containsKey(k)} would return
26.16/8.23 * true.)
26.16/8.23 *
26.16/8.23 * @param key key with which the specified value is to be associated
26.16/8.23 * @param value value to be associated with the specified key
26.16/8.23 * @return the previous value associated with key, or
26.16/8.23 * null if there was no mapping for key.
26.16/8.23 * (A null return can also indicate that the map
26.16/8.23 * previously associated null with key,
26.16/8.23 * if the implementation supports null values.)
26.16/8.23 * @throws UnsupportedOperationException if the put operation
26.16/8.23 * is not supported by this map
26.16/8.23 * @throws ClassCastException if the class of the specified key or value
26.16/8.23 * prevents it from being stored in this map
26.16/8.23 * @throws NullPointerException if the specified key or value is null
26.16/8.23 * and this map does not permit null keys or values
26.16/8.23 * @throws IllegalArgumentException if some property of the specified key
26.16/8.23 * or value prevents it from being stored in this map
26.16/8.23 */
26.16/8.23 V put(K key, V value);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Removes the mapping for a key from this map if it is present
26.16/8.23 * (optional operation). More formally, if this map contains a mapping
26.16/8.23 * from key k to value v such that
26.16/8.23 * Returns the value to which this map previously associated the key,
26.16/8.23 * or null if the map contained no mapping for the key.
26.16/8.23 *
26.16/8.23 * If this map permits null values, then a return value of
26.16/8.23 * null does not necessarily indicate that the map
26.16/8.23 * contained no mapping for the key; it's also possible that the map
26.16/8.23 * explicitly mapped the key to null.
26.16/8.23 *
26.16/8.23 * The map will not contain a mapping for the specified key once the
26.16/8.23 * call returns.
26.16/8.23 *
26.16/8.23 * @param key key whose mapping is to be removed from the map
26.16/8.23 * @return the previous value associated with key, or
26.16/8.23 * null if there was no mapping for key.
26.16/8.23 * @throws UnsupportedOperationException if the remove operation
26.16/8.23 * is not supported by this map
26.16/8.23 * @throws ClassCastException if the key is of an inappropriate type for
26.16/8.23 * this map (optional)
26.16/8.23 * @throws NullPointerException if the specified key is null and this
26.16/8.23 * map does not permit null keys (optional)
26.16/8.23 */
26.16/8.23 V remove(Object key);
26.16/8.23
26.16/8.23
26.16/8.23 // Bulk Operations
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Copies all of the mappings from the specified map to this map
26.16/8.23 * (optional operation). The effect of this call is equivalent to that
26.16/8.23 * of calling {@link #put(Object,Object) put(k, v)} on this map once
26.16/8.23 * for each mapping from key k to value v in the
26.16/8.23 * specified map. The behavior of this operation is undefined if the
26.16/8.23 * specified map is modified while the operation is in progress.
26.16/8.23 *
26.16/8.23 * @param m mappings to be stored in this map
26.16/8.23 * @throws UnsupportedOperationException if the putAll operation
26.16/8.23 * is not supported by this map
26.16/8.23 * @throws ClassCastException if the class of a key or value in the
26.16/8.23 * specified map prevents it from being stored in this map
26.16/8.23 * @throws NullPointerException if the specified map is null, or if
26.16/8.23 * this map does not permit null keys or values, and the
26.16/8.23 * specified map contains null keys or values
26.16/8.23 * @throws IllegalArgumentException if some property of a key or value in
26.16/8.23 * the specified map prevents it from being stored in this map
26.16/8.23 */
26.16/8.23 void putAll(Map m);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Removes all of the mappings from this map (optional operation).
26.16/8.23 * The map will be empty after this call returns.
26.16/8.23 *
26.16/8.23 * @throws UnsupportedOperationException if the clear operation
26.16/8.23 * is not supported by this map
26.16/8.23 */
26.16/8.23 void clear();
26.16/8.23
26.16/8.23
26.16/8.23 // Views
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Returns a {@link Set} view of the keys contained in this map.
26.16/8.23 * The set is backed by the map, so changes to the map are
26.16/8.23 * reflected in the set, and vice-versa. If the map is modified
26.16/8.23 * while an iteration over the set is in progress (except through
26.16/8.23 * the iterator's own remove operation), the results of
26.16/8.23 * the iteration are undefined. The set supports element removal,
26.16/8.23 * which removes the corresponding mapping from the map, via the
26.16/8.23 * Iterator.remove, Set.remove,
26.16/8.23 * removeAll, retainAll, and clear
26.16/8.23 * operations. It does not support the add or addAll
26.16/8.23 * operations.
26.16/8.23 *
26.16/8.23 * @return a set view of the keys contained in this map
26.16/8.23 */
26.16/8.23 Set The Set interface places additional stipulations, beyond those
26.16/8.23 * inherited from the Collection interface, on the contracts of all
26.16/8.23 * constructors and on the contracts of the add, equals and
26.16/8.23 * hashCode methods. Declarations for other inherited methods are
26.16/8.23 * also included here for convenience. (The specifications accompanying these
26.16/8.23 * declarations have been tailored to the Set interface, but they do
26.16/8.23 * not contain any additional stipulations.)
26.16/8.23 *
26.16/8.23 * The additional stipulation on constructors is, not surprisingly,
26.16/8.23 * that all constructors must create a set that contains no duplicate elements
26.16/8.23 * (as defined above).
26.16/8.23 *
26.16/8.23 * Note: Great care must be exercised if mutable objects are used as set
26.16/8.23 * elements. The behavior of a set is not specified if the value of an object
26.16/8.23 * is changed in a manner that affects equals comparisons while the
26.16/8.23 * object is an element in the set. A special case of this prohibition is
26.16/8.23 * that it is not permissible for a set to contain itself as an element.
26.16/8.23 *
26.16/8.23 * Some set implementations have restrictions on the elements that
26.16/8.23 * they may contain. For example, some implementations prohibit null elements,
26.16/8.23 * and some have restrictions on the types of their elements. Attempting to
26.16/8.23 * add an ineligible element throws an unchecked exception, typically
26.16/8.23 * NullPointerException or ClassCastException. Attempting
26.16/8.23 * to query the presence of an ineligible element may throw an exception,
26.16/8.23 * or it may simply return false; some implementations will exhibit the former
26.16/8.23 * behavior and some will exhibit the latter. More generally, attempting an
26.16/8.23 * operation on an ineligible element whose completion would not result in
26.16/8.23 * the insertion of an ineligible element into the set may throw an
26.16/8.23 * exception or it may succeed, at the option of the implementation.
26.16/8.23 * Such exceptions are marked as "optional" in the specification for this
26.16/8.23 * interface.
26.16/8.23 *
26.16/8.23 * This interface is a member of the
26.16/8.23 *
26.16/8.23 * Java Collections Framework.
26.16/8.23 *
26.16/8.23 * @param The returned array will be "safe" in that no references to it
26.16/8.23 * are maintained by this set. (In other words, this method must
26.16/8.23 * allocate a new array even if this set is backed by an array).
26.16/8.23 * The caller is thus free to modify the returned array.
26.16/8.23 *
26.16/8.23 * This method acts as bridge between array-based and collection-based
26.16/8.23 * APIs.
26.16/8.23 *
26.16/8.23 * @return an array containing all the elements in this set
26.16/8.23 */
26.16/8.23 Object[] toArray();
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Returns an array containing all of the elements in this set; the
26.16/8.23 * runtime type of the returned array is that of the specified array.
26.16/8.23 * If the set fits in the specified array, it is returned therein.
26.16/8.23 * Otherwise, a new array is allocated with the runtime type of the
26.16/8.23 * specified array and the size of this set.
26.16/8.23 *
26.16/8.23 * If this set fits in the specified array with room to spare
26.16/8.23 * (i.e., the array has more elements than this set), the element in
26.16/8.23 * the array immediately following the end of the set is set to
26.16/8.23 * null. (This is useful in determining the length of this
26.16/8.23 * set only if the caller knows that this set does not contain
26.16/8.23 * any null elements.)
26.16/8.23 *
26.16/8.23 * If this set makes any guarantees as to what order its elements
26.16/8.23 * are returned by its iterator, this method must return the elements
26.16/8.23 * in the same order.
26.16/8.23 *
26.16/8.23 * Like the {@link #toArray()} method, this method acts as bridge between
26.16/8.23 * array-based and collection-based APIs. Further, this method allows
26.16/8.23 * precise control over the runtime type of the output array, and may,
26.16/8.23 * under certain circumstances, be used to save allocation costs.
26.16/8.23 *
26.16/8.23 * Suppose x is a set known to contain only strings.
26.16/8.23 * The following code can be used to dump the set into a newly allocated
26.16/8.23 * array of String:
26.16/8.23 *
26.16/8.23 * The stipulation above does not imply that sets must accept all
26.16/8.23 * elements; sets may refuse to add any particular element, including
26.16/8.23 * null, and throw an exception, as described in the
26.16/8.23 * specification for {@link Collection#add Collection.add}.
26.16/8.23 * Individual set implementations should clearly document any
26.16/8.23 * restrictions on the elements that they may contain.
26.16/8.23 *
26.16/8.23 * @param e element to be added to this set
26.16/8.23 * @return true if this set did not already contain the specified
26.16/8.23 * element
26.16/8.23 * @throws UnsupportedOperationException if the add operation
26.16/8.23 * is not supported by this set
26.16/8.23 * @throws ClassCastException if the class of the specified element
26.16/8.23 * prevents it from being added to this set
26.16/8.23 * @throws NullPointerException if the specified element is null and this
26.16/8.23 * set does not permit null elements
26.16/8.23 * @throws IllegalArgumentException if some property of the specified element
26.16/8.23 * prevents it from being added to this set
26.16/8.23 */
26.16/8.23 boolean add(E e);
26.16/8.23
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Removes the specified element from this set if it is present
26.16/8.23 * (optional operation). More formally, removes an element e
26.16/8.23 * such that
26.16/8.23 * (o==null ? e==null : o.equals(e)), if
26.16/8.23 * this set contains such an element. Returns true if this set
26.16/8.23 * contained the element (or equivalently, if this set changed as a
26.16/8.23 * result of the call). (This set will not contain the element once the
26.16/8.23 * call returns.)
26.16/8.23 *
26.16/8.23 * @param o object to be removed from this set, if present
26.16/8.23 * @return true if this set contained the specified element
26.16/8.23 * @throws ClassCastException if the type of the specified element
26.16/8.23 * is incompatible with this set (optional)
26.16/8.23 * @throws NullPointerException if the specified element is null and this
26.16/8.23 * set does not permit null elements (optional)
26.16/8.23 * @throws UnsupportedOperationException if the remove operation
26.16/8.23 * is not supported by this set
26.16/8.23 */
26.16/8.23 boolean remove(Object o);
26.16/8.23
26.16/8.23
26.16/8.23 // Bulk Operations
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Returns true if this set contains all of the elements of the
26.16/8.23 * specified collection. If the specified collection is also a set, this
26.16/8.23 * method returns true if it is a subset of this set.
26.16/8.23 *
26.16/8.23 * @param c collection to be checked for containment in this set
26.16/8.23 * @return true if this set contains all of the elements of the
26.16/8.23 * specified collection
26.16/8.23 * @throws ClassCastException if the types of one or more elements
26.16/8.23 * in the specified collection are incompatible with this
26.16/8.23 * set (optional)
26.16/8.23 * @throws NullPointerException if the specified collection contains one
26.16/8.23 * or more null elements and this set does not permit null
26.16/8.23 * elements (optional), or if the specified collection is null
26.16/8.23 * @see #contains(Object)
26.16/8.23 */
26.16/8.23 boolean containsAll(Collection c);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Adds all of the elements in the specified collection to this set if
26.16/8.23 * they're not already present (optional operation). If the specified
26.16/8.23 * collection is also a set, the addAll operation effectively
26.16/8.23 * modifies this set so that its value is the union of the two
26.16/8.23 * sets. The behavior of this operation is undefined if the specified
26.16/8.23 * collection is modified while the operation is in progress.
26.16/8.23 *
26.16/8.23 * @param c collection containing elements to be added to this set
26.16/8.23 * @return true if this set changed as a result of the call
26.16/8.23 *
26.16/8.23 * @throws UnsupportedOperationException if the addAll operation
26.16/8.23 * is not supported by this set
26.16/8.23 * @throws ClassCastException if the class of an element of the
26.16/8.23 * specified collection prevents it from being added to this set
26.16/8.23 * @throws NullPointerException if the specified collection contains one
26.16/8.23 * or more null elements and this set does not permit null
26.16/8.23 * elements, or if the specified collection is null
26.16/8.23 * @throws IllegalArgumentException if some property of an element of the
26.16/8.23 * specified collection prevents it from being added to this set
26.16/8.23 * @see #add(Object)
26.16/8.23 */
26.16/8.23 boolean addAll(Collection c);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Retains only the elements in this set that are contained in the
26.16/8.23 * specified collection (optional operation). In other words, removes
26.16/8.23 * from this set all of its elements that are not contained in the
26.16/8.23 * specified collection. If the specified collection is also a set, this
26.16/8.23 * operation effectively modifies this set so that its value is the
26.16/8.23 * intersection of the two sets.
26.16/8.23 *
26.16/8.23 * @param c collection containing elements to be retained in this set
26.16/8.23 * @return true if this set changed as a result of the call
26.16/8.23 * @throws UnsupportedOperationException if the retainAll operation
26.16/8.23 * is not supported by this set
26.16/8.23 * @throws ClassCastException if the class of an element of this set
26.16/8.23 * is incompatible with the specified collection (optional)
26.16/8.23 * @throws NullPointerException if this set contains a null element and the
26.16/8.23 * specified collection does not permit null elements (optional),
26.16/8.23 * or if the specified collection is null
26.16/8.23 * @see #remove(Object)
26.16/8.23 */
26.16/8.23 boolean retainAll(Collection c);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Removes from this set all of its elements that are contained in the
26.16/8.23 * specified collection (optional operation). If the specified
26.16/8.23 * collection is also a set, this operation effectively modifies this
26.16/8.23 * set so that its value is the asymmetric set difference of
26.16/8.23 * the two sets.
26.16/8.23 *
26.16/8.23 * @param c collection containing elements to be removed from this set
26.16/8.23 * @return true if this set changed as a result of the call
26.16/8.23 * @throws UnsupportedOperationException if the removeAll operation
26.16/8.23 * is not supported by this set
26.16/8.23 * @throws ClassCastException if the class of an element of this set
26.16/8.23 * is incompatible with the specified collection (optional)
26.16/8.23 * @throws NullPointerException if this set contains a null element and the
26.16/8.23 * specified collection does not permit null elements (optional),
26.16/8.23 * or if the specified collection is null
26.16/8.23 * @see #remove(Object)
26.16/8.23 * @see #contains(Object)
26.16/8.23 */
26.16/8.23 boolean removeAll(Collection c);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Removes all of the elements from this set (optional operation).
26.16/8.23 * The set will be empty after this call returns.
26.16/8.23 *
26.16/8.23 * @throws UnsupportedOperationException if the clear method
26.16/8.23 * is not supported by this set
26.16/8.23 */
26.16/8.23 void clear();
26.16/8.23
26.16/8.23
26.16/8.23 // Comparison and hashing
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Compares the specified object with this set for equality. Returns
26.16/8.23 * true if the specified object is also a set, the two sets
26.16/8.23 * have the same size, and every member of the specified set is
26.16/8.23 * contained in this set (or equivalently, every member of this set is
26.16/8.23 * contained in the specified set). This definition ensures that the
26.16/8.23 * equals method works properly across different implementations of the
26.16/8.23 * set interface.
26.16/8.23 *
26.16/8.23 * @param o object to be compared for equality with this set
26.16/8.23 * @return true if the specified object is equal to this set
26.16/8.23 */
26.16/8.23 boolean equals(Object o);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Returns the hash code value for this set. The hash code of a set is
26.16/8.23 * defined to be the sum of the hash codes of the elements in the set,
26.16/8.23 * where the hash code of a null element is defined to be zero.
26.16/8.23 * This ensures that s1.equals(s2) implies that
26.16/8.23 * s1.hashCode()==s2.hashCode() for any two sets s1
26.16/8.23 * and s2, as required by the general contract of
26.16/8.23 * {@link Object#hashCode}.
26.16/8.23 *
26.16/8.23 * @return the hash code value for this set
26.16/8.23 * @see Object#equals(Object)
26.16/8.23 * @see Set#equals(Object)
26.16/8.23 */
26.16/8.23 int hashCode();
26.16/8.23 }
26.16/8.23
26.16/8.23
26.16/8.23 /*
26.16/8.23 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.23 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.23 *
26.16/8.23 * This code is free software; you can redistribute it and/or modify it
26.16/8.23 * under the terms of the GNU General Public License version 2 only, as
26.16/8.23 * published by the Free Software Foundation. Sun designates this
26.16/8.23 * particular file as subject to the "Classpath" exception as provided
26.16/8.23 * by Sun in the LICENSE file that accompanied this code.
26.16/8.23 *
26.16/8.23 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.23 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.23 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.23 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.23 * accompanied this code).
26.16/8.23 *
26.16/8.23 * You should have received a copy of the GNU General Public License version
26.16/8.23 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.23 *
26.16/8.23 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.24 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.24 * have any questions.
26.16/8.24 */
26.16/8.24
26.16/8.24 package javaUtilEx;
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Thrown to indicate that the requested operation is not supported.
26.16/8.24 *
26.16/8.24 * This class is a member of the
26.16/8.24 *
26.16/8.24 * Java Collections Framework.
26.16/8.24 *
26.16/8.24 * @author Josh Bloch
26.16/8.24 * @since 1.2
26.16/8.24 */
26.16/8.24 public class UnsupportedOperationException extends RuntimeException {
26.16/8.24 /**
26.16/8.24 * Constructs an UnsupportedOperationException with no detail message.
26.16/8.24 */
26.16/8.24 public UnsupportedOperationException() {
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Constructs an UnsupportedOperationException with the specified
26.16/8.24 * detail message.
26.16/8.24 *
26.16/8.24 * @param message the detail message
26.16/8.24 */
26.16/8.24 public UnsupportedOperationException(String message) {
26.16/8.24 super(message);
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Constructs a new exception with the specified detail message and
26.16/8.24 * cause.
26.16/8.24 *
26.16/8.24 * Note that the detail message associated with
26.16/8.24 *
26.16/8.24 * To implement an unmodifiable collection, the programmer needs only to
26.16/8.24 * extend this class and provide implementations for the iterator and
26.16/8.24 * size methods. (The iterator returned by the iterator
26.16/8.24 * method must implement hasNext and next.)
26.16/8.24 *
26.16/8.24 * To implement a modifiable collection, the programmer must additionally
26.16/8.24 * override this class's add method (which otherwise throws an
26.16/8.24 * UnsupportedOperationException), and the iterator returned by the
26.16/8.24 * iterator method must additionally implement its remove
26.16/8.24 * method.
26.16/8.24 *
26.16/8.24 * The programmer should generally provide a void (no argument) and
26.16/8.24 * Collection constructor, as per the recommendation in the
26.16/8.24 * Collection interface specification.
26.16/8.24 *
26.16/8.24 * The documentation for each non-abstract method in this class describes its
26.16/8.24 * implementation in detail. Each of these methods may be overridden if
26.16/8.24 * the collection being implemented admits a more efficient implementation.
26.16/8.24 *
26.16/8.24 * This class is a member of the
26.16/8.24 *
26.16/8.24 * Java Collections Framework.
26.16/8.24 *
26.16/8.24 * @author Josh Bloch
26.16/8.24 * @author Neal Gafter
26.16/8.24 * @see Collection
26.16/8.24 * @since 1.2
26.16/8.24 */
26.16/8.24
26.16/8.24 public abstract class AbstractCollection This implementation returns size() == 0.
26.16/8.24 */
26.16/8.24 public boolean isEmpty() {
26.16/8.24 return size() == 0;
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over the elements in the collection,
26.16/8.24 * checking each element in turn for equality with the specified element.
26.16/8.24 *
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public boolean contains(Object o) {
26.16/8.24 Iterator This implementation always throws an
26.16/8.24 * UnsupportedOperationException.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.24 * @throws IllegalStateException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public boolean add(E e) {
26.16/8.24 throw new UnsupportedOperationException();
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over the collection looking for the
26.16/8.24 * specified element. If it finds the element, it removes the element
26.16/8.24 * from the collection using the iterator's remove method.
26.16/8.24 *
26.16/8.24 * Note that this implementation throws an
26.16/8.24 * UnsupportedOperationException if the iterator returned by this
26.16/8.24 * collection's iterator method does not implement the remove
26.16/8.24 * method and this collection contains the specified object.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public boolean remove(Object o) {
26.16/8.24 Iterator This implementation iterates over the specified collection,
26.16/8.24 * checking each element returned by the iterator in turn to see
26.16/8.24 * if it's contained in this collection. If all elements are so
26.16/8.24 * contained true is returned, otherwise false.
26.16/8.24 *
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 * @see #contains(Object)
26.16/8.24 */
26.16/8.24 public boolean containsAll(Collection c) {
26.16/8.24 Iterator e = c.iterator();
26.16/8.24 while (e.hasNext())
26.16/8.24 if (!contains(e.next()))
26.16/8.24 return false;
26.16/8.24 return true;
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over the specified collection, and adds
26.16/8.24 * each object returned by the iterator to this collection, in turn.
26.16/8.24 *
26.16/8.24 * Note that this implementation will throw an
26.16/8.24 * UnsupportedOperationException unless add is
26.16/8.24 * overridden (assuming the specified collection is non-empty).
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.24 * @throws IllegalStateException {@inheritDoc}
26.16/8.24 *
26.16/8.24 * @see #add(Object)
26.16/8.24 */
26.16/8.24 public boolean addAll(Collection c) {
26.16/8.24 boolean modified = false;
26.16/8.24 Iterator e = c.iterator();
26.16/8.24 while (e.hasNext()) {
26.16/8.24 if (add(e.next()))
26.16/8.24 modified = true;
26.16/8.24 }
26.16/8.24 return modified;
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over this collection, checking each
26.16/8.24 * element returned by the iterator in turn to see if it's contained
26.16/8.24 * in the specified collection. If it's so contained, it's removed from
26.16/8.24 * this collection with the iterator's remove method.
26.16/8.24 *
26.16/8.24 * Note that this implementation will throw an
26.16/8.24 * UnsupportedOperationException if the iterator returned by the
26.16/8.24 * iterator method does not implement the remove method
26.16/8.24 * and this collection contains one or more elements in common with the
26.16/8.24 * specified collection.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 *
26.16/8.24 * @see #remove(Object)
26.16/8.24 * @see #contains(Object)
26.16/8.24 */
26.16/8.24 public boolean removeAll(Collection c) {
26.16/8.24 boolean modified = false;
26.16/8.24 Iterator e = iterator();
26.16/8.24 while (e.hasNext()) {
26.16/8.24 if (c.contains(e.next())) {
26.16/8.24 e.remove();
26.16/8.24 modified = true;
26.16/8.24 }
26.16/8.24 }
26.16/8.24 return modified;
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over this collection, checking each
26.16/8.24 * element returned by the iterator in turn to see if it's contained
26.16/8.24 * in the specified collection. If it's not so contained, it's removed
26.16/8.24 * from this collection with the iterator's remove method.
26.16/8.24 *
26.16/8.24 * Note that this implementation will throw an
26.16/8.24 * UnsupportedOperationException if the iterator returned by the
26.16/8.24 * iterator method does not implement the remove method
26.16/8.24 * and this collection contains one or more elements not present in the
26.16/8.24 * specified collection.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 *
26.16/8.24 * @see #remove(Object)
26.16/8.24 * @see #contains(Object)
26.16/8.24 */
26.16/8.24 public boolean retainAll(Collection c) {
26.16/8.24 boolean modified = false;
26.16/8.24 Iterator This implementation iterates over this collection, removing each
26.16/8.24 * element using the Iterator.remove operation. Most
26.16/8.24 * implementations will probably choose to override this method for
26.16/8.24 * efficiency.
26.16/8.24 *
26.16/8.24 * Note that this implementation will throw an
26.16/8.24 * UnsupportedOperationException if the iterator returned by this
26.16/8.24 * collection's iterator method does not implement the
26.16/8.24 * remove method and this collection is non-empty.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public void clear() {
26.16/8.24 Iterator To implement an unmodifiable map, the programmer needs only to extend this
26.16/8.24 * class and provide an implementation for the entrySet method, which
26.16/8.24 * returns a set-view of the map's mappings. Typically, the returned set
26.16/8.24 * will, in turn, be implemented atop AbstractSet. This set should
26.16/8.24 * not support the add or remove methods, and its iterator
26.16/8.24 * should not support the remove method.
26.16/8.24 *
26.16/8.24 * To implement a modifiable map, the programmer must additionally override
26.16/8.24 * this class's put method (which otherwise throws an
26.16/8.24 * UnsupportedOperationException), and the iterator returned by
26.16/8.24 * entrySet().iterator() must additionally implement its
26.16/8.24 * remove method.
26.16/8.24 *
26.16/8.24 * The programmer should generally provide a void (no argument) and map
26.16/8.24 * constructor, as per the recommendation in the Map interface
26.16/8.24 * specification.
26.16/8.24 *
26.16/8.24 * The documentation for each non-abstract method in this class describes its
26.16/8.24 * implementation in detail. Each of these methods may be overridden if the
26.16/8.24 * map being implemented admits a more efficient implementation.
26.16/8.24 *
26.16/8.24 * This class is a member of the
26.16/8.24 *
26.16/8.24 * Java Collections Framework.
26.16/8.24 *
26.16/8.24 * @param This implementation returns entrySet().size().
26.16/8.24 */
26.16/8.24 public int size() {
26.16/8.24 return entrySet().size();
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation returns size() == 0.
26.16/8.24 */
26.16/8.24 public boolean isEmpty() {
26.16/8.24 return size() == 0;
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over entrySet() searching
26.16/8.24 * for an entry with the specified value. If such an entry is found,
26.16/8.24 * true is returned. If the iteration terminates without
26.16/8.24 * finding such an entry, false is returned. Note that this
26.16/8.24 * implementation requires linear time in the size of the map.
26.16/8.24 *
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public boolean containsValue(Object value) {
26.16/8.24 Iterator This implementation iterates over entrySet() searching
26.16/8.24 * for an entry with the specified key. If such an entry is found,
26.16/8.24 * true is returned. If the iteration terminates without
26.16/8.24 * finding such an entry, false is returned. Note that this
26.16/8.24 * implementation requires linear time in the size of the map; many
26.16/8.24 * implementations will override this method.
26.16/8.24 *
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public boolean containsKey(Object key) {
26.16/8.24 Iterator This implementation iterates over entrySet() searching
26.16/8.24 * for an entry with the specified key. If such an entry is found,
26.16/8.24 * the entry's value is returned. If the iteration terminates without
26.16/8.24 * finding such an entry, null is returned. Note that this
26.16/8.24 * implementation requires linear time in the size of the map; many
26.16/8.24 * implementations will override this method.
26.16/8.24 *
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public V get(Object key) {
26.16/8.24 Iterator This implementation always throws an
26.16/8.24 * UnsupportedOperationException.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public V put(K key, V value) {
26.16/8.24 throw new UnsupportedOperationException();
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation iterates over entrySet() searching for an
26.16/8.24 * entry with the specified key. If such an entry is found, its value is
26.16/8.24 * obtained with its getValue operation, the entry is removed
26.16/8.24 * from the collection (and the backing map) with the iterator's
26.16/8.24 * remove operation, and the saved value is returned. If the
26.16/8.24 * iteration terminates without finding such an entry, null is
26.16/8.24 * returned. Note that this implementation requires linear time in the
26.16/8.24 * size of the map; many implementations will override this method.
26.16/8.24 *
26.16/8.24 * Note that this implementation throws an
26.16/8.24 * UnsupportedOperationException if the entrySet
26.16/8.24 * iterator does not support the remove method and this map
26.16/8.24 * contains a mapping for the specified key.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public V remove(Object key) {
26.16/8.24 Iterator This implementation iterates over the specified map's
26.16/8.24 * entrySet() collection, and calls this map's put
26.16/8.24 * operation once for each entry returned by the iteration.
26.16/8.24 *
26.16/8.24 * Note that this implementation throws an
26.16/8.24 * UnsupportedOperationException if this map does not support
26.16/8.24 * the put operation and the specified map is nonempty.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 * @throws ClassCastException {@inheritDoc}
26.16/8.24 * @throws NullPointerException {@inheritDoc}
26.16/8.24 * @throws IllegalArgumentException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public void putAll(Map m) {
26.16/8.24 Iterator it = m.entrySet().iterator();
26.16/8.24 while (it.hasNext()) {
26.16/8.24 Map.Entry e = (Map.Entry) it.next();
26.16/8.24 put((K) e.getKey(), (V) e.getValue());
26.16/8.24 }
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * {@inheritDoc}
26.16/8.24 *
26.16/8.24 * This implementation calls entrySet().clear().
26.16/8.24 *
26.16/8.24 * Note that this implementation throws an
26.16/8.24 * UnsupportedOperationException if the entrySet
26.16/8.24 * does not support the clear operation.
26.16/8.24 *
26.16/8.24 * @throws UnsupportedOperationException {@inheritDoc}
26.16/8.24 */
26.16/8.24 public void clear() {
26.16/8.24 entrySet().clear();
26.16/8.24 }
26.16/8.24
26.16/8.24
26.16/8.24 // Views
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Each of these fields are initialized to contain an instance of the
26.16/8.24 * appropriate view the first time this view is requested. The views are
26.16/8.24 * stateless, so there's no reason to create more than one of each.
26.16/8.24 */
26.16/8.24 transient volatile Set This implementation returns a set that subclasses {@link AbstractSet}.
26.16/8.24 * The subclass's iterator method returns a "wrapper object" over this
26.16/8.24 * map's entrySet() iterator. The size method
26.16/8.24 * delegates to this map's size method and the
26.16/8.24 * contains method delegates to this map's
26.16/8.24 * containsKey method.
26.16/8.24 *
26.16/8.24 * The set is created the first time this method is called,
26.16/8.24 * and returned in response to all subsequent calls. No synchronization
26.16/8.24 * is performed, so there is a slight chance that multiple calls to this
26.16/8.24 * method will not all return the same set.
26.16/8.24 */
26.16/8.24 public Set This implementation returns a collection that subclasses {@link
26.16/8.24 * AbstractCollection}. The subclass's iterator method returns a
26.16/8.24 * "wrapper object" over this map's entrySet() iterator.
26.16/8.24 * The size method delegates to this map's size
26.16/8.24 * method and the contains method delegates to this map's
26.16/8.24 * containsValue method.
26.16/8.24 *
26.16/8.24 * The collection is created the first time this method is called, and
26.16/8.24 * returned in response to all subsequent calls. No synchronization is
26.16/8.24 * performed, so there is a slight chance that multiple calls to this
26.16/8.24 * method will not all return the same collection.
26.16/8.24 */
26.16/8.24 public Collection This implementation first checks if the specified object is this map;
26.16/8.24 * if so it returns true. Then, it checks if the specified
26.16/8.24 * object is a map whose size is identical to the size of this map; if
26.16/8.24 * not, it returns false. If so, it iterates over this map's
26.16/8.24 * entrySet collection, and checks that the specified map
26.16/8.24 * contains each mapping that this map contains. If the specified map
26.16/8.24 * fails to contain such a mapping, false is returned. If the
26.16/8.24 * iteration completes, true is returned.
26.16/8.24 *
26.16/8.24 * @param o object to be compared for equality with this map
26.16/8.24 * @return true if the specified object is equal to this map
26.16/8.24 */
26.16/8.24 public boolean equals(Object o) {
26.16/8.24 if (o == this)
26.16/8.24 return true;
26.16/8.24
26.16/8.24 if (!(o instanceof Map))
26.16/8.24 return false;
26.16/8.24 Map This implementation iterates over entrySet(), calling
26.16/8.24 * {@link Map.Entry#hashCode hashCode()} on each element (entry) in the
26.16/8.24 * set, and adding up the results.
26.16/8.24 *
26.16/8.24 * @return the hash code value for this map
26.16/8.24 * @see Map.Entry#hashCode()
26.16/8.24 * @see Object#equals(Object)
26.16/8.24 * @see Set#equals(Object)
26.16/8.24 */
26.16/8.24 public int hashCode() {
26.16/8.24 int h = 0;
26.16/8.24 Iterator
26.16/8.24 *
26.16/8.24 * The process of implementing a set by extending this class is identical
26.16/8.24 * to that of implementing a Collection by extending AbstractCollection,
26.16/8.24 * except that all of the methods and constructors in subclasses of this
26.16/8.24 * class must obey the additional constraints imposed by the Set
26.16/8.24 * interface (for instance, the add method must not permit addition of
26.16/8.24 * multiple instances of an object to a set).
26.16/8.24 *
26.16/8.24 * Note that this class does not override any of the implementations from
26.16/8.24 * the AbstractCollection class. It merely adds implementations
26.16/8.24 * for equals and hashCode.
26.16/8.24 *
26.16/8.24 * This class is a member of the
26.16/8.24 *
26.16/8.24 * Java Collections Framework.
26.16/8.24 *
26.16/8.24 * @param
26.16/8.24 *
26.16/8.24 * This implementation first checks if the specified object is this
26.16/8.24 * set; if so it returns true. Then, it checks if the
26.16/8.24 * specified object is a set whose size is identical to the size of
26.16/8.24 * this set; if not, it returns false. If so, it returns
26.16/8.24 * containsAll((Collection) o).
26.16/8.24 *
26.16/8.24 * @param o object to be compared for equality with this set
26.16/8.24 * @return true if the specified object is equal to this set
26.16/8.24 */
26.16/8.24 public boolean equals(Object o) {
26.16/8.24 if (o == this)
26.16/8.24 return true;
26.16/8.24
26.16/8.24 if (!(o instanceof Set))
26.16/8.24 return false;
26.16/8.24 Collection c = (Collection) o;
26.16/8.24 if (c.size() != size())
26.16/8.24 return false;
26.16/8.24 try {
26.16/8.24 return containsAll(c);
26.16/8.24 } catch (ClassCastException unused) {
26.16/8.24 return false;
26.16/8.24 } catch (NullPointerException unused) {
26.16/8.24 return false;
26.16/8.24 }
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Returns the hash code value for this set. The hash code of a set is
26.16/8.24 * defined to be the sum of the hash codes of the elements in the set,
26.16/8.24 * where the hash code of a null element is defined to be zero.
26.16/8.24 * This ensures that s1.equals(s2) implies that
26.16/8.24 * s1.hashCode()==s2.hashCode() for any two sets s1
26.16/8.24 * and s2, as required by the general contract of
26.16/8.24 * {@link Object#hashCode}.
26.16/8.24 *
26.16/8.24 * This implementation iterates over the set, calling the
26.16/8.24 * hashCode method on each element in the set, and adding up
26.16/8.24 * the results.
26.16/8.24 *
26.16/8.24 * @return the hash code value for this set
26.16/8.24 * @see Object#equals(Object)
26.16/8.24 * @see Set#equals(Object)
26.16/8.24 */
26.16/8.24 public int hashCode() {
26.16/8.24 int h = 0;
26.16/8.24 Iterator This implementation determines which is the smaller of this set
26.16/8.24 * and the specified collection, by invoking the size
26.16/8.24 * method on each. If this set has fewer elements, then the
26.16/8.24 * implementation iterates over this set, checking each element
26.16/8.24 * returned by the iterator in turn to see if it is contained in
26.16/8.24 * the specified collection. If it is so contained, it is removed
26.16/8.24 * from this set with the iterator's remove method. If
26.16/8.24 * the specified collection has fewer elements, then the
26.16/8.24 * implementation iterates over the specified collection, removing
26.16/8.24 * from this set each element returned by the iterator, using this
26.16/8.24 * set's remove method.
26.16/8.24 *
26.16/8.24 * Note that this implementation will throw an
26.16/8.24 * UnsupportedOperationException if the iterator returned by the
26.16/8.24 * iterator method does not implement the remove method.
26.16/8.24 *
26.16/8.24 * @param c collection containing elements to be removed from this set
26.16/8.24 * @return true if this set changed as a result of the call
26.16/8.24 * @throws UnsupportedOperationException if the removeAll operation
26.16/8.24 * is not supported by this set
26.16/8.24 * @throws ClassCastException if the class of an element of this set
26.16/8.24 * is incompatible with the specified collection (optional)
26.16/8.24 * @throws NullPointerException if this set contains a null element and the
26.16/8.24 * specified collection does not permit null elements (optional),
26.16/8.24 * or if the specified collection is null
26.16/8.24 * @see #remove(Object)
26.16/8.24 * @see #contains(Object)
26.16/8.24 */
26.16/8.24 public boolean removeAll(Collection c) {
26.16/8.24 boolean modified = false;
26.16/8.24
26.16/8.24 if (size() > c.size()) {
26.16/8.24 for (Iterator i = c.iterator(); i.hasNext(); )
26.16/8.24 modified |= remove(i.next());
26.16/8.24 } else {
26.16/8.24 for (Iterator i = iterator(); i.hasNext(); ) {
26.16/8.24 if (c.contains(i.next())) {
26.16/8.24 i.remove();
26.16/8.24 modified = true;
26.16/8.24 }
26.16/8.24 }
26.16/8.24 }
26.16/8.24 return modified;
26.16/8.24 }
26.16/8.24
26.16/8.24 }
26.16/8.24
26.16/8.24
26.16/8.24 /*
26.16/8.24 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.24 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.24 *
26.16/8.24 * This code is free software; you can redistribute it and/or modify it
26.16/8.24 * under the terms of the GNU General Public License version 2 only, as
26.16/8.24 * published by the Free Software Foundation. Sun designates this
26.16/8.24 * particular file as subject to the "Classpath" exception as provided
26.16/8.24 * by Sun in the LICENSE file that accompanied this code.
26.16/8.24 *
26.16/8.24 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.24 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.24 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.24 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.24 * accompanied this code).
26.16/8.24 *
26.16/8.24 * You should have received a copy of the GNU General Public License version
26.16/8.24 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.24 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.24 *
26.16/8.24 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.24 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.24 * have any questions.
26.16/8.24 */
26.16/8.24
26.16/8.24 package javaUtilEx;
26.16/8.24
26.16/8.24 /**
26.16/8.24 * The root interface in the collection hierarchy. A collection
26.16/8.24 * represents a group of objects, known as its elements. Some
26.16/8.24 * collections allow duplicate elements and others do not. Some are ordered
26.16/8.24 * and others unordered. The JDK does not provide any direct
26.16/8.24 * implementations of this interface: it provides implementations of more
26.16/8.24 * specific subinterfaces like Set and List. This interface
26.16/8.24 * is typically used to pass collections around and manipulate them where
26.16/8.24 * maximum generality is desired.
26.16/8.24 *
26.16/8.24 * Bags or multisets (unordered collections that may contain
26.16/8.24 * duplicate elements) should implement this interface directly.
26.16/8.24 *
26.16/8.24 * All general-purpose Collection implementation classes (which
26.16/8.24 * typically implement Collection indirectly through one of its
26.16/8.24 * subinterfaces) should provide two "standard" constructors: a void (no
26.16/8.24 * arguments) constructor, which creates an empty collection, and a
26.16/8.24 * constructor with a single argument of type Collection, which
26.16/8.24 * creates a new collection with the same elements as its argument. In
26.16/8.24 * effect, the latter constructor allows the user to copy any collection,
26.16/8.24 * producing an equivalent collection of the desired implementation type.
26.16/8.24 * There is no way to enforce this convention (as interfaces cannot contain
26.16/8.24 * constructors) but all of the general-purpose Collection
26.16/8.24 * implementations in the Java platform libraries comply.
26.16/8.24 *
26.16/8.24 * The "destructive" methods contained in this interface, that is, the
26.16/8.24 * methods that modify the collection on which they operate, are specified to
26.16/8.24 * throw UnsupportedOperationException if this collection does not
26.16/8.24 * support the operation. If this is the case, these methods may, but are not
26.16/8.24 * required to, throw an UnsupportedOperationException if the
26.16/8.24 * invocation would have no effect on the collection. For example, invoking
26.16/8.24 * the {@link #addAll(Collection)} method on an unmodifiable collection may,
26.16/8.24 * but is not required to, throw the exception if the collection to be added
26.16/8.24 * is empty.
26.16/8.24 *
26.16/8.24 * Some collection implementations have restrictions on the elements that
26.16/8.24 * they may contain. For example, some implementations prohibit null elements,
26.16/8.24 * and some have restrictions on the types of their elements. Attempting to
26.16/8.24 * add an ineligible element throws an unchecked exception, typically
26.16/8.24 * NullPointerException or ClassCastException. Attempting
26.16/8.24 * to query the presence of an ineligible element may throw an exception,
26.16/8.24 * or it may simply return false; some implementations will exhibit the former
26.16/8.24 * behavior and some will exhibit the latter. More generally, attempting an
26.16/8.24 * operation on an ineligible element whose completion would not result in
26.16/8.24 * the insertion of an ineligible element into the collection may throw an
26.16/8.24 * exception or it may succeed, at the option of the implementation.
26.16/8.24 * Such exceptions are marked as "optional" in the specification for this
26.16/8.24 * interface.
26.16/8.24 *
26.16/8.24 * It is up to each collection to determine its own synchronization
26.16/8.24 * policy. In the absence of a stronger guarantee by the
26.16/8.24 * implementation, undefined behavior may result from the invocation
26.16/8.24 * of any method on a collection that is being mutated by another
26.16/8.24 * thread; this includes direct invocations, passing the collection to
26.16/8.24 * a method that might perform invocations, and using an existing
26.16/8.24 * iterator to examine the collection.
26.16/8.24 *
26.16/8.24 * Many methods in Collections Framework interfaces are defined in
26.16/8.24 * terms of the {@link Object#equals(Object) equals} method. For example,
26.16/8.24 * the specification for the {@link #contains(Object) contains(Object o)}
26.16/8.24 * method says: "returns true if and only if this collection
26.16/8.24 * contains at least one element e such that
26.16/8.24 * (o==null ? e==null : o.equals(e))." This specification should
26.16/8.24 * not be construed to imply that invoking Collection.contains
26.16/8.24 * with a non-null argument o will cause o.equals(e) to be
26.16/8.24 * invoked for any element e. Implementations are free to implement
26.16/8.24 * optimizations whereby the equals invocation is avoided, for
26.16/8.24 * example, by first comparing the hash codes of the two elements. (The
26.16/8.24 * {@link Object#hashCode()} specification guarantees that two objects with
26.16/8.24 * unequal hash codes cannot be equal.) More generally, implementations of
26.16/8.24 * the various Collections Framework interfaces are free to take advantage of
26.16/8.24 * the specified behavior of underlying {@link Object} methods wherever the
26.16/8.24 * implementor deems it appropriate.
26.16/8.24 *
26.16/8.24 * This interface is a member of the
26.16/8.24 *
26.16/8.24 * Java Collections Framework.
26.16/8.24 *
26.16/8.24 * @author Josh Bloch
26.16/8.24 * @author Neal Gafter
26.16/8.24 * @see Set
26.16/8.24 * @see List
26.16/8.24 * @see Map
26.16/8.24 * @see SortedSet
26.16/8.24 * @see SortedMap
26.16/8.24 * @see HashSet
26.16/8.24 * @see TreeSet
26.16/8.24 * @see ArrayList
26.16/8.24 * @see LinkedList
26.16/8.24 * @see Vector
26.16/8.24 * @see Collections
26.16/8.24 * @see Arrays
26.16/8.24 * @see AbstractCollection
26.16/8.24 * @since 1.2
26.16/8.24 */
26.16/8.24
26.16/8.24 public interface Collection
26.16/8.22 * (e1.getKey()==null ?
26.16/8.22 * e2.getKey()==null :
26.16/8.22 * e1.getKey().equals(e2.getKey()))
26.16/8.22 * &&
26.16/8.22 * (e1.getValue()==null ?
26.16/8.22 * e2.getValue()==null :
26.16/8.22 * e1.getValue().equals(e2.getValue()))
26.16/8.22 * This ensures that the {@code equals} method works properly across
26.16/8.22 * different implementations of the {@code Map.Entry} interface.
26.16/8.22 *
26.16/8.22 * @param o object to be compared for equality with this map entry
26.16/8.22 * @return {@code true} if the specified object is equal to this map
26.16/8.22 * entry
26.16/8.22 * @see #hashCode
26.16/8.22 */
26.16/8.22 public boolean equals(Object o) {
26.16/8.22 if (!(o instanceof Map.Entry))
26.16/8.22 return false;
26.16/8.22 Map.Entry e = (Map.Entry)o;
26.16/8.22 return eq(key, e.getKey()) && eq(value, e.getValue());
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns the hash code value for this map entry. The hash code
26.16/8.22 * of a map entry {@code e} is defined to be:
26.16/8.22 * (e.getKey()==null ? 0 : e.getKey().hashCode()) ^
26.16/8.22 * (e.getValue()==null ? 0 : e.getValue().hashCode())
26.16/8.22 * This ensures that {@code e1.equals(e2)} implies that
26.16/8.22 * {@code e1.hashCode()==e2.hashCode()} for any two Entries
26.16/8.22 * {@code e1} and {@code e2}, as required by the general
26.16/8.22 * contract of {@link Object#hashCode}.
26.16/8.22 *
26.16/8.22 * @return the hash code value for this map entry
26.16/8.22 * @see #equals
26.16/8.22 */
26.16/8.22 public int hashCode() {
26.16/8.22 return (key == null ? 0 : key.hashCode()) ^
26.16/8.22 (value == null ? 0 : value.hashCode());
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns a String representation of this map entry. This
26.16/8.22 * implementation returns the string representation of this
26.16/8.22 * entry's key followed by the equals character ("=")
26.16/8.22 * followed by the string representation of this entry's value.
26.16/8.22 *
26.16/8.22 * @return a String representation of this map entry
26.16/8.22 */
26.16/8.22 public String toString() {
26.16/8.22 return key + "=" + value;
26.16/8.22 }
26.16/8.22
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * An Entry maintaining an immutable key and value. This class
26.16/8.22 * does not support method setValue. This class may be
26.16/8.22 * convenient in methods that return thread-safe snapshots of
26.16/8.22 * key-value mappings.
26.16/8.22 *
26.16/8.22 * @since 1.6
26.16/8.22 */
26.16/8.22 public static class SimpleImmutableEntry
26.16/8.22 * (e1.getKey()==null ?
26.16/8.22 * e2.getKey()==null :
26.16/8.22 * e1.getKey().equals(e2.getKey()))
26.16/8.22 * &&
26.16/8.22 * (e1.getValue()==null ?
26.16/8.22 * e2.getValue()==null :
26.16/8.22 * e1.getValue().equals(e2.getValue()))
26.16/8.22 * This ensures that the {@code equals} method works properly across
26.16/8.22 * different implementations of the {@code Map.Entry} interface.
26.16/8.22 *
26.16/8.22 * @param o object to be compared for equality with this map entry
26.16/8.22 * @return {@code true} if the specified object is equal to this map
26.16/8.22 * entry
26.16/8.22 * @see #hashCode
26.16/8.22 */
26.16/8.22 public boolean equals(Object o) {
26.16/8.22 if (!(o instanceof Map.Entry))
26.16/8.22 return false;
26.16/8.22 Map.Entry e = (Map.Entry)o;
26.16/8.22 return eq(key, e.getKey()) && eq(value, e.getValue());
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns the hash code value for this map entry. The hash code
26.16/8.22 * of a map entry {@code e} is defined to be:
26.16/8.22 * (e.getKey()==null ? 0 : e.getKey().hashCode()) ^
26.16/8.22 * (e.getValue()==null ? 0 : e.getValue().hashCode())
26.16/8.22 * This ensures that {@code e1.equals(e2)} implies that
26.16/8.22 * {@code e1.hashCode()==e2.hashCode()} for any two Entries
26.16/8.22 * {@code e1} and {@code e2}, as required by the general
26.16/8.22 * contract of {@link Object#hashCode}.
26.16/8.22 *
26.16/8.22 * @return the hash code value for this map entry
26.16/8.22 * @see #equals
26.16/8.22 */
26.16/8.22 public int hashCode() {
26.16/8.22 return (key == null ? 0 : key.hashCode()) ^
26.16/8.22 (value == null ? 0 : value.hashCode());
26.16/8.22 }
26.16/8.22
26.16/8.22 /**
26.16/8.22 * Returns a String representation of this map entry. This
26.16/8.22 * implementation returns the string representation of this
26.16/8.22 * entry's key followed by the equals character ("=")
26.16/8.22 * followed by the string representation of this entry's value.
26.16/8.22 *
26.16/8.22 * @return a String representation of this map entry
26.16/8.22 */
26.16/8.22 public String toString() {
26.16/8.22 return key + "=" + value;
26.16/8.22 }
26.16/8.22
26.16/8.22 }
26.16/8.22
26.16/8.22 }
26.16/8.22
26.16/8.22
26.16/8.22 /*
26.16/8.22 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.22 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.22 *
26.16/8.22 * This code is free software; you can redistribute it and/or modify it
26.16/8.22 * under the terms of the GNU General Public License version 2 only, as
26.16/8.22 * published by the Free Software Foundation. Sun designates this
26.16/8.22 * particular file as subject to the "Classpath" exception as provided
26.16/8.22 * by Sun in the LICENSE file that accompanied this code.
26.16/8.22 *
26.16/8.22 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.22 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.22 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.22 * accompanied this code).
26.16/8.22 *
26.16/8.22 * You should have received a copy of the GNU General Public License version
26.16/8.22 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.22 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.22 *
26.16/8.22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.22 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.22 * have any questions.
26.16/8.22 */
26.16/8.22
26.16/8.22 package javaUtilEx;
26.16/8.22
26.16/8.22 /**
26.16/8.22 * This class provides a skeletal implementation of the Set
26.16/8.22 * interface to minimize the effort required to implement this
26.16/8.22 * interface.
26.16/8.22 * Map m = Collections.synchronizedMap(new HashMap(...));
26.16/8.22 *
26.16/8.22 * IllegalArgumentException with no
26.16/8.23 * detail message.
26.16/8.23 */
26.16/8.23 public IllegalArgumentException() {
26.16/8.23 super();
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs an IllegalArgumentException with the
26.16/8.23 * specified detail message.
26.16/8.23 *
26.16/8.23 * @param s the detail message.
26.16/8.23 */
26.16/8.23 public IllegalArgumentException(String s) {
26.16/8.23 super(s);
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs a new exception with the specified detail message and
26.16/8.23 * cause.
26.16/8.23 *
26.16/8.23 * cause is
26.16/8.23 * not automatically incorporated in this exception's detail
26.16/8.23 * message.
26.16/8.23 *
26.16/8.23 * @param message the detail message (which is saved for later retrieval
26.16/8.23 * by the {@link Throwable#getMessage()} method).
26.16/8.23 * @param cause the cause (which is saved for later retrieval by the
26.16/8.23 * {@link Throwable#getCause()} method). (A null value
26.16/8.23 * is permitted, and indicates that the cause is nonexistent or
26.16/8.23 * unknown.)
26.16/8.23 * @since 1.5
26.16/8.23 */
26.16/8.23 public IllegalArgumentException(String message, Throwable cause) {
26.16/8.23 super(message, cause);
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs a new exception with the specified cause and a detail
26.16/8.23 * message of (cause==null ? null : cause.toString()) (which
26.16/8.23 * typically contains the class and detail message of cause).
26.16/8.23 * This constructor is useful for exceptions that are little more than
26.16/8.23 * wrappers for other throwables (for example, {@link
26.16/8.23 * java.security.PrivilegedActionException}).
26.16/8.23 *
26.16/8.23 * @param cause the cause (which is saved for later retrieval by the
26.16/8.23 * {@link Throwable#getCause()} method). (A null value is
26.16/8.23 * permitted, and indicates that the cause is nonexistent or
26.16/8.23 * unknown.)
26.16/8.23 * @since 1.5
26.16/8.23 */
26.16/8.23 public IllegalArgumentException(Throwable cause) {
26.16/8.23 super(cause);
26.16/8.23 }
26.16/8.23
26.16/8.23 private static final long serialVersionUID = -5365630128856068164L;
26.16/8.23 }
26.16/8.23
26.16/8.23
26.16/8.23 /*
26.16/8.23 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.23 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.23 *
26.16/8.23 * This code is free software; you can redistribute it and/or modify it
26.16/8.23 * under the terms of the GNU General Public License version 2 only, as
26.16/8.23 * published by the Free Software Foundation. Sun designates this
26.16/8.23 * particular file as subject to the "Classpath" exception as provided
26.16/8.23 * by Sun in the LICENSE file that accompanied this code.
26.16/8.23 *
26.16/8.23 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.23 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.23 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.23 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.23 * accompanied this code).
26.16/8.23 *
26.16/8.23 * You should have received a copy of the GNU General Public License version
26.16/8.23 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.23 *
26.16/8.23 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.23 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.23 * have any questions.
26.16/8.23 */
26.16/8.23
26.16/8.23 package javaUtilEx;
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Signals that a method has been invoked at an illegal or
26.16/8.23 * inappropriate time. In other words, the Java environment or
26.16/8.23 * Java application is not in an appropriate state for the requested
26.16/8.23 * operation.
26.16/8.23 *
26.16/8.23 * @author Jonni Kanerva
26.16/8.23 * @since JDK1.1
26.16/8.23 */
26.16/8.23 public
26.16/8.23 class IllegalStateException extends RuntimeException {
26.16/8.23 /**
26.16/8.23 * Constructs an IllegalStateException with no detail message.
26.16/8.23 * A detail message is a String that describes this particular exception.
26.16/8.23 */
26.16/8.23 public IllegalStateException() {
26.16/8.23 super();
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs an IllegalStateException with the specified detail
26.16/8.23 * message. A detail message is a String that describes this particular
26.16/8.23 * exception.
26.16/8.23 *
26.16/8.23 * @param s the String that contains a detailed message
26.16/8.23 */
26.16/8.23 public IllegalStateException(String s) {
26.16/8.23 super(s);
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs a new exception with the specified detail message and
26.16/8.23 * cause.
26.16/8.23 *
26.16/8.23 * cause is
26.16/8.23 * not automatically incorporated in this exception's detail
26.16/8.23 * message.
26.16/8.23 *
26.16/8.23 * @param message the detail message (which is saved for later retrieval
26.16/8.23 * by the {@link Throwable#getMessage()} method).
26.16/8.23 * @param cause the cause (which is saved for later retrieval by the
26.16/8.23 * {@link Throwable#getCause()} method). (A null value
26.16/8.23 * is permitted, and indicates that the cause is nonexistent or
26.16/8.23 * unknown.)
26.16/8.23 * @since 1.5
26.16/8.23 */
26.16/8.23 public IllegalStateException(String message, Throwable cause) {
26.16/8.23 super(message, cause);
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs a new exception with the specified cause and a detail
26.16/8.23 * message of (cause==null ? null : cause.toString()) (which
26.16/8.23 * typically contains the class and detail message of cause).
26.16/8.23 * This constructor is useful for exceptions that are little more than
26.16/8.23 * wrappers for other throwables (for example, {@link
26.16/8.23 * java.security.PrivilegedActionException}).
26.16/8.23 *
26.16/8.23 * @param cause the cause (which is saved for later retrieval by the
26.16/8.23 * {@link Throwable#getCause()} method). (A null value is
26.16/8.23 * permitted, and indicates that the cause is nonexistent or
26.16/8.23 * unknown.)
26.16/8.23 * @since 1.5
26.16/8.23 */
26.16/8.23 public IllegalStateException(Throwable cause) {
26.16/8.23 super(cause);
26.16/8.23 }
26.16/8.23
26.16/8.23 static final long serialVersionUID = -1848914673093119416L;
26.16/8.23 }
26.16/8.23
26.16/8.23
26.16/8.23 /*
26.16/8.23 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.23 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.23 *
26.16/8.23 * This code is free software; you can redistribute it and/or modify it
26.16/8.23 * under the terms of the GNU General Public License version 2 only, as
26.16/8.23 * published by the Free Software Foundation. Sun designates this
26.16/8.23 * particular file as subject to the "Classpath" exception as provided
26.16/8.23 * by Sun in the LICENSE file that accompanied this code.
26.16/8.23 *
26.16/8.23 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.23 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.23 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.23 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.23 * accompanied this code).
26.16/8.23 *
26.16/8.23 * You should have received a copy of the GNU General Public License version
26.16/8.23 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.23 *
26.16/8.23 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.23 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.23 * have any questions.
26.16/8.23 */
26.16/8.23
26.16/8.23 package javaUtilEx;
26.16/8.23
26.16/8.23 /**
26.16/8.23 * An iterator over a collection. {@code Iterator} takes the place of
26.16/8.23 * {@link Enumeration} in the Java Collections Framework. Iterators
26.16/8.23 * differ from enumerations in two ways:
26.16/8.23 *
26.16/8.23 *
26.16/8.23 *
26.16/8.23 *
26.16/8.23 * (key==null ? k==null : key.equals(k)), that mapping
26.16/8.23 * is removed. (The map can contain at most one such mapping.)
26.16/8.23 *
26.16/8.23 *
26.16/8.23 * (e1.getKey()==null ?
26.16/8.23 * e2.getKey()==null : e1.getKey().equals(e2.getKey())) &&
26.16/8.23 * (e1.getValue()==null ?
26.16/8.23 * e2.getValue()==null : e1.getValue().equals(e2.getValue()))
26.16/8.23 *
26.16/8.23 * This ensures that the equals method works properly across
26.16/8.23 * different implementations of the Map.Entry interface.
26.16/8.23 *
26.16/8.23 * @param o object to be compared for equality with this map entry
26.16/8.23 * @return true if the specified object is equal to this map
26.16/8.23 * entry
26.16/8.23 */
26.16/8.23 boolean equals(Object o);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Returns the hash code value for this map entry. The hash code
26.16/8.23 * of a map entry e is defined to be:
26.16/8.23 * (e.getKey()==null ? 0 : e.getKey().hashCode()) ^
26.16/8.23 * (e.getValue()==null ? 0 : e.getValue().hashCode())
26.16/8.23 *
26.16/8.23 * This ensures that e1.equals(e2) implies that
26.16/8.23 * e1.hashCode()==e2.hashCode() for any two Entries
26.16/8.23 * e1 and e2, as required by the general
26.16/8.23 * contract of Object.hashCode.
26.16/8.23 *
26.16/8.23 * @return the hash code value for this map entry
26.16/8.23 * @see Object#hashCode()
26.16/8.23 * @see Object#equals(Object)
26.16/8.23 * @see #equals(Object)
26.16/8.23 */
26.16/8.23 int hashCode();
26.16/8.23 }
26.16/8.23
26.16/8.23 // Comparison and hashing
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Compares the specified object with this map for equality. Returns
26.16/8.23 * true if the given object is also a map and the two maps
26.16/8.23 * represent the same mappings. More formally, two maps m1 and
26.16/8.23 * m2 represent the same mappings if
26.16/8.23 * m1.entrySet().equals(m2.entrySet()). This ensures that the
26.16/8.23 * equals method works properly across different implementations
26.16/8.23 * of the Map interface.
26.16/8.23 *
26.16/8.23 * @param o object to be compared for equality with this map
26.16/8.23 * @return true if the specified object is equal to this map
26.16/8.23 */
26.16/8.23 boolean equals(Object o);
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Returns the hash code value for this map. The hash code of a map is
26.16/8.23 * defined to be the sum of the hash codes of each entry in the map's
26.16/8.23 * entrySet() view. This ensures that m1.equals(m2)
26.16/8.23 * implies that m1.hashCode()==m2.hashCode() for any two maps
26.16/8.23 * m1 and m2, as required by the general contract of
26.16/8.23 * {@link Object#hashCode}.
26.16/8.23 *
26.16/8.23 * @return the hash code value for this map
26.16/8.23 * @see Map.Entry#hashCode()
26.16/8.23 * @see Object#equals(Object)
26.16/8.23 * @see #equals(Object)
26.16/8.23 */
26.16/8.23 int hashCode();
26.16/8.23 }
26.16/8.23
26.16/8.23
26.16/8.23 /*
26.16/8.23 * Copyright 1994-1998 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.23 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.23 *
26.16/8.23 * This code is free software; you can redistribute it and/or modify it
26.16/8.23 * under the terms of the GNU General Public License version 2 only, as
26.16/8.23 * published by the Free Software Foundation. Sun designates this
26.16/8.23 * particular file as subject to the "Classpath" exception as provided
26.16/8.23 * by Sun in the LICENSE file that accompanied this code.
26.16/8.23 *
26.16/8.23 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.23 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.23 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.23 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.23 * accompanied this code).
26.16/8.23 *
26.16/8.23 * You should have received a copy of the GNU General Public License version
26.16/8.23 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.23 *
26.16/8.23 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.23 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.23 * have any questions.
26.16/8.23 */
26.16/8.23
26.16/8.23 package javaUtilEx;
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Thrown by the nextElement method of an
26.16/8.23 * Enumeration to indicate that there are no more
26.16/8.23 * elements in the enumeration.
26.16/8.23 *
26.16/8.23 * @author unascribed
26.16/8.23 * @see java.util.Enumeration
26.16/8.23 * @see java.util.Enumeration#nextElement()
26.16/8.23 * @since JDK1.0
26.16/8.23 */
26.16/8.23 public
26.16/8.23 class NoSuchElementException extends RuntimeException {
26.16/8.23 /**
26.16/8.23 * Constructs a NoSuchElementException with null
26.16/8.23 * as its error message string.
26.16/8.23 */
26.16/8.23 public NoSuchElementException() {
26.16/8.23 super();
26.16/8.23 }
26.16/8.23
26.16/8.23 /**
26.16/8.23 * Constructs a NoSuchElementException, saving a reference
26.16/8.23 * to the error message string s for later retrieval by the
26.16/8.23 * getMessage method.
26.16/8.23 *
26.16/8.23 * @param s the detail message.
26.16/8.23 */
26.16/8.23 public NoSuchElementException(String s) {
26.16/8.23 super(s);
26.16/8.23 }
26.16/8.23 }
26.16/8.23
26.16/8.23
26.16/8.23 package javaUtilEx;
26.16/8.23
26.16/8.23 public class Random {
26.16/8.23 static String[] args;
26.16/8.23 static int index = 0;
26.16/8.23
26.16/8.23 public static int random() {
26.16/8.23 String string = args[index];
26.16/8.23 index++;
26.16/8.23 return string.length();
26.16/8.23 }
26.16/8.23 }
26.16/8.23
26.16/8.23
26.16/8.23 /*
26.16/8.23 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.23 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.23 *
26.16/8.23 * This code is free software; you can redistribute it and/or modify it
26.16/8.23 * under the terms of the GNU General Public License version 2 only, as
26.16/8.23 * published by the Free Software Foundation. Sun designates this
26.16/8.23 * particular file as subject to the "Classpath" exception as provided
26.16/8.23 * by Sun in the LICENSE file that accompanied this code.
26.16/8.23 *
26.16/8.23 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.23 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.23 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.23 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.23 * accompanied this code).
26.16/8.23 *
26.16/8.23 * You should have received a copy of the GNU General Public License version
26.16/8.23 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.23 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.23 *
26.16/8.23 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.23 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.23 * have any questions.
26.16/8.23 */
26.16/8.23
26.16/8.23 package javaUtilEx;
26.16/8.23
26.16/8.23 /**
26.16/8.23 * A collection that contains no duplicate elements. More formally, sets
26.16/8.23 * contain no pair of elements e1 and e2 such that
26.16/8.23 * e1.equals(e2), and at most one null element. As implied by
26.16/8.23 * its name, this interface models the mathematical set abstraction.
26.16/8.23 *
26.16/8.23 *
26.16/8.23 * String[] y = x.toArray(new String[0]);
26.16/8.23 *
26.16/8.23 * Note that toArray(new Object[0]) is identical in function to
26.16/8.23 * toArray().
26.16/8.23 *
26.16/8.23 * @param a the array into which the elements of this set are to be
26.16/8.23 * stored, if it is big enough; otherwise, a new array of the same
26.16/8.23 * runtime type is allocated for this purpose.
26.16/8.23 * @return an array containing all the elements in this set
26.16/8.23 * @throws ArrayStoreException if the runtime type of the specified array
26.16/8.23 * is not a supertype of the runtime type of every element in this
26.16/8.23 * set
26.16/8.23 * @throws NullPointerException if the specified array is null
26.16/8.23 */
26.16/8.23 cause is
26.16/8.24 * not automatically incorporated in this exception's detail
26.16/8.24 * message.
26.16/8.24 *
26.16/8.24 * @param message the detail message (which is saved for later retrieval
26.16/8.24 * by the {@link Throwable#getMessage()} method).
26.16/8.24 * @param cause the cause (which is saved for later retrieval by the
26.16/8.24 * {@link Throwable#getCause()} method). (A null value
26.16/8.24 * is permitted, and indicates that the cause is nonexistent or
26.16/8.24 * unknown.)
26.16/8.24 * @since 1.5
26.16/8.24 */
26.16/8.24 public UnsupportedOperationException(String message, Throwable cause) {
26.16/8.24 super(message, cause);
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Constructs a new exception with the specified cause and a detail
26.16/8.24 * message of (cause==null ? null : cause.toString()) (which
26.16/8.24 * typically contains the class and detail message of cause).
26.16/8.24 * This constructor is useful for exceptions that are little more than
26.16/8.24 * wrappers for other throwables (for example, {@link
26.16/8.24 * java.security.PrivilegedActionException}).
26.16/8.24 *
26.16/8.24 * @param cause the cause (which is saved for later retrieval by the
26.16/8.24 * {@link Throwable#getCause()} method). (A null value is
26.16/8.24 * permitted, and indicates that the cause is nonexistent or
26.16/8.24 * unknown.)
26.16/8.24 * @since 1.5
26.16/8.24 */
26.16/8.24 public UnsupportedOperationException(Throwable cause) {
26.16/8.24 super(cause);
26.16/8.24 }
26.16/8.24
26.16/8.24 static final long serialVersionUID = -1242599979055084673L;
26.16/8.24 }
26.16/8.24
26.16/8.24
26.16/8.24
26.16/8.24 ----------------------------------------
26.16/8.24
26.16/8.24 (1) BareJBCToJBCProof (EQUIVALENT)
26.16/8.24 initialized classpath
26.16/8.24 ----------------------------------------
26.16/8.24
26.16/8.24 (2)
26.16/8.24 Obligation:
26.16/8.24 need to prove termination of the following program:
26.16/8.24 /*
26.16/8.24 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.24 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.24 *
26.16/8.24 * This code is free software; you can redistribute it and/or modify it
26.16/8.24 * under the terms of the GNU General Public License version 2 only, as
26.16/8.24 * published by the Free Software Foundation. Sun designates this
26.16/8.24 * particular file as subject to the "Classpath" exception as provided
26.16/8.24 * by Sun in the LICENSE file that accompanied this code.
26.16/8.24 *
26.16/8.24 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.24 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.24 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.24 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.24 * accompanied this code).
26.16/8.24 *
26.16/8.24 * You should have received a copy of the GNU General Public License version
26.16/8.24 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.24 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.24 *
26.16/8.24 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.24 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.24 * have any questions.
26.16/8.24 */
26.16/8.24
26.16/8.24 package javaUtilEx;
26.16/8.24
26.16/8.24 /**
26.16/8.24 * This class provides a skeletal implementation of the Collection
26.16/8.24 * interface, to minimize the effort required to implement this interface.
26.16/8.24 * (e1.getKey()==null ?
26.16/8.24 * e2.getKey()==null :
26.16/8.24 * e1.getKey().equals(e2.getKey()))
26.16/8.24 * &&
26.16/8.24 * (e1.getValue()==null ?
26.16/8.24 * e2.getValue()==null :
26.16/8.24 * e1.getValue().equals(e2.getValue()))
26.16/8.24 * This ensures that the {@code equals} method works properly across
26.16/8.24 * different implementations of the {@code Map.Entry} interface.
26.16/8.24 *
26.16/8.24 * @param o object to be compared for equality with this map entry
26.16/8.24 * @return {@code true} if the specified object is equal to this map
26.16/8.24 * entry
26.16/8.24 * @see #hashCode
26.16/8.24 */
26.16/8.24 public boolean equals(Object o) {
26.16/8.24 if (!(o instanceof Map.Entry))
26.16/8.24 return false;
26.16/8.24 Map.Entry e = (Map.Entry)o;
26.16/8.24 return eq(key, e.getKey()) && eq(value, e.getValue());
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Returns the hash code value for this map entry. The hash code
26.16/8.24 * of a map entry {@code e} is defined to be:
26.16/8.24 * (e.getKey()==null ? 0 : e.getKey().hashCode()) ^
26.16/8.24 * (e.getValue()==null ? 0 : e.getValue().hashCode())
26.16/8.24 * This ensures that {@code e1.equals(e2)} implies that
26.16/8.24 * {@code e1.hashCode()==e2.hashCode()} for any two Entries
26.16/8.24 * {@code e1} and {@code e2}, as required by the general
26.16/8.24 * contract of {@link Object#hashCode}.
26.16/8.24 *
26.16/8.24 * @return the hash code value for this map entry
26.16/8.24 * @see #equals
26.16/8.24 */
26.16/8.24 public int hashCode() {
26.16/8.24 return (key == null ? 0 : key.hashCode()) ^
26.16/8.24 (value == null ? 0 : value.hashCode());
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Returns a String representation of this map entry. This
26.16/8.24 * implementation returns the string representation of this
26.16/8.24 * entry's key followed by the equals character ("=")
26.16/8.24 * followed by the string representation of this entry's value.
26.16/8.24 *
26.16/8.24 * @return a String representation of this map entry
26.16/8.24 */
26.16/8.24 public String toString() {
26.16/8.24 return key + "=" + value;
26.16/8.24 }
26.16/8.24
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * An Entry maintaining an immutable key and value. This class
26.16/8.24 * does not support method setValue. This class may be
26.16/8.24 * convenient in methods that return thread-safe snapshots of
26.16/8.24 * key-value mappings.
26.16/8.24 *
26.16/8.24 * @since 1.6
26.16/8.24 */
26.16/8.24 public static class SimpleImmutableEntry
26.16/8.24 * (e1.getKey()==null ?
26.16/8.24 * e2.getKey()==null :
26.16/8.24 * e1.getKey().equals(e2.getKey()))
26.16/8.24 * &&
26.16/8.24 * (e1.getValue()==null ?
26.16/8.24 * e2.getValue()==null :
26.16/8.24 * e1.getValue().equals(e2.getValue()))
26.16/8.24 * This ensures that the {@code equals} method works properly across
26.16/8.24 * different implementations of the {@code Map.Entry} interface.
26.16/8.24 *
26.16/8.24 * @param o object to be compared for equality with this map entry
26.16/8.24 * @return {@code true} if the specified object is equal to this map
26.16/8.24 * entry
26.16/8.24 * @see #hashCode
26.16/8.24 */
26.16/8.24 public boolean equals(Object o) {
26.16/8.24 if (!(o instanceof Map.Entry))
26.16/8.24 return false;
26.16/8.24 Map.Entry e = (Map.Entry)o;
26.16/8.24 return eq(key, e.getKey()) && eq(value, e.getValue());
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Returns the hash code value for this map entry. The hash code
26.16/8.24 * of a map entry {@code e} is defined to be:
26.16/8.24 * (e.getKey()==null ? 0 : e.getKey().hashCode()) ^
26.16/8.24 * (e.getValue()==null ? 0 : e.getValue().hashCode())
26.16/8.24 * This ensures that {@code e1.equals(e2)} implies that
26.16/8.24 * {@code e1.hashCode()==e2.hashCode()} for any two Entries
26.16/8.24 * {@code e1} and {@code e2}, as required by the general
26.16/8.24 * contract of {@link Object#hashCode}.
26.16/8.24 *
26.16/8.24 * @return the hash code value for this map entry
26.16/8.24 * @see #equals
26.16/8.24 */
26.16/8.24 public int hashCode() {
26.16/8.24 return (key == null ? 0 : key.hashCode()) ^
26.16/8.24 (value == null ? 0 : value.hashCode());
26.16/8.24 }
26.16/8.24
26.16/8.24 /**
26.16/8.24 * Returns a String representation of this map entry. This
26.16/8.24 * implementation returns the string representation of this
26.16/8.24 * entry's key followed by the equals character ("=")
26.16/8.24 * followed by the string representation of this entry's value.
26.16/8.24 *
26.16/8.24 * @return a String representation of this map entry
26.16/8.24 */
26.16/8.24 public String toString() {
26.16/8.24 return key + "=" + value;
26.16/8.24 }
26.16/8.24
26.16/8.24 }
26.16/8.24
26.16/8.24 }
26.16/8.24
26.16/8.24
26.16/8.24 /*
26.16/8.24 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
26.16/8.24 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
26.16/8.24 *
26.16/8.24 * This code is free software; you can redistribute it and/or modify it
26.16/8.24 * under the terms of the GNU General Public License version 2 only, as
26.16/8.24 * published by the Free Software Foundation. Sun designates this
26.16/8.24 * particular file as subject to the "Classpath" exception as provided
26.16/8.24 * by Sun in the LICENSE file that accompanied this code.
26.16/8.24 *
26.16/8.24 * This code is distributed in the hope that it will be useful, but WITHOUT
26.16/8.24 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
26.16/8.24 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
26.16/8.24 * version 2 for more details (a copy is included in the LICENSE file that
26.16/8.24 * accompanied this code).
26.16/8.24 *
26.16/8.24 * You should have received a copy of the GNU General Public License version
26.16/8.24 * 2 along with this work; if not, write to the Free Software Foundation,
26.16/8.24 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26.16/8.24 *
26.16/8.24 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
26.16/8.24 * CA 95054 USA or visit www.sun.com if you need additional information or
26.16/8.24 * have any questions.
26.16/8.24 */
26.16/8.24
26.16/8.24 package javaUtilEx;
26.16/8.24
26.16/8.24 /**
26.16/8.24 * This class provides a skeletal implementation of the Set
26.16/8.24 * interface to minimize the effort required to implement this
26.16/8.24 * interface.