org.jboss.weld.util.collections

Class ImmutableSet<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<T>

org.jboss.weld.util.collections.ImmutableSet<T>

Type Parameters:

T - the type of elements

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

Direct Known Subclasses:

ImmutableHashSet

public abstract class ImmutableSet<T>
extends java.util.AbstractSet<T>

Weld's immutable set implementation. Instances returned from methods of this class may use different strategies to achieve good performance / memory consumption balance.

These strategies include:

• A single shared Set implementation instance representing an empty list
• An optimized implementation for holding one, two or three references.
• An immutable Set implementation based on hashing

Author:

Jozef Hartinger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImmutableSet.Builder<T> Builder for building immutable sets.

Method Summary

Modifier and Type	Method and Description
boolean	add(T e)
boolean	addAll(java.util.Collection<? extends T> c)
static <T> ImmutableSet.Builder<T>	builder() Creates a new empty builder for building immutable sets.
void	clear()
static <T> org.jboss.weld.util.collections.ImmutableSet.ImmutableSetCollector<T>	collector() Returns a collector that can be used to collect items of a stream into an immutable set.
boolean	containsAll(java.util.Collection<?> c)
static <T> java.util.Set<T>	copyOf(java.util.Collection<? extends T> collection) Creates a new immutable set that consists of the elements in the given collection.
boolean	equals(java.lang.Object obj)
boolean	isEmpty()
static <T> java.util.Set<T>	of(T... elements) Creates a new immutable set that consists of given elements.
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
java.util.Spliterator<T>	spliterator()

Methods inherited from class java.util.AbstractSet

hashCode

Methods inherited from class java.util.AbstractCollection

contains, iterator, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

contains, hashCode, iterator, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

copyOf

public static <T> java.util.Set<T> copyOf(java.util.Collection<? extends T> collection)

Creates a new immutable set that consists of the elements in the given collection. If the given collection is already an instance created by ImmutableSet, the instance is re-used.

Parameters:

collection - the given collection

Returns:

a new immutable set that consists of the elements in the given collection

of

@SafeVarargs
public static <T> java.util.Set<T> of(T... elements)

Creates a new immutable set that consists of given elements.

Parameters:

elements - the given elements

Returns:

a new immutable set that consists of given elements

collector

public static <T> org.jboss.weld.util.collections.ImmutableSet.ImmutableSetCollector<T> collector()

Returns a collector that can be used to collect items of a stream into an immutable set.

Returns:

collector

builder

public static <T> ImmutableSet.Builder<T> builder()

Creates a new empty builder for building immutable sets.

Returns:

a new empty builder

add

public boolean add(T e)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

Overrides:

add in class java.util.AbstractCollection<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.Set<T>

Overrides:

remove in class java.util.AbstractCollection<T>

addAll

public boolean addAll(java.util.Collection<? extends T> c)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.Set<T>

Overrides:

addAll in class java.util.AbstractCollection<T>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.Set<T>

Overrides:

retainAll in class java.util.AbstractCollection<T>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.Set<T>

Overrides:

removeAll in class java.util.AbstractSet<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.Set<T>

Overrides:

clear in class java.util.AbstractCollection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.Set<T>

Overrides:

isEmpty in class java.util.AbstractCollection<T>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.Set<T>

Overrides:

containsAll in class java.util.AbstractCollection<T>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.Set<T>

Overrides:

equals in class java.util.AbstractSet<T>

spliterator

public java.util.Spliterator<T> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<T>

Specified by:

spliterator in interface java.util.Collection<T>

Specified by:

spliterator in interface java.util.Set<T>