org.easymock

Class EasyMock

public class EasyMock extends Object

Field Summary
static String	ENABLE_THREAD_SAFETY_CHECK_BY_DEFAULT Since EasyMock 2.4, by default, a mock wasn't allowed to be called in multiple threads unless it was made thread-safe (See EasyMock method).
static String	NOT_THREAD_SAFE_BY_DEFAULT Since EasyMock 2.5, by default a mock is thread-safe.

Constructor Summary
protected	EasyMock() Prevent instantiation but allow inheritance

Method Summary
static boolean	and(boolean first, boolean second) Expects a boolean that matches both given expectations.
static byte	and(byte first, byte second) Expects a byte that matches both given expectations.
static char	and(char first, char second) Expects a char that matches both given expectations.
static double	and(double first, double second) Expects a double that matches both given expectations.
static float	and(float first, float second) Expects a float that matches both given expectations.
static int	and(int first, int second) Expects an int that matches both given expectations.
static long	and(long first, long second) Expects a long that matches both given expectations.
static short	and(short first, short second) Expects a short that matches both given expectations.
static <T> T	and(T first, T second) Expects an Object that matches both given expectations.
static boolean	anyBoolean() Expects any boolean argument.
static byte	anyByte() Expects any byte argument.
static char	anyChar() Expects any char argument.
static double	anyDouble() Expects any double argument.
static float	anyFloat() Expects any float argument.
static int	anyInt() Expects any int argument.
static long	anyLong() Expects any long argument.
static <T> T	anyObject() Expects any Object argument.
static short	anyShort() Expects any short argument.
static boolean[]	aryEq(boolean[] value) Expects a boolean array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static byte[]	aryEq(byte[] value) Expects a byte array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static char[]	aryEq(char[] value) Expects a char array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static double[]	aryEq(double[] value) Expects a double array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static float[]	aryEq(float[] value) Expects a float array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static int[]	aryEq(int[] value) Expects an int array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static long[]	aryEq(long[] value) Expects a long array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static short[]	aryEq(short[] value) Expects a short array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.
static <T> T[]	aryEq(T[] value) Expects an Object array that is equal to the given array, i.e. it has to have the same type, length, and each element has to be equal.
static <T> T	capture(Capture<T> captured) Expect any object but captures it for later use.
static int	capture(Capture<Integer> captured) Expect any int but captures it for later use.
static long	capture(Capture<Long> captured) Expect any long but captures it for later use.
static float	capture(Capture<Float> captured) Expect any float but captures it for later use.
static double	capture(Capture<Double> captured) Expect any double but captures it for later use.
static byte	capture(Capture<Byte> captured) Expect any byte but captures it for later use.
static char	capture(Capture<Character> captured) Expect any char but captures it for later use.
static void	checkIsUsedInOneThread(Object mock, boolean shouldBeUsedInOneThread) Tell that the mock should be used in only one thread.
static void	checkOrder(Object mock, boolean state) Switches order checking of the given mock object (more exactly: the control of the mock object) the on and off.
static <T> T	cmp(T value, Comparator<? super T> comparator, LogicalOperator operator) Expects an argument that will be compared using the provided comparator.
static <T extends Comparable<T>> T	cmpEq(Comparable<T> value) Expects a comparable argument equals to the given value according to their compareTo method.
static String	contains(String substring) Expects a string that contains the given substring.
static IMocksControl	createControl() Creates a control, order checking is disabled by default.
static <T> T	createMock(Class<T> toMock) Creates a mock object that implements the given interface, order checking is disabled by default.
static <T> T	createMock(String name, Class<T> toMock) Creates a mock object that implements the given interface, order checking is disabled by default.
static 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.
static <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.
static <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.
static IMocksControl	createStrictControl() Creates a control, order checking is enabled by default.
static <T> T	createStrictMock(Class<T> toMock) Creates a mock object that implements the given interface, order checking is enabled by default.
static <T> T	createStrictMock(String name, Class<T> toMock) Creates a mock object that implements the given interface, order checking is enabled by default.
static String	endsWith(String suffix) Expects a string that ends with the given suffix.
static boolean	eq(boolean value) Expects a boolean that is equal to the given value.
static byte	eq(byte value) Expects a byte that is equal to the given value.
static char	eq(char value) Expects a char that is equal to the given value.
static double	eq(double value) Expects a double that is equal to the given value.
static float	eq(float value) Expects a float that is equal to the given value.
static int	eq(int value) Expects an int that is equal to the given value.
static long	eq(long value) Expects a long that is equal to the given value.
static short	eq(short value) Expects a short that is equal to the given value.
static <T> T	eq(T value) Expects an Object that is equal to the given value.
static double	eq(double value, double delta) Expects a double that has an absolute difference to the given value that is less than the given delta.
static float	eq(float value, float delta) Expects a float that has an absolute difference to the given value that is less than the given delta.
static <T> IExpectationSetters<T>	expect(T value) Returns the expectation setter for the last expected invocation in the current thread.
static <T> IExpectationSetters<T>	expectLastCall() Returns the expectation setter for the last expected invocation in the current thread.
static String	find(String regex) Expects a string that contains a substring that matches the given regular expression.
static <T extends Comparable<T>> T	geq(Comparable<T> value) Expects a comparable argument greater than or equal the given value.
static byte	geq(byte value) Expects a byte argument greater than or equal to the given value.
static double	geq(double value) Expects a double argument greater than or equal to the given value.
static float	geq(float value) Expects a float argument greater than or equal to the given value.
static int	geq(int value) Expects an int argument greater than or equal to the given value.
static long	geq(long value) Expects a long argument greater than or equal to the given value.
static short	geq(short value) Expects a short argument greater than or equal to the given value.
static Object[]	getCurrentArguments() Returns the arguments of the current mock method call, if inside an `IAnswer` callback - be careful here, reordering parameters of method changes the semantics of your tests.
static String	getEasyMockProperty(String key) Get the current value for an EasyMock property
static <T extends Comparable<T>> T	gt(Comparable<T> value) Expects a comparable argument greater than the given value.
static byte	gt(byte value) Expects a byte argument greater than the given value.
static double	gt(double value) Expects a double argument greater than the given value.
static float	gt(float value) Expects a float argument greater than the given value.
static int	gt(int value) Expects an int argument greater than the given value.
static long	gt(long value) Expects a long argument greater than the given value.
static short	gt(short value) Expects a short argument greater than the given value.
static <T> T	isA(Class<T> clazz) Expects an object implementing the given class.
static <T> T	isNull() Expects null.
static <T extends Comparable<T>> T	leq(Comparable<T> value) Expects a comparable argument less than or equal the given value.
static byte	leq(byte value) Expects a byte argument less than or equal to the given value.
static double	leq(double value) Expects a double argument less than or equal to the given value.
static float	leq(float value) Expects a float argument less than or equal to the given value.
static int	leq(int value) Expects an int argument less than or equal to the given value.
static long	leq(long value) Expects a long argument less than or equal to the given value.
static short	leq(short value) Expects a short argument less than or equal to the given value.
static <T extends Comparable<T>> T	lt(Comparable<T> value) Expects a comparable argument less than the given value.
static byte	lt(byte value) Expects a byte argument less than the given value.
static double	lt(double value) Expects a double argument less than the given value.
static float	lt(float value) Expects a float argument less than the given value.
static int	lt(int value) Expects an int argument less than the given value.
static long	lt(long value) Expects a long argument less than the given value.
static short	lt(short value) Expects a short argument less than the given value.
static void	makeThreadSafe(Object mock, boolean threadSafe) By default, a mock is thread safe (unless NOT_THREAD_SAFE_BY_DEFAULT is set).
static String	matches(String regex) Expects a string that matches the given regular expression.
static boolean	not(boolean first) Expects a boolean that does not match the given expectation.
static byte	not(byte first) Expects a byte that does not match the given expectation.
static char	not(char first) Expects a char that does not match the given expectation.
static double	not(double first) Expects a double that does not match the given expectation.
static float	not(float first) Expects a float that does not match the given expectation.
static int	not(int first) Expects an int that does not match the given expectation.
static long	not(long first) Expects a long that does not match the given expectation.
static short	not(short first) Expects a short that does not match the given expectation.
static <T> T	not(T first) Expects an Object that does not match the given expectation.
static <T> T	notNull() Expects not null.
static boolean	or(boolean first, boolean second) Expects a boolean that matches one of the given expectations.
static byte	or(byte first, byte second) Expects a byte that matches one of the given expectations.
static char	or(char first, char second) Expects a char that matches one of the given expectations.
static double	or(double first, double second) Expects a double that matches one of the given expectations.
static float	or(float first, float second) Expects a float that matches one of the given expectations.
static int	or(int first, int second) Expects an int that matches one of the given expectations.
static long	or(long first, long second) Expects a long that matches one of the given expectations.
static short	or(short first, short second) Expects a short that matches one of the given expectations.
static <T> T	or(T first, T second) Expects an Object that matches one of the given expectations.
static void	replay(Object... mocks) Switches the given mock objects (more exactly: the controls of the mock objects) to replay mode.
static void	reportMatcher(IArgumentMatcher matcher) Reports an argument matcher.
static void	reset(Object... mocks) Resets the given mock objects (more exactly: the controls of the mock objects).
static void	resetToDefault(Object... mocks) Resets the given mock objects (more exactly: the controls of the mock objects) and turn them to a mock with default behavior.
static void	resetToNice(Object... mocks) Resets the given mock objects (more exactly: the controls of the mock objects) and turn them to a mock with nice behavior.
static void	resetToStrict(Object... mocks) Resets the given mock objects (more exactly: the controls of the mock objects) and turn them to a mock with strict behavior.
static <T> T	same(T value) Expects an Object that is the same as the given value.
static String	setEasyMockProperty(String key, String value) Set a property to modify the default EasyMock behavior.
static String	startsWith(String prefix) Expects a string that starts with the given prefix.
static void	verify(Object... mocks) Verifies the given mock objects (more exactly: the controls of the mock objects).

