Matchers (parent 0.0.1-SNAPSHOT API)

java.lang.Object
- org.mockito.Matchers

Direct Known Subclasses:

Mockito
```
public class Matchers
extends Object
```
Allow flexible verification or stubbing. See also AdditionalMatchers.
Mockito extends Matchers so to get access to all matchers just import Mockito class statically.
```
  //stubbing using anyInt() argument matcher
  when(mockedList.get(anyInt())).thenReturn("element");
  
  //following prints "element"
  System.out.println(mockedList.get(999));
  
  //you can also verify using argument matcher
  verify(mockedList).get(anyInt());
 
```
Scroll down to see all methods - full list of matchers.
Warning:
If you are using argument matchers, all arguments have to be provided by matchers.
E.g: (example shows verification but the same applies to stubbing):
```
   verify(mock).someMethod(anyInt(), anyString(), eq("third argument"));
   //above is correct - eq() is also an argument matcher
   
   verify(mock).someMethod(anyInt(), anyString(), "third argument");
   //above is incorrect - exception will be thrown because third argument is given without argument matcher.
 
```
Custom Argument Matchers
Use argThat(org.hamcrest.Matcher<T>) method and pass an instance of hamcrest Matcher.
Before you start implementing your own custom argument matcher, make sure you check out ArgumentCaptor api.
So, how to implement your own argument matcher? First, you might want to subclass ArgumentMatcher which is an hamcrest matcher with predefined describeTo() method. Default description generated by describeTo() uses decamelized class name - to promote meaningful class names.
Example:
```
   class IsListOfTwoElements extends ArgumentMatcher<List> {
      public boolean matches(Object list) {
          return ((List) list).size() == 2;
      }
   }
   
   List mock = mock(List.class);
   
   when(mock.addAll(argThat(new IsListOfTwoElements()))).thenReturn(true);
   
   mock.addAll(Arrays.asList("one", "two"));
   
   verify(mock).addAll(argThat(new IsListOfTwoElements()));
 
```
To keep it readable you may want to extract method, e.g:
```
   verify(mock).addAll(argThat(new IsListOfTwoElements()));
   //becomes
   verify(mock).addAll(listOfTwoElements());
 
```
Warning: Be reasonable with using complicated argument matching, especially custom argument matchers, as it can make the test less readable. Sometimes it's better to implement equals() for arguments that are passed to mocks (Mockito naturally uses equals() for argument matching). This can make the test cleaner.
Also, sometimes ArgumentCaptor may be a better fit than custom matcher. For example, if custom argument matcher is not likely to be reused or you just need it to assert on argument values to complete verification of behavior.

Constructor Summary

Constructors
Constructor and Description

Matchers()

Constructors
Constructor and Description
`Matchers()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <T> T`	`any()` any object or null
`static <T> T`	`any(Class<T> clazz)` any kind object, not necessary of the given class.
`static boolean`	`anyBoolean()` any boolean, Boolean or null.
`static byte`	`anyByte()` any byte, Byte or null
`static char`	`anyChar()` any char, Character or null.
`static Collection`	`anyCollection()` any Collection or null.
`static <T> Collection<T>`	`anyCollectionOf(Class<T> clazz)` generic friendly alias to `anyCollection()`.
`static double`	`anyDouble()` any double, Double or null.
`static float`	`anyFloat()` any float, Float or null.
`static int`	`anyInt()` any int, Integer or null.
`static List`	`anyList()` any List or null.
`static <T> List<T>`	`anyListOf(Class<T> clazz)` generic friendly alias to `anyList()`.
`static long`	`anyLong()` any long, Long or null.
`static Map`	`anyMap()` any Map or null.
`static <T> T`	`anyObject()` any Object or null.
`static Set`	`anySet()` any Set or null
`static <T> Set<T>`	`anySetOf(Class<T> clazz)` generic friendly alias to `anySet()`.
`static short`	`anyShort()` any short, Short or null.
`static String`	`anyString()` any String or null.
`static <T> T`	`anyVararg()` Any vararg, meaning any number and values of arguments.
`static <T> T`	`argThat(Matcher<T> matcher)` Allows creating custom argument matchers.
`static boolean`	`booleanThat(Matcher<Boolean> matcher)` Allows creating custom argument matchers.
`static byte`	`byteThat(Matcher<Byte> matcher)` Allows creating custom argument matchers.
`static char`	`charThat(Matcher<Character> matcher)` Allows creating custom argument matchers.
`static String`	`contains(String substring)` String argument that contains the given substring.
`static double`	`doubleThat(Matcher<Double> matcher)` Allows creating custom argument matchers.
`static String`	`endsWith(String suffix)` String argument that ends with the given suffix.
`static boolean`	`eq(boolean value)` boolean argument that is equal to the given value.
`static byte`	`eq(byte value)` byte argument that is equal to the given value.
`static char`	`eq(char value)` char argument that is equal to the given value.
`static double`	`eq(double value)` double argument that is equal to the given value.
`static float`	`eq(float value)` float argument that is equal to the given value.
`static int`	`eq(int value)` int argument that is equal to the given value.
`static long`	`eq(long value)` long argument that is equal to the given value.
`static short`	`eq(short value)` short argument that is equal to the given value.
`static <T> T`	`eq(T value)` Object argument that is equal to the given value.
`static float`	`floatThat(Matcher<Float> matcher)` Allows creating custom argument matchers.
`static int`	`intThat(Matcher<Integer> matcher)` Allows creating custom argument matchers.
`static <T> T`	`isA(Class<T> clazz)` Object argument that implements the given class.
`static Object`	`isNotNull()` not null argument.
`static Object`	`isNull()` null argument.
`static long`	`longThat(Matcher<Long> matcher)` Allows creating custom argument matchers.
`static String`	`matches(String regex)` String argument that matches the given regular expression.
`static Object`	`notNull()` not null argument.
`static <T> T`	`refEq(T value, String... excludeFields)` Object argument that is reflection-equal to the given value with support for excluding selected fields from a class.
`static <T> T`	`same(T value)` Object argument that is the same as the given value.
`static short`	`shortThat(Matcher<Short> matcher)` Allows creating custom argument matchers.
`static String`	`startsWith(String prefix)` String argument that starts with the given prefix.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Matchers
```
public Matchers()
```
- Method Detail
  - anyBoolean
