Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.mockobjects
Class ReturnValue  view ReturnValue download ReturnValue.java

java.lang.Object
  extended bycom.mockobjects.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 method 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 is null the return value can be set like this value.setValue(null) in this case calling value.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: 1.4 $

Field Summary
private  java.lang.String name
           
private  java.lang.Object value
           
 
Constructor Summary
ReturnValue(java.lang.String name)
           
 
Method Summary
 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)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private final java.lang.String name

value

private java.lang.Object value
Constructor Detail

ReturnValue

public ReturnValue(java.lang.String name)
Method Detail

getValue

public java.lang.Object getValue()

setValue

public void setValue(java.lang.Object value)

setValue

public void setValue(boolean value)

getBooleanValue

public boolean getBooleanValue()

getIntValue

public int getIntValue()

setValue

public void setValue(int value)

setValue

public void setValue(long value)

getLongValue

public long getLongValue()