Field Detail

ENABLE_THREAD_SAFETY_CHECK_BY_DEFAULT

public static final String ENABLE_THREAD_SAFETY_CHECK_BY_DEFAULT

Since EasyMock 2.4, by default, a mock wasn't allowed to be called in multiple threads unless it was made thread-safe (See EasyMock method). Since EasyMock 2.5, this isn't the default anymore. For backward compatibility, this property can bring EasyMock 2.4 behavior back.

NOT_THREAD_SAFE_BY_DEFAULT

public static final String NOT_THREAD_SAFE_BY_DEFAULT

Since EasyMock 2.5, by default a mock is thread-safe. For backward compatibility, this property can change the default. A given mock still can be made thread-safe by calling EasyMock.

Constructor Detail

EasyMock

protected EasyMock()

Prevent instantiation but allow inheritance

Method Detail

and

public static boolean and(boolean first, boolean second)

Expects a boolean that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: false.

and

public static byte and(byte first, byte second)

Expects a byte that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static char and(char first, char second)

Expects a char that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static double and(double first, double second)

Expects a double that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static float and(float first, float second)

Expects a float that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static int and(int first, int second)

Expects an int that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static long and(long first, long second)

Expects a long that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static short and(short first, short second)

Expects a short that matches both given expectations.

Parameters: first placeholder for the first expectation. second placeholder for the second expectation.

