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