org.key_project.util.collection

Interface ImmutableSet<T>

All Superinterfaces:

java.lang.Iterable<T>, java.io.Serializable

All Known Implementing Classes:

DefaultImmutableSet, DefaultImmutableSet.NILSet

public interface ImmutableSet<T>
extends java.lang.Iterable<T>, java.io.Serializable

interface implemented by non-destructive Sets. CONVENTION: Each SetOf implementation has to offer a public static final variable .nil()

Method Summary

Modifier and Type	Method and Description
ImmutableSet<T>	add(T element) Adds an element
ImmutableSet<T>	addUnique(T element) adds an element, barfs if the element is already present
boolean	contains(T obj)
boolean	equals(java.lang.Object o)
boolean	exists(java.util.function.Predicate<T> predicate) return true if predicate is fullfilled for at least one element
int	hashCode()
ImmutableSet<T>	intersect(ImmutableSet<? extends T> set)
boolean	isEmpty()
java.util.Iterator<T>	iterator()
ImmutableSet<T>	remove(T element)
int	size()
java.util.stream.Stream<T>	stream()
boolean	subset(ImmutableSet<T> s)
<S> S[]	toArray(S[] array) Convert the set to a Java array
java.util.Set<T>	toSet()
ImmutableSet<T>	union(ImmutableSet<? extends T> set)

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

toSet

java.util.Set<T> toSet()

Returns:

a Set containing the same elements as this ImmutableSet

add

ImmutableSet<T> add(T element)

Adds an element

Returns:

a set containing all elements of this one and the specified element.

union

ImmutableSet<T> union(ImmutableSet<? extends T> set)

Returns:

union of this set with set

intersect

ImmutableSet<T> intersect(ImmutableSet<? extends T> set)

Returns:

intersection of this set with set

iterator

java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Returns:

Iterator of the set

stream

java.util.stream.Stream<T> stream()

Returns:

Stream of the set

exists

boolean exists(java.util.function.Predicate<T> predicate)

return true if predicate is fullfilled for at least one element

Parameters:

predicate - the predicate

Returns:

true if predicate is fullfilled for at least one element

contains

boolean contains(T obj)

Returns:

true iff obj in set

subset

boolean subset(ImmutableSet<T> s)

Returns:

true iff this set is subset of set s

size

int size()

Returns:

int the cardinality of the set

isEmpty

boolean isEmpty()

Returns:

true iff the set is empty

remove

ImmutableSet<T> remove(T element)

Returns:

set without element

equals

boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

Returns:

true iff the this set is subset of o and vice versa.

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

addUnique

ImmutableSet<T> addUnique(T element)
                   throws NotUniqueException

adds an element, barfs if the element is already present

Parameters:

element - of type that has to be added to this set

Throws:

org.key_project.utils.collection.NotUniqueException - if the element is already present

NotUniqueException

toArray

<S> S[] toArray(S[] array)

Convert the set to a Java array