org.easymock
Class EasyMockSupport

java.lang.Object
  extended by org.easymock.EasyMockSupport

public class EasyMockSupport
extends Object

Helper class to be used to keep tracks of mocks easily. See EasyMock documentation and SupportTest sample.

Example of usage:

 public class SupportTest extends EasyMockSupport {
     @Test
     public void test() {
         firstMock = createMock(A.class);
         secondMock = createMock(B.class);
         
         replayAll(); // put both mocks in replay mode
         
         // ... use mocks ..
         
         verifyAll(); // verify both mocks
     }
 }
 

Author:
Henri Tremblay

Field Summary
protected  List<IMocksControl> controls
          List of all controls created
 
Constructor Summary
EasyMockSupport()
           
 
Method Summary
 IMocksControl createControl()
          Creates a control, order checking is disabled by default.
<T> T
createMock(Class<T> toMock)
          Creates a mock object that implements the given interface, order checking is disabled by default.
<T> T
createMock(Class<T> toMock, ConstructorArgs constructorArgs, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createMock(Class<T> toMock, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createMock(String name, Class<T> toMock)
          Creates a mock object that implements the given interface, order checking is disabled by default.
<T> T
createMock(String name, Class<T> toMock, ConstructorArgs constructorArgs, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createMock(String name, Class<T> toMock, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> IMockBuilder<T>
createMockBuilder(Class<T> toMock)
          Create a mock builder allowing to create a partial mock for the given class or interface.
 IMocksControl createNiceControl()
          Creates a control, order checking is disabled by default, and the mock objects created by this control will return 0, null or false for unexpected invocations.
<T> T
createNiceMock(Class<T> toMock)
          Creates a mock object that implements the given interface, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.
<T> T
createNiceMock(Class<T> toMock, ConstructorArgs constructorArgs, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createNiceMock(Class<T> toMock, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createNiceMock(String name, Class<T> toMock)
          Creates a mock object that implements the given interface, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.
<T> T
createNiceMock(String name, Class<T> toMock, ConstructorArgs constructorArgs, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createNiceMock(String name, Class<T> toMock, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
 IMocksControl createStrictControl()
          Creates a control, order checking is enabled by default.
<T> T
createStrictMock(Class<T> toMock)
          Creates a mock object that implements the given interface, order checking is enabled by default.
<T> T
createStrictMock(Class<T> toMock, ConstructorArgs constructorArgs, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createStrictMock(Class<T> toMock, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createStrictMock(String name, Class<T> toMock)
          Creates a mock object that implements the given interface, order checking is enabled by default.
<T> T
createStrictMock(String name, Class<T> toMock, ConstructorArgs constructorArgs, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
<T> T
createStrictMock(String name, Class<T> toMock, Method... mockedMethods)
          Deprecated. Use createMockBuilder(Class) instead
 void replayAll()
          Switches all registered mock objects (more exactly: the controls of the mock objects) to replay mode.
 void resetAll()
          Resets all registered mock objects (more exactly: the controls of the mock objects).
 void resetAllToDefault()
          Resets all registered mock objects (more exactly: the controls of the mock objects) and turn them to a mock with default behavior.
 void resetAllToNice()
          Resets all registered mock objects (more exactly: the controls of the mock objects) and turn them to a mock with nice behavior.
 void resetAllToStrict()
          Resets all registered mock objects (more exactly: the controls of the mock objects) and turn them to a mock with strict behavior.
 void verifyAll()
          Verifies all registered mock objects (more exactly: the controls of the mock objects).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

controls

protected final List<IMocksControl> controls
List of all controls created

Constructor Detail

EasyMockSupport

public EasyMockSupport()
Method Detail

createStrictMock

@Deprecated
public <T> T createStrictMock(Class<T> toMock,
                                         Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is enabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
toMock - the class that the mock object should extend.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createStrictMock

@Deprecated
public <T> T createStrictMock(String name,
                                         Class<T> toMock,
                                         Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is enabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
name - the name of the mock object.
toMock - the class that the mock object should extend.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createStrictMock

@Deprecated
public <T> T createStrictMock(Class<T> toMock,
                                         ConstructorArgs constructorArgs,
                                         Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is enabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
toMock - the class that the mock object should extend.
constructorArgs - constructor and parameters used to instantiate the mock.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createStrictMock

@Deprecated
public <T> T createStrictMock(String name,
                                         Class<T> toMock,
                                         ConstructorArgs constructorArgs,
                                         Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is enabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
name - the name of the mock object.
toMock - the class that the mock object should extend.
constructorArgs - constructor and parameters used to instantiate the mock.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createMock

@Deprecated
public <T> T createMock(Class<T> toMock,
                                   Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
toMock - the class that the mock object should extend.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createMock

@Deprecated
public <T> T createMock(String name,
                                   Class<T> toMock,
                                   Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
name - the name of the mock object.
toMock - the class that the mock object should extend.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createMock

@Deprecated
public <T> T createMock(Class<T> toMock,
                                   ConstructorArgs constructorArgs,
                                   Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
toMock - the class that the mock object should extend.
constructorArgs - constructor and parameters used to instantiate the mock.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createMock

@Deprecated
public <T> T createMock(String name,
                                   Class<T> toMock,
                                   ConstructorArgs constructorArgs,
                                   Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
name - the name of the mock object.
toMock - the class that the mock object should extend.
constructorArgs - constructor and parameters used to instantiate the mock.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createNiceMock

@Deprecated
public <T> T createNiceMock(Class<T> toMock,
                                       Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
toMock - the class that the mock object should extend.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createNiceMock

@Deprecated
public <T> T createNiceMock(String name,
                                       Class<T> toMock,
                                       Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
name - the name of the mock object.
toMock - the class that the mock object should extend.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createNiceMock

@Deprecated
public <T> T createNiceMock(Class<T> toMock,
                                       ConstructorArgs constructorArgs,
                                       Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
toMock - the class that the mock object should extend.
constructorArgs - constructor and parameters used to instantiate the mock.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createNiceMock

@Deprecated
public <T> T createNiceMock(String name,
                                       Class<T> toMock,
                                       ConstructorArgs constructorArgs,
                                       Method... mockedMethods)
Deprecated. Use createMockBuilder(Class) instead

Creates a mock object that extends the given class, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.

Type Parameters:
T - the class that the mock object should extend.
Parameters:
name - the name of the mock object.
toMock - the class that the mock object should extend.
constructorArgs - constructor and parameters used to instantiate the mock.
mockedMethods - methods that will be mocked, other methods will behave normally
Returns:
the mock object.

createStrictMock

public <T> T createStrictMock(Class<T> toMock)
Creates a mock object that implements the given interface, order checking is enabled by default.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
toMock - the class of the interface that the mock object should implement.
Returns:
the mock object.

createStrictMock

public <T> T createStrictMock(String name,
                              Class<T> toMock)
Creates a mock object that implements the given interface, order checking is enabled by default.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
name - the name of the mock object.
toMock - the class of the interface that the mock object should implement.
Returns:
the mock object.
Throws:
IllegalArgumentException - if the name is not a valid Java identifier.

createMock

public <T> T createMock(Class<T> toMock)
Creates a mock object that implements the given interface, order checking is disabled by default.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
toMock - the class of the interface that the mock object should implement.
Returns:
the mock object.

createMock

public <T> T createMock(String name,
                        Class<T> toMock)
Creates a mock object that implements the given interface, order checking is disabled by default.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
name - the name of the mock object.
toMock - the class of the interface that the mock object should implement.
Returns:
the mock object.
Throws:
IllegalArgumentException - if the name is not a valid Java identifier.

createNiceMock

public <T> T createNiceMock(Class<T> toMock)
Creates a mock object that implements the given interface, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
toMock - the class of the interface that the mock object should implement.
Returns:
the mock object.

createNiceMock

public <T> T createNiceMock(String name,
                            Class<T> toMock)
Creates a mock object that implements the given interface, order checking is disabled by default, and the mock object will return 0, null or false for unexpected invocations.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
name - the name of the mock object.
toMock - the class of the interface that the mock object should implement.
Returns:
the mock object.
Throws:
IllegalArgumentException - if the name is not a valid Java identifier.

createStrictControl

public IMocksControl createStrictControl()
Creates a control, order checking is enabled by default.

Returns:
the control.

createMockBuilder

public <T> IMockBuilder<T> createMockBuilder(Class<T> toMock)
Create a mock builder allowing to create a partial mock for the given class or interface.

Type Parameters:
T - the interface that the mock object should implement.
Parameters:
toMock - the class of the interface that the mock object should implement.
Returns:
a mock builder to create a partial mock

createControl

public IMocksControl createControl()
Creates a control, order checking is disabled by default.

Returns:
the control.

createNiceControl

public IMocksControl createNiceControl()
Creates a control, order checking is disabled by default, and the mock objects created by this control will return 0, null or false for unexpected invocations.

Returns:
the control.

replayAll

public void replayAll()
Switches all registered mock objects (more exactly: the controls of the mock objects) to replay mode. For details, see the EasyMock documentation.


resetAll

public void resetAll()
Resets all registered mock objects (more exactly: the controls of the mock objects). For details, see the EasyMock documentation.


verifyAll

public void verifyAll()
Verifies all registered mock objects (more exactly: the controls of the mock objects).


resetAllToNice

public void resetAllToNice()
Resets all registered mock objects (more exactly: the controls of the mock objects) and turn them to a mock with nice behavior. For details, see the EasyMock documentation.


resetAllToDefault

public void resetAllToDefault()
Resets all registered mock objects (more exactly: the controls of the mock objects) and turn them to a mock with default behavior. For details, see the EasyMock documentation.


resetAllToStrict

public void resetAllToStrict()
Resets all registered mock objects (more exactly: the controls of the mock objects) and turn them to a mock with strict behavior. For details, see the EasyMock documentation.



Copyright © 2001-2011 OFFIS, Tammo Freese, Henri Tremblay. All Rights Reserved.