Package org.apache.sis.internal.metadata

Class ExcludedSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.apache.sis.internal.metadata.ExcludedSet<E>

Type Parameters:

E - the type of elements that the collection would have if it was non-empty.

All Implemented Interfaces:

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

public final class ExcludedSet<E>
extends AbstractSet<E>
implements Serializable

A unmodifiable empty set with a customized exception message thrown by the add(Object) method. This set is used only for mutually exclusive properties, when a collection cannot have elements because the other property is set.

Since:

0.3

Version:

0.3

Author:

Martin Desruisseaux (Geomatys)

See Also:

• Collections.emptySet()
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExcludedSet(String name1, String name2)	Creates a new empty set.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)	Unconditionally throws a UnsupportedOperationException with a message saying which properties are mutually exclusive.
boolean	isEmpty()	Returns true since this set is always empty.
Iterator<E>	iterator()	Returns the empty iterator.
int	size()	Returns 0 since this set is always empty.

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, contains, containsAll, remove, retainAll, toArray, toArray, 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, contains, containsAll, remove, retainAll, spliterator, toArray, toArray

Constructor Details

ExcludedSet

public ExcludedSet(String name1,
 String name2)

Creates a new empty set.

Parameters:

name1 - the name of the first mutually exclusive property.

name2 - the name of the second mutually exclusive property.

Method Details

isEmpty

public boolean isEmpty()

Returns true since this set is always empty.

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

Returns:

true

size

public int size()

Returns 0 since this set is always empty.

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

Returns:

0

iterator

public Iterator<E> iterator()

Returns the empty iterator.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

Returns:

empty iterator.

add

public boolean add(E e)

Unconditionally throws a UnsupportedOperationException with a message saying which properties are mutually exclusive.

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

Parameters:

e - ignored.

Returns:

never return.