Package org.apache.sis.util.collection

Class DerivedSet.Invertible<S,E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.apache.sis.internal.util.SetOfUnknownSize<E>

org.apache.sis.util.collection.DerivedSet<S,E>

org.apache.sis.util.collection.DerivedSet.Invertible<S,E>

Type Parameters:

S - the type of elements in the storage set.

E - the type of elements in this set.

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>, CheckedContainer<E>

Direct Known Subclasses:

DerivedSet.Bijective

Enclosing class:

DerivedSet<S,E>

private static class DerivedSet.Invertible<S,E>
extends DerivedSet<S,E>

A DerivedSet for invertible converters. Availability of the inverse conversion allows us to delegate the contains(Object) and remove(Object) operations to the DerivedSet.storage set instead of iterating over all elements.

Field Summary

Fields

Modifier and Type	Field	Description
private final ObjectConverter<E,S>	inverse	The converter from the derived to the storage type.
private static final long	serialVersionUID	For cross-version compatibility.

Fields inherited from class org.apache.sis.util.collection.DerivedSet

converter, storage

Constructor Summary

Constructors

Constructor	Description
Invertible(Set<S> storage, ObjectConverter<S,E> converter)	Creates a new derived set from the specified storage set.

Method Summary

Modifier and Type	Method	Description
final boolean	add(E element)	Ensures that this set contains the specified element.
final boolean	contains(Object element)	Returns true if this set contains the specified element.
final boolean	remove(Object element)	Removes a single instance of the specified element from this set.

Methods inherited from class org.apache.sis.util.collection.DerivedSet

add, create, getElementType, isEmpty, iterator

Methods inherited from class org.apache.sis.internal.util.SetOfUnknownSize

equals, isSizeKnown, removeAll, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSet

hashCode

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, retainAll, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, clear, containsAll, retainAll

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

inverse

private final ObjectConverter<E,S> inverse

The converter from the derived to the storage type.

Constructor Details

Invertible

Invertible(Set<S> storage,
 ObjectConverter<S,E> converter)

Creates a new derived set from the specified storage set.

Parameters:

storage - the set which actually store the elements.

converter - the type of elements in this derived set.

Method Details

add

public final boolean add(E element)
                  throws UnsupportedOperationException

Ensures that this set contains the specified element. This method first checks if the given element is non-null, then delegates to the DerivedSet.storage set like below:

Specified by:

add in interface Collection<S>

Specified by:

add in interface Set<S>

Overrides:

add in class DerivedSet<S,E>

Parameters:

element - element whose presence in this set is to be ensured.

Returns:

true if the set changed as a result of the call.

Throws:

UnsupportedOperationException - if the DerivedSet.storage set doesn't supports the add operation.

contains

public final boolean contains(Object element)

Returns true if this set contains the specified element. This method first checks if the given element is an instance of DerivedSet.getElementType(), then delegates to the DerivedSet.storage set like below:

Specified by:

contains in interface Collection<S>

Specified by:

contains in interface Set<S>

Overrides:

contains in class AbstractCollection<E>

Parameters:

element - object to be checked for containment in this set.

Returns:

true if this set contains the specified element.

remove

public final boolean remove(Object element)
                     throws UnsupportedOperationException

Removes a single instance of the specified element from this set. This method first checks if the given element is an instance of DerivedSet.getElementType(), then delegates to the DerivedSet.storage set like below:

Specified by:

remove in interface Collection<S>

Specified by:

remove in interface Set<S>

Overrides:

remove in class AbstractCollection<E>

Parameters:

element - element to be removed from this set, if present.

Returns:

true if the set contained the specified element.

Throws:

UnsupportedOperationException - if the DerivedSet.storage set doesn't supports the remove operation.