org.kocakosm.pitaya.collection

Class ImmutableBag<E>

java.lang.Object

java.util.AbstractCollection<E>

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

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

Type Parameters:

E - the type of the Bag's elements.

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Bag<E>

public final class ImmutableBag<E>
extends AbstractBag<E>
implements Serializable

Immutable Bag implementation. Accepts null values.

Author:

Osman KOCAK

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableBag.Builder<E> ImmutableBag 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> Bag<E>	copyOf(Collection<? extends E> c) Creates a new ImmutableBag from the given Collection.
static <E> Bag<E>	copyOf(E[] values) Creates a new ImmutableBag containing the given elements.
static <E> Bag<E>	copyOf(Iterable<? extends E> i) Creates a new ImmutableBag from the given Iterable.
static <E> Bag<E>	copyOf(Iterator<? extends E> i) Creates a new ImmutableBag from the given Iterator.
int	count(E e) Returns the count of the given element in this bag.
boolean	isEmpty()
Iterator<E>	iterator()
static <E> Bag<E>	of(E... values) Creates a new ImmutableBag 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 org.kocakosm.pitaya.collection.AbstractBag

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> Bag<E> copyOf(Collection<? extends E> c)

Creates a new ImmutableBag from the given Collection.

Type Parameters:

E - the type of the Bag's elements.

Parameters:

c - the source Collection.

Returns:

the created ImmutableBag.

Throws:

NullPointerException - if c is null.

copyOf

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

Creates a new ImmutableBag from the given Iterable.

Type Parameters:

E - the type of the Bag's elements.

Parameters:

i - the source Iterable.

Returns:

the created ImmutableBag.

Throws:

NullPointerException - if i is null.

copyOf

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

Creates a new ImmutableBag from the given Iterator.

Type Parameters:

E - the type of the Bag's elements.

Parameters:

i - the source Iterator.

Returns:

the created ImmutableBag.

Throws:

NullPointerException - if i is null.

copyOf

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

Creates a new ImmutableBag containing the given elements.

Type Parameters:

E - the type of the Bag's elements.

Parameters:

values - the Bag's elements.

Returns:

the created ImmutableBag.

Throws:

NullPointerException - if values is null.

of

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

Creates a new ImmutableBag containing the given elements.

Type Parameters:

E - the type of the Bag's elements.

Parameters:

values - the Bag's elements.

Returns:

the created ImmutableBag.

Throws:

NullPointerException - if values is null.

count

public int count(E e)

Description copied from interface: Bag

Returns the count of the given element in this bag.

Specified by:

count in interface Bag<E>

Overrides:

count in class AbstractBag<E>

Parameters:

e - the object to count.

Returns:

the number of occurrences of e in this bag.

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<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 class AbstractCollection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Overrides:

toArray in class AbstractCollection<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Overrides:

containsAll in class AbstractCollection<E>

addAll

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

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollection<E>