bak.pcj
Class SynchronizedByteCollection

java.lang.Object
  bak.pcj.SynchronizedByteCollection

All Implemented Interfaces:

ByteCollection

public class SynchronizedByteCollection

extends Object

implements ByteCollection

This class represents synchronized collections of byte values. As in the Java Collections API iterations over the collection must be synchronized on the collection itself.

Since:

1.0

See Also:

Collections.synchronizedCollection(java.util.Collection)

Field Summary

protected ByteCollection	collection The collection underlying this synchronized collection.
protected Object	m An object on which to synchronize this collection's methods.

Constructor Summary

SynchronizedByteCollection(ByteCollection c)
Creates a new synchronized collection on an existing collection.

Method Summary

boolean	add(byte v) Adds an element to this collection.
boolean	addAll(ByteCollection c) Adds all the elements of a specified collection to this collection.
void	clear() Clears this collection.
boolean	contains(byte v) Indicates whether this collection contains a specified element.
boolean	containsAll(ByteCollection c) Indicates whether all elements of a specified collection is contained in this collection.
boolean	equals(Object obj) Indicates whether this collection is equal to some object.
int	hashCode() Returns a hash code value for this collection.
boolean	isEmpty() Indicates whether this collection is empty.
ByteIterator	iterator() Returns an iterator over this collection.
boolean	remove(byte v) Removes a specified element from this collection.
boolean	removeAll(ByteCollection c) Removes all the elements of a specified collection from this collection.
boolean	retainAll(ByteCollection c) Retains only the elements of a specified collection in this collection.
int	size() Returns the number of elements in this collection.
byte[]	toArray() Returns the elements of this collection as an array.
byte[]	toArray(byte[] a) Returns the elements of this collection as an array.
void	trimToSize() Minimizes the memory used by this collection.

Methods inherited from class java.lang.Object

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

Field Detail

collection

protected ByteCollection collection

The collection underlying this synchronized collection.

m

protected Object m

An object on which to synchronize this collection's methods.

Constructor Detail

SynchronizedByteCollection

public SynchronizedByteCollection(ByteCollection c)

Creates a new synchronized collection on an existing collection. The result is a collection whose elements and behaviour is the same as the existing collection's except that the new collection's methods are synchronized.

Parameters:

c - the existing collection to make synchronized.

Throws:

NullPointerException - if c is null.

Method Detail

add

public boolean add(byte v)

Description copied from interface: ByteCollection

Adds an element to this collection.

Specified by:

add in interface ByteCollection

Parameters:

v - the element to add to this collection.

Returns:

true if this collection was modified as a result of adding v; returns false otherwise.

See Also:

ByteCollection.addAll(ByteCollection)

addAll

public boolean addAll(ByteCollection c)

Description copied from interface: ByteCollection

Adds all the elements of a specified collection to this collection.

Specified by:

addAll in interface ByteCollection

Parameters:

c - the collection whose elements to add to this collection.

Returns:

true if this collection was modified as a result of adding the elements of c; returns false otherwise.

See Also:

ByteCollection.add(byte)

clear

public void clear()

Description copied from interface: ByteCollection

Clears this collection.

Specified by:

clear in interface ByteCollection

contains

public boolean contains(byte v)

Description copied from interface: ByteCollection

Indicates whether this collection contains a specified element.

Specified by:

contains in interface ByteCollection

Parameters:

v - the element to test for containment.

Returns:

true if v is contained in this collection; returns false otherwise.

See Also:

ByteCollection.containsAll(ByteCollection)

containsAll

public boolean containsAll(ByteCollection c)

Description copied from interface: ByteCollection

Indicates whether all elements of a specified collection is contained in this collection.

Specified by:

containsAll in interface ByteCollection

Parameters:

c - the collection whose elements to test for containment.

Returns:

true if all the elements of c are contained in this collection; returns false otherwise.

See Also:

ByteCollection.contains(byte)

equals

public boolean equals(Object obj)

Description copied from interface: ByteCollection

Indicates whether this collection is equal to some object.

Specified by:

equals in interface ByteCollection

hashCode

public int hashCode()

Description copied from interface: ByteCollection

Returns a hash code value for this collection.

Specified by:

hashCode in interface ByteCollection

isEmpty

public boolean isEmpty()

Description copied from interface: ByteCollection

Indicates whether this collection is empty.

Specified by:

isEmpty in interface ByteCollection

Returns:

true if this collection is empty; returns false otherwise.

iterator

public ByteIterator iterator()

Description copied from interface: ByteCollection

Returns an iterator over this collection.

Specified by:

iterator in interface ByteCollection

Returns:

an iterator over this collection.

remove

public boolean remove(byte v)

Description copied from interface: ByteCollection

Removes a specified element from this collection.

Specified by:

remove in interface ByteCollection

Parameters:

v - the byte value to remove from this collection.

Returns:

true if this collection was modified as a result of removing v; returns false otherwise.

removeAll

public boolean removeAll(ByteCollection c)

Description copied from interface: ByteCollection

Removes all the elements of a specified collection from this collection.

Specified by:

removeAll in interface ByteCollection

Parameters:

c - the collection whose elements to remove from this collection.

Returns:

true if this collection was modified as a result of removing the elements of c; returns false otherwise.

retainAll

public boolean retainAll(ByteCollection c)

Description copied from interface: ByteCollection

Retains only the elements of a specified collection in this collection.

Specified by:

retainAll in interface ByteCollection

Parameters:

c - the collection whose elements to retain in this collection.

Returns:

true if this collection was modified as a result of removing the elements not contained in c; returns false otherwise.

size

public int size()

Description copied from interface: ByteCollection

Returns the number of elements in this collection.

Specified by:

size in interface ByteCollection

Returns:

the number of elements in this collection.

toArray

public byte[] toArray()

Description copied from interface: ByteCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface ByteCollection

Returns:

a new array containing the elements of this collection.

toArray

public byte[] toArray(byte[] a)

Description copied from interface: ByteCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface ByteCollection

Parameters:

a - an array to fill with the elements of this collection; if a is null or not big enough to contain all the elements of this collection, an new array is allocated, and a is not changed.

Returns:

a, if a has room for all the elements of this collection; otherwise a new array is allocated, filled with the elements of this collection, and returned.

trimToSize

public void trimToSize()

Description copied from interface: ByteCollection

Minimizes the memory used by this collection. The exact operation of this method depends on the class implementing it. Implementors may choose to ignore it completely.

Specified by:

trimToSize in interface ByteCollection