Interface EconomicSet<E>

All Superinterfaces:

Iterable<E>, UnmodifiableEconomicSet<E>

public interface EconomicSet<E>
extends UnmodifiableEconomicSet<E>

Memory efficient set data structure. It does not support adding, looking up or removing a null element.

Since:

19.0

Method Summary

Modifier and Type	Method	Description
boolean	add(E element)	Adds non-null element to this set if it is not already present.
default void	addAll(Iterable<? extends E> values)	Adds all the elements in values to this set if they're not already present.
default void	addAll(Iterator<? extends E> iterator)	Adds all the elements enumerated by iterator to this set if they're not already present.
default void	addAll(EconomicSet<? extends E> other)	Adds all the elements in other to this set if they're not already present.
void	clear()	Removes all the elements from this set.
static <E> EconomicSet<E>	create()	Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy.
static <E> EconomicSet<E>	create(int initialCapacity)	Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy.
static <E> EconomicSet<E>	create(Iterable<E> c)	Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy and inserts all elements of the specified iterable.
static <E> EconomicSet<E>	create(Equivalence strategy)	Creates a new set guaranteeing insertion order when iterating over its elements.
static <E> EconomicSet<E>	create(Equivalence strategy, int initialCapacity)	Creates a new set guaranteeing insertion order when iterating over its elements and initializes with the given capacity.
static <E> EconomicSet<E>	create(Equivalence strategy, UnmodifiableEconomicSet<E> c)	Creates a new set guaranteeing insertion order when iterating over its elements and inserts all elements of the specified collection.
static <E> EconomicSet<E>	create(UnmodifiableEconomicSet<E> c)	Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy and inserts all elements of the specified collection.
static <E> EconomicSet<E>	emptySet()	Return an empty, unmodifiable EconomicSet.
static <E> EconomicSet<E>	of(E elem)
void	remove(E element)	Removes non-null element from this set if it is present.
default void	removeAll(Iterable<E> values)	Removes from this set all of its elements that are contained in values.
default void	removeAll(Iterator<E> iterator)	Removes from this set all of its elements that are enumerated by iterator.
default void	removeAll(EconomicSet<E> other)	Removes from this set all of its elements that are contained in other.
default void	retainAll(EconomicSet<E> other)	Removes from this set all of its elements that are not contained in other.

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface UnmodifiableEconomicSet

contains, containsAll, isEmpty, removeIf, size, toArray, toHashSet, toList

Method Details

add

boolean add(E element)

Adds non-null element to this set if it is not already present.

Returns:

true if this set did not already contain element

Throws:

UnsupportedOperationException - if element == null

Since:

19.0

remove

void remove(E element)

Removes non-null element from this set if it is present. This set will not contain element once the call returns.

Throws:

UnsupportedOperationException - if element == null

Since:

19.0

clear

void clear()

Removes all the elements from this set. The set will be empty after this call returns.

Since:

19.0

addAll

default void addAll(EconomicSet<? extends E> other)

Adds all the elements in other to this set if they're not already present.

Since:

19.0

addAll

default void addAll(Iterable<? extends E> values)

Adds all the elements in values to this set if they're not already present.

Since:

19.0

addAll

default void addAll(Iterator<? extends E> iterator)

Adds all the elements enumerated by iterator to this set if they're not already present.

Since:

19.0

removeAll

default void removeAll(EconomicSet<E> other)

Removes from this set all of its elements that are contained in other.

Since:

19.0

removeAll

default void removeAll(Iterable<E> values)

Removes from this set all of its elements that are contained in values.

Since:

19.0

removeAll

default void removeAll(Iterator<E> iterator)

Removes from this set all of its elements that are enumerated by iterator.

Since:

19.0

retainAll

default void retainAll(EconomicSet<E> other)

Removes from this set all of its elements that are not contained in other.

Since:

19.0

create

static <E> EconomicSet<E> create()

Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy.

Since:

19.0

create

static <E> EconomicSet<E> create(Equivalence strategy)

Creates a new set guaranteeing insertion order when iterating over its elements.

Since:

19.0

create

static <E> EconomicSet<E> create(int initialCapacity)

Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy.

Since:

19.0

create

static <E> EconomicSet<E> create(UnmodifiableEconomicSet<E> c)

Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy and inserts all elements of the specified collection.

Since:

19.0

create

static <E> EconomicSet<E> create(Equivalence strategy,
 int initialCapacity)

Creates a new set guaranteeing insertion order when iterating over its elements and initializes with the given capacity.

Since:

19.0

create

static <E> EconomicSet<E> create(Equivalence strategy,
 UnmodifiableEconomicSet<E> c)

Creates a new set guaranteeing insertion order when iterating over its elements and inserts all elements of the specified collection.

Since:

19.0

create

static <E> EconomicSet<E> create(Iterable<E> c)

Creates a new set guaranteeing insertion order when iterating over its elements with the default Equivalence.DEFAULT comparison strategy and inserts all elements of the specified iterable.

Since:

25.1

emptySet

static <E> EconomicSet<E> emptySet()

Return an empty, unmodifiable EconomicSet.

Since:

25.0

of

static <E> EconomicSet<E> of(E elem)