org.organicdesign.fp.collections

Class PersistentHashSet.MutableHashSet<E>

java.lang.Object

org.organicdesign.fp.collections.UnmodIterable.AbstractUnmodIterable<T>

org.organicdesign.fp.collections.UnmodSet.AbstractUnmodSet<E>

org.organicdesign.fp.collections.PersistentHashSet.MutableHashSet<E>

All Implemented Interfaces:

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

Enclosing class:

PersistentHashSet<E>

public static final class PersistentHashSet.MutableHashSet<E>
extends UnmodSet.AbstractUnmodSet<E>
implements MutableUnsortedSet<E>

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
boolean	contains(Object key) Returns true if the set contains the given item.
PersistentHashSet<E>	immutable() Returns a immutable version of this (maybe mutable) set.
UnmodIterator<E>	iterator() Iterates over contents with no guarantees about their ordering.
PersistentHashSet.MutableHashSet<E>	put(E val) Adds an element, returning a modified version of the set (leaving the original set unchanged).
int	size() Returns the number of items in this iterable.
PersistentHashSet.MutableHashSet<E>	without(E key) Removes the given item, returning a modified version of the set (leaving the original set unchanged).

Methods inherited from class org.organicdesign.fp.collections.UnmodSet.AbstractUnmodSet

equals

Methods inherited from class org.organicdesign.fp.collections.UnmodIterable.AbstractUnmodIterable

hashCode, toString

Methods inherited from class java.lang.Object

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

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

mutable, union

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

add, addAll, clear, containsAll, isEmpty, 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 java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

size

public int size()

Description copied from interface: Sized

Returns the number of items in this iterable.

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in interface Sized

put

public PersistentHashSet.MutableHashSet<E> put(E val)

Description copied from interface: MutableUnsortedSet

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>

Specified by:

put in interface MutableUnsortedSet<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).

iterator

public UnmodIterator<E> iterator()

Description copied from interface: UnmodSet

Iterates over contents with no guarantees about their ordering. An unmodifiable iterator A one-time use, mutable, not-thread-safe way to get each value of the underling collection in turn. I experimented with various thread-safe alternatives, but the JVM is optimized around iterators so this is the lowest common denominator of collection iteration, even though iterators are inherently mutable.

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in interface UnmodCollection<E>

Specified by:

iterator in interface UnmodIterable<E>

Specified by:

iterator in interface UnmodSet<E>

contains

public boolean contains(Object key)

Description copied from interface: UnmodSet

Returns true if the set contains the given item. This is the defining method of a set. Sets have to override this because the default implementation in UnmodCollection is O(n) whereas a sorted set should be O(log n) or O(1).

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Specified by:

contains in interface UnmodSet<E>

without

public PersistentHashSet.MutableHashSet<E> without(E key)

Description copied from interface: MutableUnsortedSet

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>

Specified by:

without in interface MutableUnsortedSet<E>

immutable

public PersistentHashSet<E> immutable()

Description copied from interface: ImUnsortedSet

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.

Specified by:

immutable in interface ImUnsortedSet<E>