railo.commons.util.mod
Class AbstractCollection<E>

java.lang.Object
  extended by railo.commons.util.mod.AbstractCollection<E>
All Implemented Interfaces:
Iterable<E>, Collection<E>
Direct Known Subclasses:
AbstractSet

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


Method Summary
 boolean add(E e)
          
 boolean addAll(Collection<? extends E> c)
           
 void clear()
          
 boolean contains(Object o)
          
 boolean containsAll(Collection<?> c)
           
 boolean isEmpty()
          
abstract  Iterator<E> iterator()
          Returns an iterator over the elements contained in this collection.
 boolean remove(Object o)
          
 boolean removeAll(Collection<?> c)
           
 boolean retainAll(Collection<?> c)
           
abstract  int size()
           
 Object[] toArray()
          
<T> T[]
toArray(T[] a)
          
 String toString()
          Returns a string representation of this collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Collection
equals, hashCode
 

Method Detail

iterator

public abstract Iterator<E> iterator()
Returns an iterator over the elements contained in this collection.

Specified by:
iterator in interface Iterable<E>
Specified by:
iterator in interface Collection<E>
Returns:
an iterator over the elements contained in this collection

size

public abstract int size()
Specified by:
size in interface Collection<E>

isEmpty

public boolean isEmpty()

This implementation returns size() == 0.

Specified by:
isEmpty in interface Collection<E>

contains

public boolean contains(Object o)

This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.

Specified by:
contains in interface Collection<E>
Throws:
ClassCastException
NullPointerException

toArray

public Object[] toArray()

This implementation returns an array containing all the elements returned by this collection's iterator, in the same order, stored in consecutive elements of the array, starting with index 0. The length of the returned array is equal to the number of elements returned by the iterator, even if the size of this collection changes during iteration, as might happen if the collection permits concurrent modification during iteration. The size method is called only as an optimization hint; the correct result is returned even if the iterator returns a different number of elements.

This method is equivalent to:

 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray();
 

Specified by:
toArray in interface Collection<E>

toArray

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

This implementation returns an array containing all the elements returned by this collection's iterator in the same order, stored in consecutive elements of the array, starting with index 0. If the number of elements returned by the iterator is too large to fit into the specified array, then the elements are returned in a newly allocated array with length equal to the number of elements returned by the iterator, even if the size of this collection changes during iteration, as might happen if the collection permits concurrent modification during iteration. The size method is called only as an optimization hint; the correct result is returned even if the iterator returns a different number of elements.

This method is equivalent to:

 List<E> list = new ArrayList<E>(size());
 for (E e : this)
     list.add(e);
 return list.toArray(a);
 

Specified by:
toArray in interface Collection<E>
Throws:
ArrayStoreException
NullPointerException

add

public boolean add(E e)

This implementation always throws an UnsupportedOperationException.

Specified by:
add in interface Collection<E>
Throws:
UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IllegalStateException

remove

public boolean remove(Object o)

This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.

Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.

Specified by:
remove in interface Collection<E>
Throws:
UnsupportedOperationException
ClassCastException
NullPointerException

containsAll

public boolean containsAll(Collection<?> c)
Specified by:
containsAll in interface Collection<E>

addAll

public boolean addAll(Collection<? extends E> c)
Specified by:
addAll in interface Collection<E>

removeAll

public boolean removeAll(Collection<?> c)
Specified by:
removeAll in interface Collection<E>

retainAll

public boolean retainAll(Collection<?> c)
Specified by:
retainAll in interface Collection<E>

clear

public void clear()

This implementation iterates over this collection, removing each element using the Iterator.remove operation. Most implementations will probably choose to override this method for efficiency.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection is non-empty.

Specified by:
clear in interface Collection<E>
Throws:
UnsupportedOperationException

toString

public String toString()
Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

Overrides:
toString in class Object
Returns:
a string representation of this collection


Copyright © 2012 Railo