org.jboss.webbeans.util.collections
Class ForwardingCollection<E>

java.lang.Object
  extended by org.jboss.webbeans.util.collections.ForwardingObject
      extended by org.jboss.webbeans.util.collections.ForwardingCollection<E>
All Implemented Interfaces:
java.lang.Iterable<E>, java.util.Collection<E>
Direct Known Subclasses:
ForwardingSet

public abstract class ForwardingCollection<E>
extends ForwardingObject
implements java.util.Collection<E>

A collection which forwards all its method calls to another collection. Subclasses should override one or more methods to modify the behavior of the backing collection as desired per the decorator pattern.

Author:
Kevin Bourrillion, Pete Muir
See Also:
ForwardingObject

Constructor Summary
ForwardingCollection()
           
 
Method Summary
 boolean add(E element)
           
 boolean addAll(java.util.Collection<? extends E> collection)
           
static
<T> T
checkNotNull(T reference)
          Ensures that an object reference passed as a parameter to the calling method is not null.
 void clear()
           
 boolean contains(java.lang.Object object)
           
 boolean containsAll(java.util.Collection<?> collection)
           
protected abstract  java.util.Collection<E> delegate()
          Returns the backing delegate instance that methods are forwarded to.
 boolean isEmpty()
           
 java.util.Iterator<E> iterator()
           
 boolean remove(java.lang.Object object)
           
 boolean removeAll(java.util.Collection<?> collection)
          
 boolean retainAll(java.util.Collection<?> collection)
          
 int size()
           
 java.lang.Object[] toArray()
           
<T> T[]
toArray(T[] array)
           
 
Methods inherited from class org.jboss.webbeans.util.collections.ForwardingObject
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Collection
equals, hashCode
 

Constructor Detail

ForwardingCollection

public ForwardingCollection()
Method Detail

delegate

protected abstract java.util.Collection<E> delegate()
Description copied from class: ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override the ForwardingObject method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:
delegate in class ForwardingObject

iterator

public java.util.Iterator<E> iterator()
Specified by:
iterator in interface java.lang.Iterable<E>
Specified by:
iterator in interface java.util.Collection<E>

size

public int size()
Specified by:
size in interface java.util.Collection<E>

removeAll

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

This method always throws a NullPointerException when collection is null.

Specified by:
removeAll in interface java.util.Collection<E>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface java.util.Collection<E>

contains

public boolean contains(java.lang.Object object)
Specified by:
contains in interface java.util.Collection<E>

toArray

public java.lang.Object[] toArray()
Specified by:
toArray in interface java.util.Collection<E>

toArray

public <T> T[] toArray(T[] array)
Specified by:
toArray in interface java.util.Collection<E>

add

public boolean add(E element)
Specified by:
add in interface java.util.Collection<E>

remove

public boolean remove(java.lang.Object object)
Specified by:
remove in interface java.util.Collection<E>

containsAll

public boolean containsAll(java.util.Collection<?> collection)
Specified by:
containsAll in interface java.util.Collection<E>

addAll

public boolean addAll(java.util.Collection<? extends E> collection)
Specified by:
addAll in interface java.util.Collection<E>

retainAll

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

This method always throws a NullPointerException when collection is null.

Specified by:
retainAll in interface java.util.Collection<E>

clear

public void clear()
Specified by:
clear in interface java.util.Collection<E>

checkNotNull

public static <T> T checkNotNull(T reference)
Ensures that an object reference passed as a parameter to the calling method is not null.

Parameters:
reference - an object reference
Returns:
the non-null reference that was validated
Throws:
java.lang.NullPointerException - if reference is null


Copyright © 2011. All Rights Reserved.