net.nicholaswilliams.java.licensing.immutable

Class ImmutableAbstractCollection<E>

java.lang.Object

net.nicholaswilliams.java.licensing.immutable.ImmutableAbstractCollection<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Immutable

Direct Known Subclasses:

ImmutableArrayList, ImmutableLinkedHashSet

public abstract class ImmutableAbstractCollection<E>
extends Object
implements Immutable, Collection<E>, Serializable

Wraps a collection such that it cannot be modified. There is some overhead associated with this due to verification of hash codes on every call to prevent tampering with via reflection, but this is well worth it if your goal is security and you truly need an unmodifiable collection.

Since:

1.0.0

Version:

1.0.0

Author:

Nick Williams

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutableAbstractCollection(Collection<E> collection) Constructor that wraps (not copies).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
protected void	checkValidity() Checks the validity of this object, and throws an ImmutableModifiedThroughReflectionException if that check fails.
void	clear()
boolean	contains(Object object)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty()
ImmutableIterator<E>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] prototype)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableAbstractCollection

protected ImmutableAbstractCollection(Collection<E> collection)

Constructor that wraps (not copies).

Parameters:

collection - The collection to decorate, must not be null

Throws:

IllegalArgumentException - if collection is null

Method Detail

checkValidity

protected final void checkValidity()

Checks the validity of this object, and throws an ImmutableModifiedThroughReflectionException if that check fails.

Throws:

ImmutableModifiedThroughReflectionException - if the validity check fails.

equals

public final boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Overrides:

equals in class Object

hashCode

public final int hashCode()

Specified by:

hashCode in interface Collection<E>

Overrides:

hashCode in class Object

contains

public final boolean contains(Object object)

Specified by:

contains in interface Collection<E>

containsAll

public final boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

iterator

public final ImmutableIterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

size

public final int size()

Specified by:

size in interface Collection<E>

toArray

public final Object[] toArray()

Specified by:

toArray in interface Collection<E>

toArray

public final <T> T[] toArray(T[] prototype)

Specified by:

toArray in interface Collection<E>

toString

public final String toString()

Overrides:

toString in class Object

add

public final boolean add(E e)

Specified by:

add in interface Collection<E>

addAll

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

Specified by:

addAll in interface Collection<E>

clear

public final void clear()

Specified by:

clear in interface Collection<E>

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<E>

removeAll

public final boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

retainAll

public final boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>