Build 1.0_r1(from source)

java.util
Class MiniEnumSet<E extends Enum<E>>

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractSet<E>
          extended by java.util.EnumSet<E>
              extended by java.util.MiniEnumSet<E>
All Implemented Interfaces:
Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>

final class MiniEnumSet<E extends Enum<E>>
extends EnumSet<E>

This is a concrete subclass of EnumSet designed specifically for enum type with less than or equal to 64 elements.


Field Summary
 
Fields inherited from class java.util.EnumSet
elementClass, LANG_BOOTSTRAP
 
Constructor Summary
MiniEnumSet(Class<E> elementType, E[] enums)
          Constructs an instance.
 
Method Summary
 boolean add(E element)
          If the specified element is not contained within this collection, and addition of this element succeeds, then true will be returned.
 boolean addAll(Collection<? extends E> collection)
          Adds the objects in the specified Collection to this Collection.
 void clear()
          Removes all the elements in this collection.
(package private)  void complement()
           
 boolean contains(Object object)
          Searches this Collection for the specified object.
 boolean containsAll(Collection<?> collection)
          Searches this Collection for all objects in the specified Collection.
 boolean equals(Object object)
          Compares the specified object to this Set and answer if they are equal.
 Iterator<E> iterator()
          Returns an Iterator on the elements of this Collection.
 boolean remove(Object object)
          Removes the first occurrence of the specified object from this Collection.
 boolean removeAll(Collection<?> collection)
          Removes all occurrences in this Collection of each object in the specified Collection.
 boolean retainAll(Collection<?> collection)
          Removes all objects from this Collection that are not contained in the specified Collection.
(package private)  void setRange(E start, E end)
           
 int size()
          Returns the number of elements in this Collection.
 
Methods inherited from class java.util.EnumSet
allOf, clone, complementOf, copyOf, copyOf, isValidType, noneOf, of, of, of, of, of, of, range, writeReplace
 
Methods inherited from class java.util.AbstractSet
hashCode
 
Methods inherited from class java.util.AbstractCollection
isEmpty, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Set
isEmpty, toArray, toArray
 

Constructor Detail

MiniEnumSet

MiniEnumSet(Class<E> elementType,
            E[] enums)
Constructs an instance.

Parameters:
elementType - non-null; type of the elements
enums - non-null; prepopulated array of constants in ordinal order
Method Detail

iterator

public Iterator<E> iterator()
Description copied from class: AbstractCollection
Returns an Iterator on the elements of this Collection. A subclass must implement the abstract methods iterator() and size().

Specified by:
iterator in interface Iterable<E extends Enum<E>>
Specified by:
iterator in interface Collection<E extends Enum<E>>
Specified by:
iterator in interface Set<E extends Enum<E>>
Specified by:
iterator in class AbstractCollection<E extends Enum<E>>
Returns:
an Iterator on the elements of this Collection
See Also:
Iterator

size

public int size()
Description copied from class: AbstractCollection
Returns the number of elements in this Collection.

Specified by:
size in interface Collection<E extends Enum<E>>
Specified by:
size in interface Set<E extends Enum<E>>
Specified by:
size in class AbstractCollection<E extends Enum<E>>
Returns:
the number of elements in this Collection

clear

public void clear()
Description copied from class: AbstractCollection
Removes all the elements in this collection. This collection will be cleared up after this operation. The operation iterates over the collection, removes every element using Iterator.remove method. UnsupportedOperationException will be thrown out if the iterator returned by this collection does not implement the remove method and the collection is not zero length.

Specified by:
clear in interface Collection<E extends Enum<E>>
Specified by:
clear in interface Set<E extends Enum<E>>
Overrides:
clear in class AbstractCollection<E extends Enum<E>>
See Also:
Collection.isEmpty(), Collection.size()

add

public boolean add(E element)
Description copied from class: AbstractCollection
If the specified element is not contained within this collection, and addition of this element succeeds, then true will be returned. If the specified element is already contained within this collection, or duplication is not permitted, false will be returned. Different implementations may add specific limitations on this method to filter permitted elements. For example, in some implementation, null element may be denied, and NullPointerException will be thrown out. These limitations should be explicitly documented by specific collection implementation. Add operation is not supported in this implementation, and UnsupportedOperationException will always be thrown out.

