org.organicdesign.fp.collections

Interface ImUnsortedSet<E>

All Superinterfaces:

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

All Known Subinterfaces:

MutableUnsortedSet<E>

All Known Implementing Classes:

PersistentHashSet, PersistentHashSet.MutableHashSet

public interface ImUnsortedSet<E>
extends ImSet<E>

The super-interface of PersistentHashSet (excludes TreeSet).

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
ImUnsortedSet<E>	immutable() Returns a immutable version of this (maybe mutable) set.
MutableUnsortedSet<E>	mutable() Returns a mutable (builder) version of this set that is not thread safe.
ImUnsortedSet<E>	put(E val) Adds an element, returning a modified version of the set (leaving the original set unchanged).
default ImUnsortedSet<E>	union(Iterable<? extends E> iter)
ImUnsortedSet<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.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

immutable

ImUnsortedSet<E> immutable()

Returns a immutable version of this (maybe mutable) set. Once you call immutable() on it, you can't mutate the mutable one anymore (or you'll get an exception). This is because they share most of the underlying implementation. Theoretically, this should be on MutableUnsortedSet, but sometimes you want to know that a set is immutable, sometimes you want to know it's mutable. It's hard to pick only one, but that's how inheritance works.

mutable

MutableUnsortedSet<E> mutable()

Returns a mutable (builder) version of this set that is not thread safe.

put

ImUnsortedSet<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>

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 ImUnsortedSet<E> union(Iterable<? extends E> iter)

Specified by:

union in interface ImSet<E>

without

ImUnsortedSet<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>