Returns: 0.

and

public static <T> T and(T first, T second)

Expects an Object that matches both given expectations.

Parameters: the type of the object, it is passed through to prevent casts. first placeholder for the first expectation. second placeholder for the second expectation.

Returns: null.

anyBoolean

public static boolean anyBoolean()

Expects any boolean argument. For details, see the EasyMock documentation.

Returns: false.

anyByte

public static byte anyByte()

Expects any byte argument. For details, see the EasyMock documentation.

Returns: 0.

anyChar

public static char anyChar()

Expects any char argument. For details, see the EasyMock documentation.

Returns: 0.

anyDouble

public static double anyDouble()

Expects any double argument. For details, see the EasyMock documentation.

Returns: 0.

anyFloat

public static float anyFloat()

Expects any float argument. For details, see the EasyMock documentation.

Returns: 0.

anyInt

public static int anyInt()

Expects any int argument. For details, see the EasyMock documentation.

Returns: 0.

anyLong

public static long anyLong()

Expects any long argument. For details, see the EasyMock documentation.

Returns: 0.

anyObject

public static <T> T anyObject()

Expects any Object argument. For details, see the EasyMock documentation.

Parameters: type of the method argument to match

Returns: null.

anyShort

public static short anyShort()

Expects any short argument. For details, see the EasyMock documentation.

Returns: 0.

aryEq

public static boolean[] aryEq(boolean[] value)

Expects a boolean array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static byte[] aryEq(byte[] value)

Expects a byte array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static char[] aryEq(char[] value)

Expects a char array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static double[] aryEq(double[] value)

Expects a double array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static float[] aryEq(float[] value)

Expects a float array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static int[] aryEq(int[] value)

Expects an int array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static long[] aryEq(long[] value)

Expects a long array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static short[] aryEq(short[] value)

Expects a short array that is equal to the given array, i.e. it has to have the same length, and each element has to be equal.

Parameters: value the given arry.

Returns: null.

aryEq

public static <T> T[] aryEq(T[] value)

Expects an Object array that is equal to the given array, i.e. it has to have the same type, length, and each element has to be equal.

