org.kocakosm.pitaya.collection

Class ImmutableSet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

org.kocakosm.pitaya.collection.ImmutableSet<E>

Type Parameters:

E - the type of the Set's elements.

All Implemented Interfaces:

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

public final class ImmutableSet<E>
extends AbstractSet<E>
implements Serializable

Immutable Set implementation. Accepts null values.

Author:

Osman KOCAK

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableSet.Builder<E> ImmutableSet builder.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
static <E> Set<E>	copyOf(Collection<? extends E> c) Creates a new ImmutableSet from the given Collection.
static <E> Set<E>	copyOf(E[] values) Creates a new ImmutableSet containing the given elements.
static <E> Set<E>	copyOf(Iterable<? extends E> i) Creates a new ImmutableSet from the given Iterable.
static <E> Set<E>	copyOf(Iterator<? extends E> i) Creates a new ImmutableSet from the given Iterator.
boolean	isEmpty()
Iterator<E>	iterator()
static <E> Set<E>	of(E... values) Creates a new ImmutableSet containing the given elements.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Method Detail

copyOf

public static <E> Set<E> copyOf(Collection<? extends E> c)

Creates a new ImmutableSet from the given Collection.

Type Parameters:

E - the type of the Set's elements.

Parameters:

c - the source Collection.

Returns:

the created ImmutableSet.

Throws:

NullPointerException - if c is null.

copyOf

public static <E> Set<E> copyOf(Iterable<? extends E> i)

Creates a new ImmutableSet from the given Iterable.

Type Parameters:

E - the type of the Set's elements.

Parameters:

i - the source Iterable.

Returns:

the created ImmutableSet.

Throws:

NullPointerException - if i is null.

copyOf

public static <E> Set<E> copyOf(Iterator<? extends E> i)

Creates a new ImmutableSet from the given Iterator.

Type Parameters:

E - the type of the Set's elements.

Parameters:

i - the source Iterator.

Returns:

the created ImmutableSet.

Throws:

NullPointerException - if i is null.

copyOf

public static <E> Set<E> copyOf(E[] values)

Creates a new ImmutableSet containing the given elements.

Type Parameters:

E - the type of the Set's elements.

Parameters:

values - the Set's elements.

Returns:

the created ImmutableSet.

Throws:

NullPointerException - if values is null.

of

public static <E> Set<E> of(E... values)

Creates a new ImmutableSet containing the given elements.

Type Parameters:

E - the type of the Set's elements.

Parameters:

values - the Set's elements.

Returns:

the created ImmutableSet.

Throws:

NullPointerException - if values is null.

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

iterator

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>

Specified by:

iterator in class AbstractCollection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

Overrides:

containsAll in class AbstractCollection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

Overrides:

addAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

Overrides:

retainAll in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

Overrides:

removeAll in class AbstractSet<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>