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