info.bioinfweb.commons.collections

Class NonStoringCollection<E>

java.lang.Object

info.bioinfweb.commons.collections.NonStoringCollection<E>

Type Parameters:

E - any Object type

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>

public class NonStoringCollection<E>
extends java.lang.Object
implements java.util.Collection<E>

Instances of this class do not store objects add to them. This can be useful if objects are add to a collection in a standardized way but in some cases are not intended to be used later. To avoid using memory this non-storing collection can be used.

Author:

Sarah Wiechers

Constructor Summary

Constructors

Constructor and Description
NonStoringCollection()

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object e) Always returns false.
boolean	addAll(java.util.Collection<? extends E> c) Always returns false.
void	clear()
boolean	contains(java.lang.Object o) Since no objects are stored in this collection this method will always return false.
boolean	containsAll(java.util.Collection<?> c) Since no objects are stored in this collection this method will always return false.
boolean	isEmpty() Since no objects are stored in this collection this method will always return true.
java.util.Iterator<E>	iterator() Since no objects are stored in this collection this method will always return an empty iterator.
boolean	remove(java.lang.Object o) Since no objects are stored in this collection, no objects can be removed.
boolean	removeAll(java.util.Collection<?> c) Since no objects are stored in this collection, no objects can be removed.
boolean	retainAll(java.util.Collection<?> c) Since no objects are stored in this collection, no objects can be removed.
int	size() Since no objects are stored in this collection its size will always be 0.
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

NonStoringCollection

public NonStoringCollection()

Method Detail

add

public boolean add(java.lang.Object e)

Always returns false. The object will not be stored.

Specified by:

add in interface java.util.Collection<E>

Returns:

false

addAll

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

Always returns false. The object in the collection will not be stored.

Specified by:

addAll in interface java.util.Collection<E>

Returns:

false

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

contains

public boolean contains(java.lang.Object o)

Since no objects are stored in this collection this method will always return false.

Specified by:

contains in interface java.util.Collection<E>

Returns:

always false

containsAll

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

Since no objects are stored in this collection this method will always return false.

Specified by:

containsAll in interface java.util.Collection<E>

Returns:

always false

isEmpty

public boolean isEmpty()

Since no objects are stored in this collection this method will always return true.

Specified by:

isEmpty in interface java.util.Collection<E>

Returns:

always true

iterator

public java.util.Iterator<E> iterator()

Since no objects are stored in this collection this method will always return an empty iterator.

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Returns:

an empty iterator

remove

public boolean remove(java.lang.Object o)

Since no objects are stored in this collection, no objects can be removed. Therefore this method will always return false.

Specified by:

remove in interface java.util.Collection<E>

Returns:

always false

removeAll

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

Since no objects are stored in this collection, no objects can be removed. Therefore this method will always return false.

Specified by:

removeAll in interface java.util.Collection<E>

Returns:

always false

retainAll

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

Since no objects are stored in this collection, no objects can be removed. Therefore this method will always return false.

Specified by:

retainAll in interface java.util.Collection<E>

Returns:

always false

size

public int size()

Since no objects are stored in this collection its size will always be 0.

Specified by:

size in interface java.util.Collection<E>

Returns:

0

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)

Specified by:

toArray in interface java.util.Collection<E>