org.apache.commons.collections.primitives.adapters
Class CollectionByteCollection

java.lang.Object
  extended by org.apache.commons.collections.primitives.adapters.CollectionByteCollection
All Implemented Interfaces:
Serializable, ByteCollection

public final class CollectionByteCollection
extends Object
implements Serializable

Adapts a Number-valued Collection to the ByteCollection interface.

This implementation delegates most methods to the provided Collection implementation in the "obvious" way.

Since:
Commons Primitives 1.0
Version:
$Revision: 480462 $ $Date: 2006-11-29 09:15:00 +0100(mer, 29 nov 2006) $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Constructor Summary
CollectionByteCollection(Collection collection)
          Creates an ByteCollection wrapping the specified Collection.
 
Method Summary
 boolean add(byte element)
          Ensures that I contain the specified element (optional operation).
 boolean addAll(ByteCollection c)
          Adds all of the elements in the specified collection to me (optional operation).
 void clear()
          Removes all my elements (optional operation).
 boolean contains(byte element)
          Returns true iff I contain the specified element.
 boolean containsAll(ByteCollection c)
          Returns true iff I contain all of the elements in the given collection.
protected  Collection getCollection()
           
 boolean isEmpty()
          Returns true iff I contain no elements.
 ByteIterator iterator()
          wraps the Iterator returned by my underlying Collection, if any.
 boolean removeAll(ByteCollection c)
          Removes all of my elements that are contained in the specified collection (optional operation).
 boolean removeElement(byte element)
          Removes a single occurrence of the specified element (optional operation).
 boolean retainAll(ByteCollection c)
          Removes all of my elements that are not contained in the specified collection (optional operation).
 int size()
          Returns the number of elements I contain.
 byte[] toArray()
          Returns an array containing all of my elements.
 byte[] toArray(byte[] dest)
          Returns an array containing all of my elements, using the given array if it is large enough.
 String toString()
           
static ByteCollection wrap(Collection collection)
          Create an ByteCollection wrapping the specified Collection.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CollectionByteCollection

public CollectionByteCollection(Collection collection)
Creates an ByteCollection wrapping the specified Collection.

See Also:
wrap(java.util.Collection)
Method Detail

wrap

public static ByteCollection wrap(Collection collection)
Create an ByteCollection wrapping the specified Collection. When the given collection is null, returns null.

Parameters:
collection - the (possibly null) Collection to wrap
Returns:
an ByteCollection wrapping the given collection, or null when collection is null.

getCollection

protected Collection getCollection()

add

public boolean add(byte element)
Description copied from interface: ByteCollection
Ensures that I contain the specified element (optional operation). Returns true iff I changed as a result of this call.

If a collection refuses to add the specified element for any reason other than that it already contains the element, it must throw an exception (rather than simply returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:
add in interface ByteCollection
Parameters:
element - the value whose presence within me is to be ensured
Returns:
true iff I changed as a result of this call

addAll

public boolean addAll(ByteCollection c)
Description copied from interface: ByteCollection
Adds all of the elements in the specified collection to me (optional operation).

Specified by:
addAll in interface ByteCollection
Parameters:
c - the collection of elements whose presence within me is to be ensured
Returns:
true iff I changed as a result of this call

clear

public void clear()
Description copied from interface: ByteCollection
Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:
clear in interface ByteCollection

contains

public boolean contains(byte element)
Description copied from interface: ByteCollection
Returns true iff I contain the specified element.

Specified by:
contains in interface ByteCollection
Parameters:
element - the value whose presence within me is to be tested
Returns:
true iff I contain the specified element

containsAll

public boolean containsAll(ByteCollection c)
Description copied from interface: ByteCollection
Returns true iff I contain all of the elements in the given collection.

Specified by:
containsAll in interface ByteCollection
Parameters:
c - the collection of elements whose presence within me is to be tested
Returns:
true iff I contain the all the specified elements

toString

public String toString()
Overrides:
toString in class Object

isEmpty

public boolean isEmpty()
Description copied from interface: ByteCollection
Returns true iff I contain no elements.

Specified by:
isEmpty in interface ByteCollection
Returns:
true iff I contain no elements.

iterator

public ByteIterator iterator()
wraps the Iterator returned by my underlying Collection, if any.

Specified by:
iterator in interface ByteCollection
Returns:
an iterator over all my elements.

removeElement

public boolean removeElement(byte element)
Description copied from interface: ByteCollection
Removes a single occurrence of the specified element (optional operation).

Specified by:
removeElement in interface ByteCollection
Parameters:
element - the element to remove, if present
Returns:
true iff I contained the specified element, in other words, iff I changed as a result of this call

removeAll

public boolean removeAll(ByteCollection c)
Description copied from interface: ByteCollection
Removes all of my elements that are contained in the specified collection (optional operation). The behavior of this method is unspecified if the given collection is modified while this method is executing. Note that this includes the case in which the given collection is this collection, and it is not empty.

Specified by:
removeAll in interface ByteCollection
Parameters:
c - the collection of elements to remove
Returns:
true iff I contained the at least one of the specified elements, in other words, returns true iff I changed as a result of this call

retainAll

public boolean retainAll(ByteCollection c)
Description copied from interface: ByteCollection
Removes all of my elements that are not contained in the specified collection (optional operation). (In other words, retains only my elements that are contained in the specified collection.) The behavior of this method is unspecified if the given collection is modified while this method is executing.

Specified by:
retainAll in interface ByteCollection
Parameters:
c - the collection of elements to retain
Returns:
true iff I changed as a result of this call

size

public int size()
Description copied from interface: ByteCollection
Returns the number of elements I contain.

Specified by:
size in interface ByteCollection
Returns:
the number of elements I contain

toArray

public byte[] toArray()
Description copied from interface: ByteCollection
Returns an array containing all of my elements. The length of the returned array will be equal to my size.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:
toArray in interface ByteCollection
Returns:
an array containing all my elements

toArray

public byte[] toArray(byte[] dest)
Description copied from interface: ByteCollection
Returns an array containing all of my elements, using the given array if it is large enough. When the length of the given array is larger than the number of elements I contain, values outside of my range will be unchanged.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:
toArray in interface ByteCollection
Parameters:
dest - an array that may be used to contain the elements
Returns:
an array containing all my elements


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.