Known Direct Subclasses
  
      
      
  
        
              | HashSet<E> | 
              HashSet is an implementation of a Set.  | 
           
        
              | TreeSet<E> | 
              TreeSet is an implementation of SortedSet.  | 
           
   
       
   
 | 
   Known Indirect Subclasses
  
 | 
Class Overview
An AbstractSet is an abstract implementation of the Set interface. This
 implementation does not support adding. A subclass must implement the
 abstract methods iterator() and size().
 
Summary
| Protected Constructors | 
	 
    
        | 
            
            
            
            
            
            
         | 
        
        AbstractSet()
        
         Constructs a new instance of this AbstractSet. 
  
   | 
| Public Methods | 
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        equals(Object object)
        
         Compares the specified object to this Set and returns true if they are equal. 
  
   | 
	 
    
        | 
            
            
            
            
            
            int
         | 
        
        hashCode()
        
         Returns the hash code for this set. 
  
   | 
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        removeAll(Collection<?> collection)
        
         Removes all occurrences in this collection which are contained in the
 specified collection. 
  
   | 
| 
  [Expand]
   Inherited Methods  | 
   
From class
  java.util.AbstractCollection
  
   
  
    
    
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        add(E object)
        
         Attempts to add object to the contents of this Collection
 (optional). 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        addAll(Collection<? extends E> collection)
        
         Attempts to add all of the objects contained in collection to the
 contents of this Collection (optional). 
  
   |  
	 
    
        | 
            
            
            
            
            
            void
         | 
        
        clear()
        
         Removes all elements from this Collection, leaving it empty
 (optional). 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        contains(Object object)
        
         Tests whether this Collection contains the specified object. 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        containsAll(Collection<?> collection)
        
         Tests whether this Collection contains all objects contained in the
 specified Collection. 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        isEmpty()
        
         Returns if this Collection contains no elements. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            Iterator<E>
         | 
        
        iterator()
        
        Returns an instance of  Iterator that may be used to access the
 objects contained by this  Collection.  
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        remove(Object object)
        
         Removes one instance of the specified object from this Collection if
 one is contained (optional). 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        removeAll(Collection<?> collection)
        
         Removes all occurrences in this Collection of each object in the
 specified Collection (optional). 
  
   |  
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        retainAll(Collection<?> collection)
        
         Removes all objects from this Collection that are not also found in
 the Collection passed (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            int
         | 
        
        size()
        
         Returns a count of how many objects this Collection contains. 
  
   |  
	 
    
        | 
            
            
            
            
            
            Object[]
         | 
        
        toArray()
        
         Returns a new array containing all elements contained in this
 ArrayList. 
  
   |  
	 
    
        | 
            
            
            
            
            
            String
         | 
        
        toString()
        
         Returns the string representation of this Collection. 
  
   |  
 
   
 
 | 
   
From class
  java.lang.Object
  
   
  
    
    
	 
    
        | 
            
            
            
            
            
            boolean
         | 
        
        equals(Object obj)
        
         Indicates whether some other object is "equal to" this one. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            Class<?>
         | 
        
        getClass()
        
         Returns the runtime class of an object. 
  
   |  
	 
    
        | 
            
            
            
            
            
            int
         | 
        
        hashCode()
        
         Returns a hash code value for the object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notify()
        
         Wakes up a single thread that is waiting on this object's monitor. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        notifyAll()
        
         Wakes up all threads that are waiting on this object's monitor. 
  
   |  
	 
    
        | 
            
            
            
            
            
            String
         | 
        
        toString()
        
         Returns a string representation of the object. 
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long timeout, int nanos)
        
        Causes current thread to wait until another thread invokes the
  notify() method or the
  notifyAll() method for this object, or some other
 thread interrupts the current thread, or a certain amount of real time has
 elapsed.  
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait(long timeout)
        
        Causes current thread to wait until either another thread invokes the
  notify() method or the
  notifyAll() method for this object, or a specified
 amount of time has elapsed.  
  
   |  
	 
    
        | 
            
            
            final
            
            
            void
         | 
        
        wait()
        
        Causes current thread to wait until another thread invokes the
  notify() method or the
  notifyAll() method for this object.  
  
   |  
 
   
 
 | 
   
From interface
  java.lang.Iterable
 | 
   
