org.organicdesign.fp.collections

Interface MutableUnsortedSet<E>

All Superinterfaces:

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

All Known Implementing Classes:

PersistentHashSet.MutableHashSet

public interface MutableUnsortedSet<E>
extends ImUnsortedSet<E>

Declare your set as MutableUnsortedSet, call mutable(), build it, then call mySet = mySet.immutable() without having to declare a new variable.

Nested Class Summary

Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodSet

UnmodSet.AbstractUnmodSet<T>

Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodIterable

UnmodIterable.AbstractUnmodIterable<T>

Method Summary

Modifier and Type	Method and Description
default MutableUnsortedSet<E>	mutable() Returns a mutable version of this immutable set.
MutableUnsortedSet<E>	put(E val) Adds an element, returning a modified version of the set (leaving the original set unchanged).
default MutableUnsortedSet<E>	union(Iterable<? extends E> iter)
MutableUnsortedSet<E>	without(E key) Removes the given item, returning a modified version of the set (leaving the original set unchanged).

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

immutable

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, filter, flatMap, foldLeft, foldLeft, hash, hashCode, head, map, precat, take, takeWhile, toString

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

toImList, toImMap, toImSet, toImSortedMap, toImSortedSet, toMutableList, toMutableMap, 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

default MutableUnsortedSet<E> mutable()

Returns a mutable version of this immutable set.

Specified by:

mutable in interface ImUnsortedSet<E>

put

MutableUnsortedSet<E> put(E val)

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 ImSet<E>

Specified by:

put in interface ImUnsortedSet<E>

Parameters:

val - the element to add to this set

Returns:

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

union

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

Specified by:

union in interface ImSet<E>

Specified by:

union in interface ImUnsortedSet<E>

without

MutableUnsortedSet<E> without(E key)

Removes the given item, returning a modified version of the set (leaving the original set unchanged).

Specified by:

without in interface ImSet<E>

Specified by:

without in interface ImUnsortedSet<E>