Package org.apache.sis.util.collection
Class CodeListSet<E extends CodeList<E>>
Object
AbstractCollection<E>
AbstractSet<E>
CodeListSet<E>
- Type Parameters:
E- the type of code list elements in the set.
- All Implemented Interfaces:
Serializable,Cloneable,Iterable<E>,Collection<E>,Set<E>,CheckedContainer<E>
public class CodeListSet<E extends CodeList<E>>
extends AbstractSet<E>
implements CheckedContainer<E>, Cloneable, Serializable
A specialized
Set implementation for use with CodeList values.
All elements in a CodeListSet are of the same CodeList class,
which must be final. Iterators traverse the elements in the order in which the
code list constants are declared.
Implementation note
CodeListSet is implemented internally by bit vectors for compact and efficient storage.
All bulk operations (addAll, removeAll, containsAll) are very quick if
their argument is also a CodeListSet instance.
Usage example
The following example creates a set ofAxisDirections
for a (x,y,z) coordinate system:
CodeListSet<AxisDirection> codes = new CodeListSet<>(AxisDirection.class); Collections.addAll(codes, AxisDirection.EAST, AxisDirection.NORTH, AxisDirection.UP),
- Since:
- 0.3
- See Also:
Defined in the sis-utility module
-
Constructor Summary
ConstructorsConstructorDescriptionCodeListSet(Class<E> elementType) Creates an initially empty set for code lists of the given type.CodeListSet(Class<E> elementType, boolean fill) Creates set for code lists of the given type. -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds the specified code list element in this set.booleanaddAll(Collection<? extends E> c) Adds all elements of the given collection to this set.voidclear()Removes all elements from this set.clone()Returns a new set of the same class containing the same elements than this set.booleanReturnstrueif this set contains the given element.booleancontainsAll(Collection<?> c) Returnstrueif this set contains all the elements of the given collection.Returns the type of code list elements in this set.booleanisEmpty()Returnstrueif this set does not contains any element.iterator()Returns an iterator over the elements in this set.booleanRemoves the specified code list element from this set.booleanremoveAll(Collection<?> c) Adds all elements of the given collection from this set.booleanretainAll(Collection<?> c) Retains only the elements of the given collection in this set.intsize()Returns the number of elements in this set.Methods inherited from class AbstractSet
equals, hashCodeMethods inherited from class AbstractCollection
toArray, toArray, toStringMethods inherited from interface Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface Set
spliterator, toArray, toArray
-
Constructor Details
-
CodeListSet
Creates an initially empty set for code lists of the given type. The givenCodeListtype shall be final.- Parameters:
elementType- the type of code list elements to be included in this set.- Throws:
IllegalArgumentException- if the given class is not final.
-
CodeListSet
Creates set for code lists of the given type. If thefillargument isfalse, then the new set will be initially empty. Otherwise the new set will be filled with all code list elements of the given type that are known at construction time. Note that if new code list elements are created after the invocation of thisCodeListSetconstructor, then those new elements will not be in this set.- Parameters:
elementType- the type of code list elements to be included in this set.fill-truefor filling the set with all known elements of the given type, orfalsefor leaving the set empty.- Throws:
IllegalArgumentException- if the given class is not final.
-
-
Method Details
-
getElementType
Returns the type of code list elements in this set.- Specified by:
getElementTypein interfaceCheckedContainer<E extends CodeList<E>>- Returns:
- the type of code list elements in this set.
-
clear
public void clear()Removes all elements from this set. -
isEmpty
public boolean isEmpty()Returnstrueif this set does not contains any element. -
size
public int size()Returns the number of elements in this set. -
add
Adds the specified code list element in this set.- Specified by:
addin interfaceCollection<E extends CodeList<E>>- Specified by:
addin interfaceSet<E extends CodeList<E>>- Overrides:
addin classAbstractCollection<E extends CodeList<E>>- Parameters:
element- the code list element to add in this set.- Returns:
trueif this set has been modified as a consequence of this method call.
-
remove
Removes the specified code list element from this set. This methods does nothing if the given argument isnullor is not an instance of the code list class specified at construction time.- Specified by:
removein interfaceCollection<E extends CodeList<E>>- Specified by:
removein interfaceSet<E extends CodeList<E>>- Overrides:
removein classAbstractCollection<E extends CodeList<E>>- Parameters:
object- the code list element to remove from this set.- Returns:
trueif this set has been modified as a consequence of this method call.
-
contains
Returnstrueif this set contains the given element. This methods returnsfalseif the given argument isnullor is not an instance of the code list class specified at construction time.- Specified by:
containsin interfaceCollection<E extends CodeList<E>>- Specified by:
containsin interfaceSet<E extends CodeList<E>>- Overrides:
containsin classAbstractCollection<E extends CodeList<E>>- Parameters:
object- the element to test for presence in this set.- Returns:
trueif the given object is contained in this set.
-
containsAll
Returnstrueif this set contains all the elements of the given collection.- Specified by:
containsAllin interfaceCollection<E extends CodeList<E>>- Specified by:
containsAllin interfaceSet<E extends CodeList<E>>- Overrides:
containsAllin classAbstractCollection<E extends CodeList<E>>- Parameters:
c- the collection to be checked for containment in this set.- Returns:
trueif this set contains all elements of the given collection.
-
addAll
Adds all elements of the given collection to this set.- Specified by:
addAllin interfaceCollection<E extends CodeList<E>>- Specified by:
addAllin interfaceSet<E extends CodeList<E>>- Overrides:
addAllin classAbstractCollection<E extends CodeList<E>>- Parameters:
c- the collection containing elements to be added to this set.- Returns:
trueif this set changed as a result of this method call.- Throws:
IllegalArgumentException
-
removeAll
Adds all elements of the given collection from this set.- Specified by:
removeAllin interfaceCollection<E extends CodeList<E>>- Specified by:
removeAllin interfaceSet<E extends CodeList<E>>- Overrides:
removeAllin classAbstractSet<E extends CodeList<E>>- Parameters:
c- the collection containing elements to be removed from this set.- Returns:
trueif this set changed as a result of this method call.
-
retainAll
Retains only the elements of the given collection in this set.- Specified by:
retainAllin interfaceCollection<E extends CodeList<E>>- Specified by:
retainAllin interfaceSet<E extends CodeList<E>>- Overrides:
retainAllin classAbstractCollection<E extends CodeList<E>>- Parameters:
c- the collection containing elements to retain in this set.- Returns:
trueif this set changed as a result of this method call.
-
iterator
Returns an iterator over the elements in this set. The instance returned by this implementation will iterate over a snapshot of thisCodeListSetcontent at the time this method has been invoked. Changes in thisCodeListSetmade after this method call will not affect the values returned by the iterator.- Specified by:
iteratorin interfaceCollection<E extends CodeList<E>>- Specified by:
iteratorin interfaceIterable<E extends CodeList<E>>- Specified by:
iteratorin interfaceSet<E extends CodeList<E>>- Specified by:
iteratorin classAbstractCollection<E extends CodeList<E>>- Returns:
- an iterator over the elements in this set.
-
clone
Returns a new set of the same class containing the same elements than this set.
-