com.github.andrewoma.dexx.collection
Interface Set<E>

All Superinterfaces:

Iterable<E>, Traversable<E>

All Known Subinterfaces:

SortedSet<E>

All Known Implementing Classes:

AbstractSet, AbstractSortedSet, HashSet, TreeSet

public interface Set<E>
extends Iterable<E>

Set defines the interface for a unique set of values as defined by Object.equals(Object).

Method Summary

Set<E>	add(E value) Returns a set that adds the specified value if it doesn't already exist in this set.
Set<E>	asSet() Returns an immutable view of this set as an instance of java.util.Set.
boolean	contains(E value) Returns true if the value exists in this set.
Set<E>	remove(E value) Removes the specified value from the set if it exists.

Methods inherited from interface com.github.andrewoma.dexx.collection.Iterable

iterator

Methods inherited from interface com.github.andrewoma.dexx.collection.Traversable

forEach, isEmpty, makeString, makeString, size, to, toArray, toArray, toIndexedList, toSet, toSortedSet

Method Detail

add

@NotNull
Set<E> add(E value)

Returns a set that adds the specified value if it doesn't already exist in this set.

remove

@NotNull
Set<E> remove(E value)

Removes the specified value from the set if it exists.

contains

boolean contains(E value)

Returns true if the value exists in this set.

asSet

@NotNull
Set<E> asSet()

Returns an immutable view of this set as an instance of java.util.Set.