org.organicdesign.fp.collections

Interface ImSet<E>

All Superinterfaces:

BaseSet<E>, Collection<E>, Iterable<E>, Set<E>, Sized, Transformable<E>, UnmodCollection<E>, UnmodIterable<E>, UnmodSet<E>

All Known Implementing Classes:

PersistentHashSet

public interface ImSet<E>
extends BaseSet<E>

An immutable set with no guarantees about its ordering

Method Summary

Modifier and Type	Method and Description
MutableSet<E>	mutable() Returns a mutable version of this immutable set.
ImSet<E>	put(E e) Adds an element, returning a modified version of the set (leaving the original set unchanged).
default ImSet<E>	union(Iterable<? extends E> iter) Returns a new set containing all the items.
ImSet<E>	without(E key) Removes this key from the set

Methods inherited from interface org.organicdesign.fp.collections.UnmodSet

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, toArray, toArray

Methods inherited from interface org.organicdesign.fp.collections.UnmodIterable

concat, drop, dropWhile, filter, flatMap, fold, foldUntil, hash, head, map, precat, take, takeWhile, toString

Methods inherited from interface org.organicdesign.fp.xform.Transformable

toImList, toImMap, toImRrbt, toImSet, toImSortedMap, toImSortedSet, toMutableList, toMutableMap, toMutableRrbt, toMutableSet, toMutableSortedMap, toMutableSortedSet

Methods inherited from interface org.organicdesign.fp.collections.Sized

size

Methods inherited from interface java.util.Set

equals, hashCode, size, spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

mutable

MutableSet<E> mutable()

Returns a mutable version of this immutable set.

put

ImSet<E> put(E e)

Adds an element, returning a modified version of the set (leaving the original set unchanged). If the element already exists in this set, the new value overwrites the old one. If the new element is the same as an old element (based on the address of that item in memory, not an equals test), the old set is returned unchanged.

Specified by:

put in interface BaseSet<E>

Parameters:

e - the element to add to this set

Returns:

a new set with the element added (see note above about adding duplicate elements).

union

default ImSet<E> union(Iterable<? extends E> iter)

Returns a new set containing all the items.

Specified by:

union in interface BaseSet<E>

without

ImSet<E> without(E key)

Removes this key from the set

Specified by:

without in interface BaseSet<E>