From interface
  java.util.Collection
  
   
  
    
    
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        add(E object)
        
         Attempts to add object to the contents of this Collection
 (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        addAll(Collection<? extends E> collection)
        
         Attempts to add all of the objects contained in Collection to the
 contents of this Collection (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            void
         | 
        
        clear()
        
         Removes all elements from this Collection, leaving it empty
 (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        contains(Object object)
        
         Tests whether this Collection contains the specified object. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        containsAll(Collection<?> collection)
        
         Tests whether this Collection contains all objects contained in the
 specified Collection. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        equals(Object object)
        
         Compares the argument to the receiver, and returns true if they represent the
 same object using a class specific comparison. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            int
         | 
        
        hashCode()
        
         Returns an integer hash code for the receiver. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        isEmpty()
        
         Returns if this Collection contains no elements. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            Iterator<E>
         | 
        
        iterator()
        
        Returns an instance of  Iterator that may be used to access the
 objects contained by this  Collection.  
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        remove(Object object)
        
         Removes one instance of the specified object from this Collection if
 one is contained (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        removeAll(Collection<?> collection)
        
         Removes all occurrences in this Collection of each object in the
 specified Collection (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        retainAll(Collection<?> collection)
        
         Removes all objects from this Collection that are not also found in
 the Collection passed (optional). 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            int
         | 
        
        size()
        
         Returns a count of how many objects this Collection contains. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            <T>
            T[]
         | 
        
        toArray(T[] a)
        
         Returns an array containing all of the elements in this collection; the
 runtime type of the returned array is that of the specified array. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            Object[]
         | 
        
        toArray()
        
         Returns an array containing all of the elements in this collection. 
  
   |  
 
   
 
 | 
   
From interface
  java.util.Set
  
   
  
    
    
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        add(E object)
        
         Adds the specified object to this set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        addAll(Collection<? extends E> collection)
        
         Adds the objects in the specified collection which do not exist yet in this
 set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            void
         | 
        
        clear()
        
         Removes all elements from this set, leaving it empty. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        contains(Object object)
        
         Searches this set for the specified object. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        containsAll(Collection<?> collection)
        
         Searches this set for all objects in the specified collection. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        equals(Object object)
        
         Compares the specified object to this set, and returns true if they represent
 the same object using a class specific comparison. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            int
         | 
        
        hashCode()
        
         Returns the hash code for this set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        isEmpty()
        
         Returns true if this set has no elements. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            Iterator<E>
         | 
        
        iterator()
        
         Returns an iterator on the elements of this set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        remove(Object object)
        
         Removes the specified object from this set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        removeAll(Collection<?> collection)
        
         Removes all objects in the specified collection from this set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            boolean
         | 
        
        retainAll(Collection<?> collection)
        
         Removes all objects from this set that are not contained in the specified
 collection. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            int
         | 
        
        size()
        
         Returns the number of elements in this set. 
  
   |  
	 
    
        | 
            abstract
            
            
            
            
            Object[]
         | 
        
        toArray()
        
         Returns an array containing all elements contained in this set. 
  
   |  
 
   
 
 | 
 
Protected Constructors
 
    
      
        protected 
         
         
         
         
        
      
      AbstractSet
      ()
    
      
    
      
  Constructs a new instance of this AbstractSet.
 
     
 
Public Methods
 
    
      
        public 
         
         
         
         
        boolean
      
      equals
      (Object object)
    
      
    
      
  Compares the specified object to this Set and returns true if they are equal.
 The object must be an instance of Set and contain the same objects.
 
  
      Parameters
      
        
          | object | 
          the object to compare with this set. | 
        
      
   
  
      Returns
      true if the specified object is equal to this set,
         false otherwise
   
  
     
 
 
    
      
        public 
         
         
         
         
        int
      
      hashCode
      ()
    
      
    
      
  Returns the hash code for this set. Two set which are equal must return the
 same value. This implementation calculates the hash code by adding each
 element's hash code.
 
  
      Returns
      - the hash code of this set.
 
   
  
     
 
 
    
      
        public 
         
         
         
         
        boolean
      
      removeAll
      (Collection<?> collection)
    
      
    
      
  Removes all occurrences in this collection which are contained in the
 specified collection.
 
  
      Parameters
      
        
          | collection | 
          the collection of objects to remove. | 
        
      
   
  
      Returns
      true if this collection was modified, false
         otherwise.