de.larssh.utils.collection

Class ProxiedCollection<E>

java.lang.Object

de.larssh.utils.collection.ProxiedCollection<E>

Type Parameters:

E - the type of elements in this collection

All Implemented Interfaces:

Iterable<E>, Collection<E>

Direct Known Subclasses:

ProxiedList, ProxiedSet

public abstract class ProxiedCollection<E>
extends Object
implements Collection<E>

An abstract Collection implementation pointing to a given collection object.

Therefore it allows implementing collections based on invisible collection types, such as Collections.unmodifiableCollection(Collection) or Collections.synchronizedCollection(Collection).

Constructor Summary

Constructors

Constructor and Description
ProxiedCollection(Collection<E> collection) Creates a new ProxiedCollection instance.

Method Summary

Modifier and Type	Method and Description
boolean	add(E element)
boolean	addAll(Collection<? extends E> collection)
void	clear()
boolean	contains(Object object)
boolean	containsAll(Collection<?> collection)
boolean	equals(Object object)
protected Collection<E>	getWrappedForRead() Returns the wrapped collection without verifying if modifying it is prohibited.
protected Collection<E>	getWrappedIfModifiable() Verifies if this object is modifiable and either returns the wrapped collection or throws an appropriate exception.
int	hashCode()
boolean	isEmpty()
abstract boolean	isModifiable() Flag specifying if this instance can be modified
Iterator<E>	iterator()
boolean	remove(Object object)
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.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ProxiedCollection

public ProxiedCollection(Collection<E> collection)

Creates a new ProxiedCollection instance.

Parameters:

collection - Wrapped collection

Method Detail

add

public boolean add(@Nullable
                   E element)

Specified by:

add in interface Collection<E>

addAll

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

Specified by:

addAll in interface Collection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

contains

public boolean contains(@Nullable
                        Object object)

Specified by:

contains in interface Collection<E>

containsAll

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

Specified by:

containsAll in interface Collection<E>

equals

public boolean equals(@CheckForNull
                      Object object)

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

getWrappedIfModifiable

protected Collection<E> getWrappedIfModifiable()

Verifies if this object is modifiable and either returns the wrapped collection or throws an appropriate exception.

Returns:

the wrapped collection if this object is modifiable

Throws:

UnsupportedOperationException - if this object is unmodifiable

getWrappedForRead

protected Collection<E> getWrappedForRead()

Returns the wrapped collection without verifying if modifying it is prohibited.

Returns:

the wrapped collection

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

isModifiable

public abstract boolean isModifiable()

Flag specifying if this instance can be modified

Returns:

true if this instance is modifiable, else false

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

remove

public boolean remove(@Nullable
                      Object object)

Specified by:

remove in interface Collection<E>

removeAll

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

Specified by:

removeAll in interface Collection<E>

retainAll

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

Specified by:

retainAll in interface Collection<E>

size

public int size()

Specified by:

size in interface Collection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

toArray

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

Specified by:

toArray in interface Collection<E>

toString

public String toString()

Overrides:

toString in class Object