Package org.organicdesign.fp.collections

Class PersistentHashSet.MutHashSet<E>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Enclosing class:

PersistentHashSet<E>

public static final class PersistentHashSet.MutHashSet<E>
extends AbstractUnmodSet<E>
implements MutSet<E>

Nested Class Summary

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

UnmodIterable.UnIterable

Method Summary

Modifier and Type	Method	Description
boolean	contains(Object key)	Returns true if the set contains the given item.
@NotNull PersistentHashSet<E>	immutable()	Returns an immutable version of this immutable set.
@NotNull UnmodIterator<E>	iterator()	Iterates over contents with no guarantees about their ordering.
@NotNull PersistentHashSet.MutHashSet<E>	put(E val)	Adds an element.
int	size()	Returns the number of items in this collection or iterable.
@NotNull PersistentHashSet.MutHashSet<E>	without(E key)	Removes this key from the set

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

equals

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

hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

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

union

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

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

any, toImList, toImMap, toImRrbt, toImSet, toImSortedMap, toImSortedSet, toMutList, toMutMap, toMutRrbt, toMutSet, toMutSortedMap, toMutSortedSet

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

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

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

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

Method Detail

size

public int size()

Description copied from interface: Sized

Returns the number of items in this collection or iterable.

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in interface Sized

put

@NotNull
public @NotNull PersistentHashSet.MutHashSet<E> put(E val)

Description copied from interface: MutSet

Adds an element. 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 may be returned unchanged.

Specified by:

put in interface BaseSet<E>

Specified by:

put in interface MutSet<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

@NotNull
public @NotNull 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 Collection<E>

Specified by:

iterator in interface Iterable<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

@NotNull
public @NotNull PersistentHashSet.MutHashSet<E> without(E key)

Description copied from interface: MutSet

Removes this key from the set

Specified by:

without in interface BaseSet<E>

Specified by:

without in interface MutSet<E>

immutable

@Contract(pure=true)
@NotNull
public @NotNull PersistentHashSet<E> immutable()

Description copied from interface: MutSet

Returns an immutable version of this immutable set.

Specified by:

immutable in interface MutSet<E>