Specified by:
add in interface Collection<E extends Enum<E>>
Specified by:
add in interface Set<E extends Enum<E>>
Overrides:
add in class AbstractCollection<E extends Enum<E>>
Parameters:
element - the element to be added.
Returns:
true if the collection is changed successfully after invoking this method. Otherwise, false.

addAll

public boolean addAll(Collection<? extends E> collection)
Description copied from class: AbstractCollection
Adds the objects in the specified Collection to this Collection.

Specified by:
addAll in interface Collection<E extends Enum<E>>
Specified by:
addAll in interface Set<E extends Enum<E>>
Overrides:
addAll in class AbstractCollection<E extends Enum<E>>
Parameters:
collection - the Collection of objects
Returns:
true if this Collection is modified, false otherwise

contains

public boolean contains(Object object)
Description copied from class: AbstractCollection
Searches this Collection for the specified object.

Specified by:
contains in interface Collection<E extends Enum<E>>
Specified by:
contains in interface Set<E extends Enum<E>>
Overrides:
contains in class AbstractCollection<E extends Enum<E>>
Parameters:
object - the object to search for
Returns:
true if object is an element of this Collection, false otherwise

containsAll

public boolean containsAll(Collection<?> collection)
Description copied from class: AbstractCollection
Searches this Collection for all objects in the specified Collection.

Specified by:
containsAll in interface Collection<E extends Enum<E>>
Specified by:
containsAll in interface Set<E extends Enum<E>>
Overrides:
containsAll in class AbstractCollection<E extends Enum<E>>
Parameters:
collection - the Collection of objects
Returns:
true if all objects in the specified Collection are elements of this Collection, false otherwise

removeAll

public boolean removeAll(Collection<?> collection)
Description copied from class: AbstractSet
Removes all occurrences in this Collection of each object in the specified Collection.

Specified by:
removeAll in interface Collection<E extends Enum<E>>
Specified by:
removeAll in interface Set<E extends Enum<E>>
Overrides:
removeAll in class AbstractSet<E extends Enum<E>>
Parameters:
collection - the Collection of objects to remove
Returns:
true if this Collection is modified, false otherwise

retainAll

public boolean retainAll(Collection<?> collection)
Description copied from class: AbstractCollection
Removes all objects from this Collection that are not contained in the specified Collection. This operation traverses over the collection itself, to verify whether any element is contained in the specified collection. The object will be removed from the collection itself using the iterator's remove method if it is not contained in the specified collection. This collection will throw an UnsupportedOperationException if the iterator returned does not implement remove method, and the collection itself does contain elements which do not exist in the specified collection.

Specified by:
retainAll in interface Collection<E extends Enum<E>>
Specified by:
retainAll in interface Set<E extends Enum<E>>
Overrides:
retainAll in class AbstractCollection<E extends Enum<E>>
Parameters:
collection - the Collection of objects to retain
Returns:
true if this Collection is modified, false otherwise

remove

public boolean remove(Object object)
Description copied from class: AbstractCollection
Removes the first occurrence of the specified object from this Collection. This operation traverses over the collection, looking for the specified object. Once the object is found, the object will be removed from the collection using the iterator's remove method. This collection will throw an UnsupportedOperationException if the iterator returned does not implement remove method, and the specified object is in this collection.

Specified by:
remove in interface Collection<E extends Enum<E>>
Specified by:
remove in interface Set<E extends Enum<E>>
Overrides:
remove in class AbstractCollection<E extends Enum<E>>
Parameters:
object - the object to remove
Returns:
true if this Collection is modified, false otherwise

equals

public boolean equals(Object object)
Description copied from class: AbstractSet
Compares the specified object to this Set and answer if they are equal. The object must be an instance of Set and contain the same objects.

Specified by:
equals in interface Collection<E extends Enum<E>>
Specified by:
equals in interface Set<E extends Enum<E>>
Overrides:
equals in class AbstractSet<E extends Enum<E>>
Parameters:
object - the object to compare with this object
Returns:
true if the specified object is equal to this Set, false otherwise
See Also:
AbstractSet.hashCode()

complement

void complement()
Specified by:
complement in class EnumSet<E extends Enum<E>>

setRange

void setRange(E start,
              E end)
Specified by:
setRange in class EnumSet<E extends Enum<E>>

Build 1.0_r1(from source)

Please submit a feedback, bug or feature