All Superinterfaces:

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

All Known Subinterfaces:

BaseSet<E>, ImSet<E>, ImSortedSet<E>, MutSet<E>, UnmodSortedSet<E>

All Known Implementing Classes:

AbstractUnmodSet, PersistentHashSet, PersistentHashSet.MutHashSet, PersistentTreeSet
```
public interface UnmodSet<E>
extends UnmodCollection<E>, Set<E>
```
An unmodifiable set

Nested Class Summary
- Nested classes/interfaces inherited from interface org.organicdesign.fp.collections.UnmodIterable
  UnmodIterable.UnIterable

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default boolean`	`add(E e)`	Deprecated.
`default boolean`	`addAll(@NotNull Collection<? extends E> c)`	Deprecated.
`default void`	`clear()`	Deprecated.
`boolean`	`contains(Object o)`	Returns true if the set contains the given item.
`default boolean`	`containsAll(@NotNull Collection<?> items)`	The default implementation of this method has O(this.size() + that.size()) or O(n) performance.
`default boolean`	`isEmpty()`	This is a convenience method inherited from Collection that returns true if size() == 0 (if this set contains no elements).
`@NotNull UnmodIterator<E>`	`iterator()`	Iterates over contents with no guarantees about their ordering.
`default boolean`	`remove(Object o)`	Deprecated.
`default boolean`	`removeAll(@NotNull Collection<?> c)`	Deprecated.
`default boolean`	`removeIf(Predicate<? super E> filter)`	Deprecated.
`default boolean`	`retainAll(@NotNull Collection<?> c)`	Deprecated.
`default Object @NotNull []`	`toArray()`	This method goes against Josh Bloch's Item 25: "Prefer Lists to Arrays", but is provided for backwards compatibility in some performance-critical situations.
`default <T> @NotNull T @NotNull []`	`toArray(T @NotNull [] as)`	This method goes against Josh Bloch's Item 25: "Prefer Lists to Arrays", but is provided for backwards compatibility in some performance-critical situations.

Methods inherited from interface java.util.Collection
parallelStream, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.Set
equals, hashCode, size, spliterator

Methods inherited from interface org.organicdesign.fp.collections.Sized
size

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

- Method Detail
  - add
```
@Deprecated
default boolean add(E e)
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface Set<E>
    
    Specified by:
    
    add in interface UnmodCollection<E>
  - addAll
```
@Deprecated
default boolean addAll(@NotNull
                       @NotNull Collection<? extends E> c)
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface Set<E>
    
    Specified by:
    
    addAll in interface UnmodCollection<E>
  - clear
```
@Deprecated
default void clear()
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface Set<E>
    
    Specified by:
    
    clear in interface UnmodCollection<E>
  - contains
```
boolean contains(Object o)
```
    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>
  - containsAll
```
default boolean containsAll(@NotNull
                            @NotNull Collection<?> items)
```
    The default implementation of this method has O(this.size() + that.size()) or O(n) performance. So even though contains() is impossible to implement efficiently for Lists, containsAll() has a decent implementation (brute force would be O(this.size() * that.size()) or O(n^2) ).
    
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface Set<E>
    
    Specified by:
    
    containsAll in interface UnmodCollection<E>
  - isEmpty
```
default boolean isEmpty()
```
    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<E>
    
    Specified by:
    
    isEmpty in interface Set<E>
    
    Specified by:
    
    isEmpty in interface UnmodCollection<E>
  - iterator
```
@NotNull
@NotNull UnmodIterator<E> iterator()
```
    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>
  - remove
```
@Deprecated
default boolean remove(Object o)
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface Set<E>
    
    Specified by:
    
    remove in interface UnmodCollection<E>
  - removeAll
```
@Deprecated
default boolean removeAll(@NotNull
                          @NotNull Collection<?> c)
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface Set<E>
    
    Specified by:
    
    removeAll in interface UnmodCollection<E>
  - retainAll
```
@Deprecated
default boolean retainAll(@NotNull
                          @NotNull Collection<?> c)
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface Set<E>
    
    Specified by:
    
    retainAll in interface UnmodCollection<E>
  - toArray
```
default Object @NotNull [] toArray()
```
    This method goes against Josh Bloch's Item 25: "Prefer Lists to Arrays", but is provided for backwards compatibility in some performance-critical situations. If you really need an array, consider using the somewhat type-safe version of this method instead, but read the caveats first. This method goes against Josh Bloch's Item 25: "Prefer Lists to Arrays", but is provided for backwards compatibility in some performance-critical situations. If you really need an array, consider using the somewhat type-safe version of this method instead, but read the caveats first.
    
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
    
    Specified by:
    
    toArray in interface UnmodCollection<E>
  - toArray
```
@NotNull
default <T> @NotNull T @NotNull [] toArray(T @NotNull [] as)
```
    This method goes against Josh Bloch's Item 25: "Prefer Lists to Arrays", but is provided for backwards compatibility in some performance-critical situations. If you need to create an array (you almost always do) then the best way to use this method is: MyThing[] things = col.toArray(new MyThing[coll.size()]); Calling this method any other way causes unnecessary work to be done - an extra memory allocation and potential garbage collection if the passed array is too small, extra effort to fill the end of the array with nulls if it is too large. This method goes against Josh Bloch's Item 25: "Prefer Lists to Arrays", but is provided for backwards compatibility in some performance-critical situations. If you need to create an array (you almost always do) then the best way to use this method is: MyThing[] things = col.toArray(new MyThing[coll.size()]); Calling this method any other way causes unnecessary work to be done - an extra memory allocation and potential garbage collection if the passed array is too small, extra effort to fill the end of the array with nulls if it is too large.
    
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
    
    Specified by:
    
    toArray in interface UnmodCollection<E>
  - removeIf
```
@Deprecated
default boolean removeIf(Predicate<? super E> filter)
```
    Deprecated.
    
    Not allowed - this is supposed to be unmodifiable
    
    Specified by:
    
    removeIf in interface Collection<E>
    
    Specified by:
    
    removeIf in interface UnmodCollection<E>

Interface UnmodSet<E>

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Set

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

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

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

Method Detail

add

addAll

clear

contains

containsAll

isEmpty

iterator

remove

removeAll

retainAll

toArray

toArray

removeIf