```
public static boolean anyBoolean()
```
    any boolean, Boolean or null.
    See examples in javadoc for Matchers class
    
    Returns:
    false.
  - anyByte
```
public static byte anyByte()
```
    any byte, Byte or null
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyChar
```
public static char anyChar()
```
    any char, Character or null.
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyInt
```
public static int anyInt()
```
    any int, Integer or null.
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyLong
```
public static long anyLong()
```
    any long, Long or null.
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyFloat
```
public static float anyFloat()
```
    any float, Float or null.
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyDouble
```
public static double anyDouble()
```
    any double, Double or null.
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyShort
```
public static short anyShort()
```
    any short, Short or null.
    See examples in javadoc for Matchers class
    
    Returns:
    0.
  - anyObject
```
public static <T> T anyObject()
```
    any Object or null.
    Has aliases: any() and any(Class clazz)
    See examples in javadoc for Matchers class
    
    Returns:
    null.
  - anyVararg
```
public static <T> T anyVararg()
```
    Any vararg, meaning any number and values of arguments.
    Example:
```
   //verification:
   mock.foo(1, 2);
   mock.foo(1, 2, 3, 4);

   verify(mock, times(2)).foo(anyVararg());

   //stubbing:
   when(mock.foo(anyVararg()).thenReturn(100);

   //prints 100
   System.out.println(mock.foo(1, 2));
   //also prints 100
   System.out.println(mock.foo(1, 2, 3, 4));
 
```
    See examples in javadoc for Matchers class
    Returns:
    null.
  - any
```
public static <T> T any(Class<T> clazz)
```
    any kind object, not necessary of the given class. The class argument is provided only to avoid casting.
    Sometimes looks better than anyObject() - especially when explicit casting is required
    Alias to anyObject()
    See examples in javadoc for Matchers class
    
    Returns:
    null.
  - any
```
public static <T> T any()
```
    any object or null
    Shorter alias to anyObject()
    See examples in javadoc for Matchers class
    
    Returns:
    null.
  - anyString
```
public static String anyString()
```
    any String or null.
    See examples in javadoc for Matchers class
    
    Returns:
    empty String ("")
  - anyList
```
public static List anyList()
```
    any List or null.
    See examples in javadoc for Matchers class
    
    Returns:
    empty List.
  - anyListOf
```
public static <T> List<T> anyListOf(Class<T> clazz)
```
    generic friendly alias to anyList(). It's an alternative to @SuppressWarnings("unchecked") to keep code clean of compiler warnings.
    any List or null.
    See examples in javadoc for Matchers class
    
    Returns:
    empty List.
  - anySet
```
public static Set anySet()
```
    any Set or null
    See examples in javadoc for Matchers class
    
    Returns:
    empty Set
  - anySetOf
```
public static <T> Set<T> anySetOf(Class<T> clazz)
```
    generic friendly alias to anySet(). It's an alternative to @SuppressWarnings("unchecked") to keep code clean of compiler warnings.
    any Set or null
    See examples in javadoc for Matchers class
    
    Returns:
    empty Set
  - anyMap
```
public static Map anyMap()
```
    any Map or null.
    See examples in javadoc for Matchers class
    
    Returns:
    empty Map.
  - anyCollection
```
public static Collection anyCollection()
```
    any Collection or null.
    See examples in javadoc for Matchers class
    
    Returns:
    empty Collection.
  - anyCollectionOf
