ISet

Type Parameters:
V - The type of the values.

All Superinterfaces:

ICollection<V>, IIterable<V>, Iterable<V>

public interface ISet<V> extends ICollection<V>, IIterable<V>

An immutable set of elements. Null elements are not permitted. The iteration order may be unspecified.

Fields
Modifier and Type Field and Description

ORDERED

static Option ORDERED

static final Option ORDERED

Fields
	Modifier and Type	Field and Description
	ORDERED	`static Option` ORDERED static final Option ORDERED

Static Methods
	Modifier and Type	Static Method and Description
	builder	`static <V> SetBuilder<V>` builder() Create a builder for a set. static <V> SetBuilder<V> builder() Create a builder for a set. The iteration order of the set is unspecified. Type Parameters: `V` - The type of set elements. Returns: the builder.
	builder	`static <V> SetBuilder<V>` builder(Option option) Create a builder for a set whose iteration order is defined by the order in which elements are added to the builder. static <V> SetBuilder<V> builder(Option option) Create a builder for a set whose iteration order is defined by the order in which elements are added to the builder. Type Parameters: `V` - The type of set elements. Parameters: `option` - Returns: the builder.
	cast	`static <V> ICollection<V>` cast(ICollection<?> o) Cast a collection to a specific type. static <V> ICollection<V> cast(ICollection<?> o) Description copied from interface: `ICollection` Cast a collection to a specific type. This method is no more reliable than an explicit type cast, but it prevents the warning.
	cast	`static <V> ISet<V>` cast(ISet<?> o) Cast a set to a specific type. static <V> ISet<V> cast(ISet<?> o) Cast a set to a specific type. This method is no more reliable than an explicit type cast, but it prevents the warning.
	concatenate	`static <V> ICollection<V>` concatenate(ICollection<? extends V>... sources) @SafeVarargs static <V> ICollection<V> concatenate(ICollection<? extends V>... sources)
	concatenate	`static <V> ICollection<V>` concatenate(IList<? extends ICollection<V>> sources) static <V> ICollection<V> concatenate(IList<? extends ICollection<V>> sources)
	concatenateIterators	`static <V> IIterator<V>` concatenateIterators(IList<? extends IIterator<V>> sources) static <V> IIterator<V> concatenateIterators(IList<? extends IIterator<V>> sources)
	create	`static <V> ISet<V>` create(Iterable<? extends V> elements) Create a set containing the specified elements. static <V> ISet<V> create(Iterable<? extends V> elements) throws IllegalArgumentException Create a set containing the specified elements. Parameters: `elements` - An iterator that provides the elements. Returns: the set. Throws: `IllegalArgumentException` - if the iterator returns a null value.
	create	`static <V> ISet<V>` create(V[] elements) Create a set containing the specified elements. static <V> ISet<V> create(V[] elements) throws IllegalArgumentException Create a set containing the specified elements. Parameters: `elements` - An array that provides the elements. Returns: the set. Throws: `IllegalArgumentException` - if the array contains a null value.
	empty	`static <V> ISet<V>` empty() Return an empty set. static <V> ISet<V> empty() Return an empty set.
	emptyIterator	`static <V> IIterator<V>` emptyIterator() static <V> IIterator<V> emptyIterator()
	from	`static <T> IIterable<T>` from(Iterable<T> it) Create an `IIterable` from an `Iterable`. static <T> IIterable<T> from(Iterable<T> it) Description copied from interface: `IIterable` Create an `IIterable` from an `Iterable`. The iterators produced by the returned `IIterable` will throw a runtime exception if an iterator produced by the `Iterable` returns a null value. Parameters: `it` - The source iterable.
	intersection	`static <V> ISet<V>` intersection(ISet<V> s, ISet<?> p) static <V> ISet<V> intersection(ISet<V> s, ISet<?> p)
	of	`static <V> ISet<V>` of(V... es) @SafeVarargs static <V> ISet<V> of(V... es)
	of	`static <V> ISet<V>` of(V e) static <V> ISet<V> of(V e)

