jpaul.DataStructs
Class VerboseWorkSet<T>

java.lang.Object
  jpaul.DataStructs.VerboseWorkSet<T>

All Implemented Interfaces:

java.io.Serializable, WorkSet<T>

public class VerboseWorkSet<T>
extends java.lang.Object
implements WorkSet<T>, java.io.Serializable

VerboseWorkSet - Debugging wrapper for a WorkSet. Prints helpful messages each time the state of the WorkSet is modified (ex: adding/extracting elements and when clearing the entire content of the WorkSet.).

Version:

$Id: VerboseWorkSet.java,v 1.6 2006/03/14 02:29:31 salcianu Exp $

Author:

Alexandru Salcianu - salcianu@alum.mit.edu

See Also:

Serialized Form

Constructor Summary

VerboseWorkSet(WorkSet<T> wSet, java.lang.String preffix)
Creates a VerboseWorkSet.

Method Summary

boolean	add(T elem) Adds the element elem to this workset.
boolean	addAll(java.util.Collection<T> elems) Adds all elements from elems to this workset.
void	clear() Removes all elements from the workset. Complexity: O(1).
boolean	contains(T e) Checks whether this workset contains the element e. Complexity: O(1).
T	extract() Returns the first element of this workset (according to the order specific to this workset.
boolean	isEmpty() Checks whether this workset is empty. Complexity: O(1).
int	size() Returns the size of this workset. Invariant: isEmpty() iff size() == 0. Complexity: O(1).
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VerboseWorkSet

public VerboseWorkSet(WorkSet<T> wSet,
                      java.lang.String preffix)

Creates a VerboseWorkSet.

Parameters:

wSet - Underlying WorkSet.

preffix - String to be printed at the beginning of each output line. This preffix allows the programmer to make the distinction between messages generated by different VerboseWorkSets.

Method Detail

add

public boolean add(T elem)

Description copied from interface: WorkSet

Adds the element elem to this workset.

Specified by:

add in interface WorkSet<T>

Returns:

true if elem was not already in the workset. If elem was already in the workset, the workset does not change in any way, and add returns false.

addAll

public boolean addAll(java.util.Collection<T> elems)

Description copied from interface: WorkSet

Adds all elements from elems to this workset.

Specified by:

addAll in interface WorkSet<T>

Returns:

true if any of the added elements was not already in this workset. Otherwise, the workset does not change in any way, and add returns false.

extract

public T extract()

Description copied from interface: WorkSet

Returns the first element of this workset (according to the order specific to this workset. The element is removed from the workset. Throws a NoSuchElementException if the workset is empty.

Specified by:

extract in interface WorkSet<T>

Returns:

The first element from the workset.

clear

public void clear()

Description copied from interface: WorkSet

Removes all elements from the workset.
Complexity: O(1).

Specified by:

clear in interface WorkSet<T>

isEmpty

public boolean isEmpty()

Description copied from interface: WorkSet

Checks whether this workset is empty.
Complexity: O(1).

Specified by:

isEmpty in interface WorkSet<T>

contains

public boolean contains(T e)

Description copied from interface: WorkSet

Checks whether this workset contains the element e.
Complexity: O(1).

Specified by:

contains in interface WorkSet<T>

size

public int size()

Description copied from interface: WorkSet

Returns the size of this workset.
Invariant: isEmpty() iff size() == 0.
Complexity: O(1).

Specified by:

size in interface WorkSet<T>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object