Package org.jmock.expectation
Class ReturnValue
- java.lang.Object
-
- org.jmock.expectation.ReturnValue
-
public class ReturnValue extends java.lang.Object
The ReturnValue class allows a value to be setup which will then be returned upon a specific invokedMethod call. If value.getValue() is called before
value.setValue(value)
the ReturnValue will raise an error warning that this value has not been set. If the required return value isnull
the return value can be set like thisvalue.setValue(null)
in this case callingvalue.getValue()
will return null.The advantage of this is provide better information to the user of a mock when interacting with third party code which may expect certain values to have been set.
e.g.private final ReturnValue value = new ReturnValue("value"); public void setupValue(Integer value){ value.setValue(value); } public Integer getValue(){ return (Integer)value.getValue(); }
- Version:
- $Revision$
-
-
Constructor Summary
Constructors Constructor Description ReturnValue(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getBooleanValue()
int
getIntValue()
long
getLongValue()
java.lang.Object
getValue()
void
setValue(boolean value)
void
setValue(int value)
void
setValue(long value)
void
setValue(java.lang.Object value)
-
-
-
Method Detail
-
getValue
public java.lang.Object getValue()
- Returns:
- the value set using setValue
- Throws:
junit.framework.AssertionFailedError
- throw if setValue has not been called
-
setValue
public void setValue(java.lang.Object value)
- Parameters:
value
- value to be returned by getValue. null can be use to force getValue to return null.
-
setValue
public void setValue(boolean value)
- Parameters:
value
- value to be returned by getBooleanValue. Calling getValue after this invokedMethod will return a Boolean wrapper around the value.
-
getBooleanValue
public boolean getBooleanValue()
- Returns:
- the current value converted to a boolean
-
getIntValue
public int getIntValue()
- Returns:
- the current value converted to an int
-
setValue
public void setValue(int value)
- Parameters:
value
- value to be returned by getIntValue. Calling getValue after this invokedMethod will return a Integer wrapper around the value.
-
setValue
public void setValue(long value)
- Parameters:
value
- value to be returned by getLongValue. Calling getValue after this invokedMethod will return a Long wrapper around the value.
-
getLongValue
public long getLongValue()
- Returns:
- the current value converted to an long
-
-