Methods
	Modifier and Type	Method and Description
	choose	`V` choose() Return one element of this set. V choose() throws NoSuchElementException Return one element of this set. Throws: `NoSuchElementException` - if the set is empty.
	chooseOptional	`V` chooseOptional() Return one element of this set, or null if the set is empty. V chooseOptional() Return one element of this set, or null if the set is empty.
	contains	`boolean` contains(Object target) Return true if and only if the specified element is an element of the collection. boolean contains(Object target) Description copied from interface: `ICollection` Return true if and only if the specified element is an element of the collection. Specified by: `contains` in interface `ICollection<V>` Parameters: `target` - The element to find in the list. Returns: true if and only if `target` is an element of the collection.
	element	`V` element() Return the sole element of this set. V element() throws NoSuchElementException Return the sole element of this set. Throws: `NoSuchElementException` - if the set does not contain exactly one element.
	extending	`abstract ISet<V>` extending(V value) Return a set containing the members of this set and the specified value. ISet<V> extending(V value) Return a set containing the members of this set and the specified value. Parameters: `value` - The value to be included in the result. Returns: A set containing the values from this set and the specified value.
	extendingAll	`abstract ISet<V>` extendingAll(ICollection<? extends V> values) Return a set containing the members of this set and the specified values. ISet<V> extendingAll(ICollection<? extends V> values) Return a set containing the members of this set and the specified values. Parameters: `values` - The values to be included in the result. Returns: A set containing the values from this set and the specified values.
	filter	`ISet<V>` filter(Predicate<V> predicate) ISet<V> filter(Predicate<V> predicate)
	find	`<R> R` find(FindVisitor<V,R> visitor) Visit the elements of the collection until the visitor returns a non-null result. <R> R find(FindVisitor<V,R> visitor) Description copied from interface: `ICollection` Visit the elements of the collection until the visitor returns a non-null result. The elements are visited in the order defined by the collection (if there is one); otherwise, the visitation order is unspecified. Parameters: `visitor` - The visitor to call on the elements. Returns: the first non-null result returned by the visitor, or null if none.
	find	`<R> R` find(FindVisitor<V,R> visitor, R defaultValue) Visit each element of the collection until the visitor returns a non-null result. <R> R find(FindVisitor<V,R> visitor, R defaultValue) Description copied from interface: `ICollection` Visit each element of the collection until the visitor returns a non-null result. The elements are visited in the order defined by the collection (if there is one); otherwise, the visitation order is unspecified. Parameters: `visitor` - The visitor to call on the elements. `defaultValue` - The value to return if no visitor call returns a non-null result. Returns: the first non-null result returned by the visitor, or `defaultValue` if none.
	forEach	`void` forEach(Consumer<? super T> arg0) void forEach(Consumer<? super T> arg0)
	intersecting	`ISet<V>` intersecting(ISet<?> other) ISet<V> intersecting(ISet<?> other)
	isEmpty	`boolean` isEmpty() Return true if and only if there are no elements in the collection. boolean isEmpty() Description copied from interface: `ICollection` Return true if and only if there are no elements in the collection. Specified by: `isEmpty` in interface `ICollection<V>`
	iterator	`abstract IIterator<T>` iterator() Returns an iterator over non-null elements of type `T`. IIterator<T> iterator() Description copied from interface: `IIterable` Returns an iterator over non-null elements of type `T`. Specified by: `iterator` in interface `Iterable<T>` Returns: an Iterator.
	map	`abstract <R> ISet<R>` map(Function<V,R> mapper) <R> ISet<R> map(Function<V,R> mapper)
	ordered	`ISet<V>` ordered() Return a set containing the members of this collection whose iteration order is defined by the natural sort order. ISet<V> ordered() Return a set containing the members of this collection whose iteration order is defined by the natural sort order.
	ordered	`ISet<V>` ordered(Comparator<? super V> comp) Return a set containing the members of this collection whose iteration order is defined by the specified comparator. ISet<V> ordered(Comparator<? super V> comp) Return a set containing the members of this collection whose iteration order is defined by the specified comparator.
	removing	`abstract ISet<V>` removing(Object value) Return a set containing the members of this set excluding the specified value. ISet<V> removing(Object value) Return a set containing the members of this set excluding the specified value. Parameters: `value` - The value to be excluded from the result. Returns: A set containing the values from this set, but not the specified value.
	removingAll	`ISet<V>` removingAll(ISet<?> values) ISet<V> removingAll(ISet<?> values)
	size	`abstract int` size() Return the number of elements in the collection. int size() Description copied from interface: `ICollection` Return the number of elements in the collection. Specified by: `size` in interface `ICollection<V>`
	sort	`IList<V>` sort() Return a list containing the members of this collection, sorted in the natural sort order. IList<V> sort() Description copied from interface: `ICollection` Return a list containing the members of this collection, sorted in the natural sort order. Returns: the list.
	sort	`IList<V>` sort(Comparator<? super V> c) Return a list containing the same elements as this collection, but sorted using the specified comparator. IList<V> sort(Comparator<? super V> c) Description copied from interface: `ICollection` Return a list containing the same elements as this collection, but sorted using the specified comparator. Parameters: `c` - The comparator used to determine the order of the elements in the returned list. Returns: the sorted list.
	spliterator	`Spliterator<V>` spliterator() Return a Spliterator that yields the elements of the collection. Spliterator<V> spliterator() Description copied from interface: `ICollection` Return a Spliterator that yields the elements of the collection. Specified by: `spliterator` in interface `Iterable<V>`
	stream	`Stream<V>` stream() Return a stream of the elements of the collection. Stream<V> stream() Description copied from interface: `ICollection` Return a stream of the elements of the collection.
	toJavaArray	`<E> E[]` toJavaArray(E[] template) Return a new Java array containing the elements of this collection. <E> E[] toJavaArray(E[] template) Description copied from interface: `ICollection` Return a new Java array containing the elements of this collection.
	toJavaList	`List<V>` toJavaList() Return a new Java list containing the elements of this collection, in the same order (if the collection defines an order). List<V> toJavaList() Description copied from interface: `ICollection` Return a new Java list containing the elements of this collection, in the same order (if the collection defines an order).
	toJavaSet	`Set<V>` toJavaSet() Return a new Java set containing the elements of this collection. Set<V> toJavaSet() Description copied from interface: `ICollection` Return a new Java set containing the elements of this collection.
	toJavaUnmodifiableList	`List<V>` toJavaUnmodifiableList() Return a new unmodifiable Java list containing the elements of this collection, in the same order (if the collection defines an order). List<V> toJavaUnmodifiableList() Description copied from interface: `ICollection` Return a new unmodifiable Java list containing the elements of this collection, in the same order (if the collection defines an order).
	toJavaUnmodifiableSet	`Set<V>` toJavaUnmodifiableSet() Return a new Java set containing the elements of this collection. Set<V> toJavaUnmodifiableSet() Description copied from interface: `ICollection` Return a new Java set containing the elements of this collection.
	visit	`void` visit(Visitor<V> visitor) Visit each element of the collection. void visit(Visitor<V> visitor) Description copied from interface: `ICollection` Visit each element of the collection. The elements are visited in the order defined by the collection (if there is one); otherwise, the visitation order is unspecified. Parameters: `visitor` - The visitor to call on the elements.

Interface ISet<V>