com.mockobjects

Class ReturnObjectBag

public class ReturnObjectBag extends Object implements Verifiable

The ReturnObjectBag is a map containing instances of ReturnObjectList. A single instance is held for each mapkey. Every time a call to putObjectToReturn or getNextReturnObject is made an object is added or removed from the ReturnObjectList for the given key. This allows the ReturnObjectBag to be used to return an ordered list of objects for each key regardless of the order in which the key requests are made.

Version: $Revision: 1.4 $

Author: Jeff Martin

See Also: ReturnObjectList

Constructor Summary
ReturnObjectBag(String name)
Method Summary
HashtablegetHashTable()
booleangetNextReturnBoolean(Object key)
intgetNextReturnInt(Object key)
ObjectgetNextReturnObject(Object key)
Returns the next object in the ReturnObjectList for a given key.
ObjectgetNextReturnObject(int key)
Returns the next object in the ReturnObjectList for a given int key.
voidputObjectToReturn(Object key, Object value)
Places an object into the list of return objects for a particular key
voidputObjectToReturn(int key, Object value)
Places an object into the list of return objects for a particular int key
voidputObjectToReturn(Object key, int value)
Places an int into the list of return objects for a particular key.
voidputObjectToReturn(Object key, boolean value)
Places an boolean into the list of return objects for a particular key.
voidverify()
Checks each the list for each key to verify that all no objects remain in the list for that key.

Constructor Detail

ReturnObjectBag

public ReturnObjectBag(String name)

Parameters: name Name used to describe an instance of ReturnObjectBag in error messages

Method Detail

getHashTable

public Hashtable getHashTable()

getNextReturnBoolean

public boolean getNextReturnBoolean(Object key)

getNextReturnInt

public int getNextReturnInt(Object key)

getNextReturnObject

public Object getNextReturnObject(Object key)
Returns the next object in the ReturnObjectList for a given key. The call will throw an AssertFailError if the requested key is not present within this ReturnObjectBag.

Parameters: key The key for which the next object should be returned.

Returns: The next object from the ReturnObjectList stored against the given key.

See Also: ReturnObjectList

getNextReturnObject

public Object getNextReturnObject(int key)
Returns the next object in the ReturnObjectList for a given int key. The call will throw an AssertFailError if the requested key is not present within this ReturnObjectBag.

Parameters: key The key for which the next object should be returned.

Returns: The next object from the ReturnObjectList stored against the given key.

See Also: ReturnObjectList

putObjectToReturn

public void putObjectToReturn(Object key, Object value)
Places an object into the list of return objects for a particular key

Parameters: key the key against which the object will be stored value the value to be added to the list for that key

See Also: ReturnObjectList

putObjectToReturn

public void putObjectToReturn(int key, Object value)
Places an object into the list of return objects for a particular int key

Parameters: key the key against which the object will be stored value the value to be added to the list for that key

See Also: ReturnObjectList

putObjectToReturn

public void putObjectToReturn(Object key, int value)
Places an int into the list of return objects for a particular key. The value can be retrieved using the getNextReturnInt method

Parameters: key the key against which the object will be stored value the value to be added to the list for that key

See Also: ReturnObjectList ReturnObjectBag

putObjectToReturn

public void putObjectToReturn(Object key, boolean value)
Places an boolean into the list of return objects for a particular key. The value can be retrieved using the getNextReturnBoolean method

Parameters: key the key against which the object will be stored value the value to be added to the list for that key

See Also: ReturnObjectList ReturnObjectBag

verify

public void verify()
Checks each the list for each key to verify that all no objects remain in the list for that key.

See Also: ReturnObjectList

Copyright © 2002 Mock Objects. All Rights Reserved.