de.carne.util

Class DefaultSet<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<T>

de.carne.util.DefaultSet<T>

Type Parameters:

T - The set element type.

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

public final class DefaultSet<T>
extends java.util.HashSet<T>

Utility class combining a result set with a corresponding default value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultSet() Construct DefaultSet.
DefaultSet(java.util.Collection<? extends T> elements) Construct DefaultSet.

Method Summary

Modifier and Type	Method and Description
boolean	add(T entry)
void	addDefault(T entry) Add an entry to the set and make it the default.
void	clear()
T	getDefault() Get the default entry.

Methods inherited from class java.util.HashSet

clone, contains, isEmpty, iterator, remove, size, spliterator

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DefaultSet

public DefaultSet()

Construct DefaultSet.

DefaultSet

public DefaultSet(java.util.Collection<? extends T> elements)

Construct DefaultSet.

Parameters:

elements - The initial set elements.

Method Detail

add

public boolean add(@Nullable
                   T entry)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

Overrides:

add in class java.util.HashSet<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

Overrides:

clear in class java.util.HashSet<T>

addDefault

public void addDefault(@Nullable
                       T entry)

Add an entry to the set and make it the default.

Parameters:

entry - The default entry.

getDefault

@Nullable
public T getDefault()

Get the default entry.

Returns:

The default entry.