```
public static <T> Collection<T> anyCollectionOf(Class<T> clazz)
```
    generic friendly alias to anyCollection(). It's an alternative to @SuppressWarnings("unchecked") to keep code clean of compiler warnings.
    any Collection or null.
    See examples in javadoc for Matchers class
    
    Returns:
    empty Collection.
  - isA
```
public static <T> T isA(Class<T> clazz)
```
    Object argument that implements the given class.
    See examples in javadoc for Matchers class
    
    Type Parameters:
    T - the accepted type.
    Parameters:
    clazz - the class of the accepted type.
    
    Returns:
    null.
  - eq
```
public static boolean eq(boolean value)
```
    boolean argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static byte eq(byte value)
```
    byte argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static char eq(char value)
```
    char argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static double eq(double value)
```
    double argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static float eq(float value)
```
    float argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static int eq(int value)
```
    int argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static long eq(long value)
```
    long argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static short eq(short value)
```
    short argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    0.
  - eq
```
public static <T> T eq(T value)
```
    Object argument that is equal to the given value.
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    
    Returns:
    null.
  - refEq
```
public static <T> T refEq(T value,
          String... excludeFields)
```
    Object argument that is reflection-equal to the given value with support for excluding selected fields from a class.
    This matcher can be used when equals() is not implemented on compared objects. Matcher uses java reflection API to compare fields of wanted and actual object.
    Works similarly to EqualsBuilder.reflectionEquals(this, other, exlucdeFields) from apache commons library.
    Warning The equality check is shallow!
    See examples in javadoc for Matchers class
    
    Parameters:
    value - the given value.
    excludeFields - fields to exclude, if field does not exist it is ignored.
    
    Returns:
    null.
  - same
```
public static <T> T same(T value)
```
    Object argument that is the same as the given value.
    See examples in javadoc for Matchers class
    
    Type Parameters:
    T - the type of the object, it is passed through to prevent casts.
    Parameters:
    value - the given value.
    
    Returns:
    null.
  - isNull
```
public static Object isNull()
```
    null argument.
    See examples in javadoc for Matchers class
    
    Returns:
    null.
  - notNull
```
public static Object notNull()
```
    not null argument.
    alias to isNotNull()
    See examples in javadoc for Matchers class
    
    Returns:
    null.
  - isNotNull
```
public static Object isNotNull()
```
    not null argument.
    alias to notNull()
    See examples in javadoc for Matchers class
    
    Returns:
    null.
  - contains
```
public static String contains(String substring)
```
    String argument that contains the given substring.
    See examples in javadoc for Matchers class
    
    Parameters:
    substring - the substring.
    
    Returns:
    empty String ("").
  - matches
```
public static String matches(String regex)
```
    String argument that matches the given regular expression.
    See examples in javadoc for Matchers class
    
    Parameters:
    regex - the regular expression.
    
    Returns:
    empty String ("").
  - endsWith
```
public static String endsWith(String suffix)
```
    String argument that ends with the given suffix.
    See examples in javadoc for Matchers class
    
    Parameters:
    suffix - the suffix.
    
    Returns:
    empty String ("").
  - startsWith
```
public static String startsWith(String prefix)
```
    String argument that starts with the given prefix.
    See examples in javadoc for Matchers class
    
    Parameters:
    prefix - the prefix.
    
    Returns:
    empty String ("").
  - argThat
```
public static <T> T argThat(Matcher<T> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for ArgumentMatcher class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    null.
  - charThat
```
public static char charThat(Matcher<Character> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.
  - booleanThat
```
public static boolean booleanThat(Matcher<Boolean> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    false.
  - byteThat
```
public static byte byteThat(Matcher<Byte> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.
  - shortThat
```
public static short shortThat(Matcher<Short> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.
  - intThat
```
public static int intThat(Matcher<Integer> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.
  - longThat
```
public static long longThat(Matcher<Long> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.
  - floatThat
```
public static float floatThat(Matcher<Float> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.
  - doubleThat
```
public static double doubleThat(Matcher<Double> matcher)
```
    Allows creating custom argument matchers.
    See examples in javadoc for Matchers class
    
    Parameters:
    matcher - decides whether argument matches
    
    Returns:
    0.

Class Matchers

Custom Argument Matchers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Matchers

Method Detail

anyBoolean

anyByte

anyChar

anyInt

anyLong

anyFloat

anyDouble

anyShort

anyObject

anyVararg

any

any

anyString

anyList

anyListOf

anySet

anySetOf

anyMap

anyCollection

anyCollectionOf

isA

eq

eq

eq

eq

eq

eq

eq

eq

eq

refEq

same

isNull

notNull

isNotNull

contains

matches

endsWith

startsWith

argThat

charThat

booleanThat

byteThat

shortThat

intThat

longThat

floatThat

doubleThat