Package org.jmock.expectation
Class ReturnObjectBag
java.lang.Object
org.jmock.expectation.ReturnObjectBag
- All Implemented Interfaces:
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$
- Author:
- Jeff Martin
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
getNextReturnInt
(Object key) getNextReturnObject
(int key) Returns the next object in the ReturnObjectList for a given int key.Returns the next object in the ReturnObjectList for a given key.void
putObjectToReturn
(int key, Object value) Places an object into the list of return objects for a particular int keyvoid
putObjectToReturn
(Object key, boolean value) Places an boolean into the list of return objects for a particular key.void
putObjectToReturn
(Object key, int value) Places an int into the list of return objects for a particular key.void
putObjectToReturn
(Object key, Object value) Places an object into the list of return objects for a particular keyvoid
verify()
Checks each the list for each key to verify that all no objects remain in the list for that key.
-
Constructor Details
-
ReturnObjectBag
- Parameters:
name
- Name used to describe an instance of ReturnObjectBag in error messages
-
-
Method Details
-
putObjectToReturn
Places an object into the list of return objects for a particular key- Parameters:
key
- the key against which the object will be storedvalue
- the value to be added to the list for that key- See Also:
-
putObjectToReturn
Places an object into the list of return objects for a particular int key- Parameters:
key
- the key against which the object will be storedvalue
- the value to be added to the list for that key- See Also:
-
putObjectToReturn
Places an int into the list of return objects for a particular key. The value can be retrieved using the getNextReturnInt invokedMethod- Parameters:
key
- the key against which the object will be storedvalue
- the value to be added to the list for that key- See Also:
-
putObjectToReturn
Places an boolean into the list of return objects for a particular key. The value can be retrieved using the getNextReturnBoolean invokedMethod- Parameters:
key
- the key against which the object will be storedvalue
- the value to be added to the list for that key- See Also:
-
verify
public void verify()Checks each the list for each key to verify that all no objects remain in the list for that key.- Specified by:
verify
in interfaceVerifiable
- See Also:
-
getNextReturnObject
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:
-
getNextReturnObject
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:
-
getHashTable
-
getNextReturnInt
-
getNextReturnBoolean
-