com.alee.utils.collection

Class ImmutableSet<E>

java.lang.Object

com.alee.utils.collection.ImmutableSet<E>

Type Parameters:

E - data type

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, Set<E>

public class ImmutableSet<E>
extends Object
implements Set<E>, Cloneable, Serializable

Set implementation that doesn't allow any data modifications to be done. Unlike Collections.unmodifiableSet(Set) this implementation keeps set data copy. If you need to provide an unmodifiable reference for your set use Collections implementation.

Author:

Mikle Garin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HashSet<E>	data Set data.

Constructor Summary

Constructors

Constructor and Description
ImmutableSet(Collection<? extends E> data) Constructs new ImmutableSet based on the specified Set.
ImmutableSet(E... data) Constructs new ImmutableSet based on the specified list data.

Method Summary

Modifier and Type	Method and Description
boolean	add(E element)
boolean	addAll(Collection<? extends E> collection)
void	clear()
boolean	contains(Object element)
boolean	containsAll(Collection<?> collection)
protected UnsupportedOperationException	createModificationException() Returns new UnsupportedOperationException instance specific for this implementation.
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(Object element)
boolean	removeAll(Collection<?> collection)
boolean	retainAll(Collection<?> collection)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] array)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

data

@NotNull
protected final HashSet<E> data

Set data.

Constructor Detail

ImmutableSet

public ImmutableSet(@NotNull
                    E... data)

Constructs new ImmutableSet based on the specified list data.

Parameters:

data - Set data

ImmutableSet

public ImmutableSet(@NotNull
                    Collection<? extends E> data)

Constructs new ImmutableSet based on the specified Set.

Parameters:

data - Set data

Method Detail

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

contains

public boolean contains(@Nullable
                        Object element)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

toArray

@NotNull
public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toArray

@NotNull
public <T> T[] toArray(@NotNull
                                T[] array)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

iterator

@NotNull
public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Set<E>

add

public boolean add(@Nullable
                   E element)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

remove

public boolean remove(@Nullable
                      Object element)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

containsAll

public boolean containsAll(@NotNull
                           Collection<?> collection)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

addAll

public boolean addAll(@NotNull
                      Collection<? extends E> collection)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

removeAll

public boolean removeAll(@NotNull
                         Collection<?> collection)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

retainAll

public boolean retainAll(@NotNull
                         Collection<?> collection)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

createModificationException

@NotNull
protected UnsupportedOperationException createModificationException()

Returns new UnsupportedOperationException instance specific for this implementation.

Returns:

new UnsupportedOperationException instance specific for this implementation

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface Set<E>

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class Object

toString

@NotNull
public String toString()

Overrides:

toString in class Object