Parameters: the type of the array, it is passed through to prevent casts. value the given arry.

Returns: null.

capture

public static <T> T capture(Capture<T> captured)

Expect any object but captures it for later use.

Parameters: Type of the captured object captured Where the parameter is captured

Returns: null

capture

public static int capture(Capture<Integer> captured)

Expect any int but captures it for later use.

Parameters: captured Where the parameter is captured

Returns: 0

capture

public static long capture(Capture<Long> captured)

Expect any long but captures it for later use.

Parameters: captured Where the parameter is captured

Returns: 0

capture

public static float capture(Capture<Float> captured)

Expect any float but captures it for later use.

Parameters: captured Where the parameter is captured

Returns: 0

capture

public static double capture(Capture<Double> captured)

Expect any double but captures it for later use.

Parameters: captured Where the parameter is captured

Returns: 0

capture

public static byte capture(Capture<Byte> captured)

Expect any byte but captures it for later use.

Parameters: captured Where the parameter is captured

Returns: 0

capture

public static char capture(Capture<Character> captured)

Expect any char but captures it for later use.

Parameters: captured Where the parameter is captured

Returns: 0

checkIsUsedInOneThread

public static void checkIsUsedInOneThread(Object mock, boolean shouldBeUsedInOneThread)

Tell that the mock should be used in only one thread. An exception will be thrown if that's not the case. This can be useful when mocking an object that isn't thread safe to make sure it is used correctly in a multithreaded environment. By default, no check is done unless ENABLE_THREAD_SAFETY_CHECK_BY_DEFAULT was set to true.

Parameters: mock the mock shouldBeUsedInOneThread If the mock should be used in only one thread

checkOrder

public static void checkOrder(Object mock, boolean state)

Switches order checking of the given mock object (more exactly: the control of the mock object) the on and off. For details, see the EasyMock documentation.

Parameters: mock the mock object. state true switches order checking on, false switches it off.

cmp

public static <T> T cmp(T value, Comparator<? super T> comparator, LogicalOperator operator)

Expects an argument that will be compared using the provided comparator. The following comparison will take place:

comparator.compare(actual, expected) operator 0

For details, see the EasyMock documentation.

Parameters: type of the method argument to match value the given value. comparator Comparator used to compare the actual with expected value. operator The comparison operator.

Returns: null

cmpEq

public static <T extends Comparable<T>> T cmpEq(Comparable<T> value)

Expects a comparable argument equals to the given value according to their compareTo method. For details, see the EasMock documentation.

Parameters: type of the method argument to match value the given value.

Returns: null.

contains

public static String contains(String substring)

Expects a string that contains the given substring. For details, see the EasyMock documentation.

Parameters: substring the substring.

Returns: null.

createControl

public static IMocksControl createControl()

Creates a control, order checking is disabled by default.

Returns: the control.

createMock

public static <T> T createMock(Class<T> toMock)

Creates a mock object that implements the given interface, order checking is disabled by default.

Parameters: the interface that the mock object should implement. toMock the class of the interface that the mock object should implement.

Returns: the mock object.

createMock

public static <T> T createMock(String name, Class<T> toMock)

Creates a mock object that implements the given interface, order checking is disabled by default.

Parameters: name the name of the mock object. toMock the class of the interface that the mock object should implement. the interface that the mock object should implement.

Returns: the mock object.

Throws: IllegalArgumentException if the name is not a valid Java identifier.

createNiceControl

public static 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.

createNiceMock

public static <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.

Parameters: the interface that the mock object should implement. toMock the class of the interface that the mock object should implement.

Returns: the mock object.

createNiceMock

public static <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.

Parameters: name the name of the mock object. toMock the class of the interface that the mock object should implement. 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 static IMocksControl createStrictControl()

Creates a control, order checking is enabled by default.

Returns: the control.

createStrictMock

public static <T> T createStrictMock(Class<T> toMock)

Creates a mock object that implements the given interface, order checking is enabled by default.

Parameters: the interface that the mock object should implement. toMock the class of the interface that the mock object should implement.

Returns: the mock object.

createStrictMock

public static <T> T createStrictMock(String name, Class<T> toMock)

Creates a mock object that implements the given interface, order checking is enabled by default.

Parameters: name the name of the mock object. toMock the class of the interface that the mock object should implement. the interface that the mock object should implement.

Returns: the mock object.

Throws: IllegalArgumentException if the name is not a valid Java identifier.

endsWith

public static String endsWith(String suffix)

Expects a string that ends with the given suffix. For details, see the EasyMock documentation.

Parameters: suffix the suffix.

Returns: null.