org.organicdesign.fp

Class FunctionUtils.UnmodifiableSet<T>

java.lang.Object

org.organicdesign.fp.FunctionUtils.UnmodifiableSet<T>

All Implemented Interfaces:

Serializable, Iterable<T>, Collection<T>, Set<T>, Sized, UnmodCollection<T>, UnmodIterable<T>, UnmodSet<T>, Transformable<T>

Enclosing class:

FunctionUtils

public static class FunctionUtils.UnmodifiableSet<T>
extends Object
implements UnmodSet<T>, Serializable

Wraps a set. The result will be serializable to the extent that the wrapped set is. You probably want to use this by calling FunctionUtils.unmodSet(Set).

See Also:

Serialized Form

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 o) Returns true if the set contains the given item.
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty() This is a convenience method inherited from Collection that returns true if size() == 0 (if this set contains no elements).
UnmodIterator<T>	iterator() Iterates over contents with no guarantees about their ordering.
int	size() Returns the number of items in this iterable.
String	toString()

Methods inherited from class java.lang.Object

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

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

add, addAll, clear, containsAll, 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

spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

contains

public boolean contains(Object o)

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

Specified by:

contains in interface Set<T>

Specified by:

contains in interface UnmodSet<T>

size

public int size()

Description copied from interface: Sized

Returns the number of items in this iterable.

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

Specified by:

size in interface Sized

isEmpty

public boolean isEmpty()

Description copied from interface: UnmodSet

This is a convenience method inherited from Collection that returns true if size() == 0 (if this set contains no elements).

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

Specified by:

isEmpty in interface UnmodCollection<T>

Specified by:

isEmpty in interface UnmodSet<T>

iterator

public UnmodIterator<T> 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<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Set<T>

Specified by:

iterator in interface UnmodCollection<T>

Specified by:

iterator in interface UnmodIterable<T>

Specified by:

iterator in interface UnmodSet<T>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object