com.avcompris.util.junit

Class AvcMatchers

java.lang.Object

com.avcompris.util.AbstractUtils

com.avcompris.util.junit.AvcMatchers

public abstract class AvcMatchers
extends com.avcompris.util.AbstractUtils

custom Hamcrest matchers. See the Xebia France's blog.

Author:

David Andriana Copyright Avantage Compris SARL 2008-2009 ©

Constructor Summary

Constructors

Constructor and Description
AvcMatchers()

Method Summary

Modifier and Type	Method and Description
static <T> org.hamcrest.Matcher<T>	contains(String ref) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	contains(String ref, String description) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	containsFileCount(int refFileCount) create a new constraint on a directory.
static <T> org.hamcrest.Matcher<T>	containsFileCount(int refFileCount, String description) create a new constraint on a directory.
static <T> org.hamcrest.Matcher<T>	doesntContain(String ref) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	doesntContain(String ref, String description) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	endsWith(String ref) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	endsWith(String ref, String description) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	equalTo(int ref) create a new constraint on an integer.
static <T> org.hamcrest.Matcher<T>	equalTo(int ref, String description) create a new constraint on an integer.
static <T> org.hamcrest.Matcher<T>	equalTo(long ref) create a new constraint on an long.
static <T> org.hamcrest.Matcher<T>	equalTo(long ref, String description) create a new constraint on an long.
static <T> org.hamcrest.Matcher<T>	fileContains(String text) create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileContains(String text, String description) create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileDoesntContain(String text) create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileDoesntContain(String text, String description) create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileDoesntExist() create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileDoesntExist(String description) create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileExists() create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	fileExists(String description) create a new constraint on a file.
static <T> org.hamcrest.Matcher<T>	greaterThan(int ref) create a new constraint on an integer.
static <T> org.hamcrest.Matcher<T>	greaterThan(int ref, String description) create a new constraint on an integer.
static <T> org.hamcrest.Matcher<T>	greaterThan(long ref) create a new constraint on an long.
static <T> org.hamcrest.Matcher<T>	greaterThan(long ref, String description) create a new constraint on an long.
static <T> org.hamcrest.Matcher<T>	instanceOf(Class<?> c) create a new constraint on an instance.
static <T> org.hamcrest.Matcher<T>	instanceOf(Class<?> c, String description) create a new constraint on an instance.
static <T> org.hamcrest.Matcher<T>	isIn(String[] ref)
static <T> org.hamcrest.Matcher<T>	isIn(String[] ref, String description)
static <T> org.hamcrest.Matcher<T>	isIn(String methodName, Object[] ref)
static <T> org.hamcrest.Matcher<T>	isIn(String methodName, Object[] ref, String description)
static <T> org.hamcrest.Matcher<T>	isLowerCase() create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	isLowerCase(String description) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	isUpperCase() create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	isUpperCase(String description) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	lengthGreaterOrEqualThan(int refArrayLength) create a new constraint on an array's length.
static <T> org.hamcrest.Matcher<T>	lengthGreaterOrEqualThan(int refArrayLength, String description) create a new constraint on an array's length.
static <T> org.hamcrest.Matcher<T>	lesserThan(org.joda.time.DateTime ref) create a new constraint on an date.
static <T> org.hamcrest.Matcher<T>	lesserThan(int ref) create a new constraint on an integer.
static <T> org.hamcrest.Matcher<T>	lesserThan(int ref, String description) create a new constraint on an integer.
static <T> org.hamcrest.Matcher<T>	lesserThan(long ref) create a new constraint on an long.
static <T> org.hamcrest.Matcher<T>	lesserThan(long ref, String description) create a new constraint on an long.
static <T> org.hamcrest.Matcher<T>	lesserThan(String refDescription, org.joda.time.DateTime ref, String description) create a new constraint on an date.
static <T> org.hamcrest.Matcher<T>	notNullValue() create a new constraint on an object.
static <T> org.hamcrest.Matcher<T>	notNullValue(String description) create a new constraint on an object.
static <T> org.hamcrest.Matcher<T>	nullValue() create a new constraint on an object.
static <T> org.hamcrest.Matcher<T>	nullValue(String description) create a new constraint on an object.
static <T> org.hamcrest.Matcher<T>	startsWith(String ref) create a new constraint on an String.
static <T> org.hamcrest.Matcher<T>	startsWith(String ref, String description) create a new constraint on an String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AvcMatchers

public AvcMatchers()

Method Detail

equalTo

public static <T> org.hamcrest.Matcher<T> equalTo(int ref,
                                                  @Nullable
                                                  String description)

create a new constraint on an integer.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " fileCount"

Returns:

a Matcher that will take an integer as a parameter

equalTo

public static <T> org.hamcrest.Matcher<T> equalTo(int ref)

create a new constraint on an integer.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an integer as a parameter

lesserThan

public static <T> org.hamcrest.Matcher<T> lesserThan(int ref,
                                                     @Nullable
                                                     String description)

create a new constraint on an integer.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " fileCount"

Returns:

a Matcher that will take an integer as a parameter

lesserThan

public static <T> org.hamcrest.Matcher<T> lesserThan(int ref)

create a new constraint on an integer.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an integer as a parameter

greaterThan

public static <T> org.hamcrest.Matcher<T> greaterThan(int ref,
                                                      @Nullable
                                                      String description)

create a new constraint on an integer.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " fileCount"

Returns:

a Matcher that will take an integer as a parameter

greaterThan

public static <T> org.hamcrest.Matcher<T> greaterThan(int ref)

create a new constraint on an integer.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an integer as a parameter

equalTo

public static <T> org.hamcrest.Matcher<T> equalTo(long ref,
                                                  @Nullable
                                                  String description)

create a new constraint on an long.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance "filesize

Returns:

a Matcher that will take a long as a parameter

equalTo

public static <T> org.hamcrest.Matcher<T> equalTo(long ref)

create a new constraint on an long.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take a long as a parameter

greaterThan

public static <T> org.hamcrest.Matcher<T> greaterThan(long ref,
                                                      @Nullable
                                                      String description)

create a new constraint on an long.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance "filesize "

Returns:

a Matcher that will take a long as a parameter

greaterThan

public static <T> org.hamcrest.Matcher<T> greaterThan(long ref)

create a new constraint on an long.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take a long as a parameter

lesserThan

public static <T> org.hamcrest.Matcher<T> lesserThan(long ref,
                                                     @Nullable
                                                     String description)

create a new constraint on an long.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance "filesize "

Returns:

a Matcher that will take a long as a parameter

lesserThan

public static <T> org.hamcrest.Matcher<T> lesserThan(long ref)

create a new constraint on an long.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take a long as a parameter

lesserThan

public static <T> org.hamcrest.Matcher<T> lesserThan(org.joda.time.DateTime ref)

create a new constraint on an date.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference date

Returns:

a Matcher that will take a date as a parameter

lesserThan

public static <T> org.hamcrest.Matcher<T> lesserThan(@Nullable
                                                     String refDescription,
                                                     org.joda.time.DateTime ref,
                                                     @Nullable
                                                     String description)

create a new constraint on an date.

Type Parameters:

T - the actual value's type

Parameters:

refDescription - the description for the ref date value

ref - the reference date

description - the name of the value, for instance "fileDate "

Returns:

a Matcher that will take a date as a parameter

lengthGreaterOrEqualThan

public static <T> org.hamcrest.Matcher<T> lengthGreaterOrEqualThan(int refArrayLength)

create a new constraint on an array's length.

Type Parameters:

T - the actual value's type

Parameters:

refArrayLength - the reference length for the array

Returns:

a Matcher that will take an array as a parameter

lengthGreaterOrEqualThan

public static <T> org.hamcrest.Matcher<T> lengthGreaterOrEqualThan(int refArrayLength,
                                                                   @Nullable
                                                                   String description)

create a new constraint on an array's length.

Type Parameters:

T - the actual value's type

Parameters:

refArrayLength - the reference length for the array

description - the name of the array, for instance "dir".

Returns:

a Matcher that will take an array as a parameter

notNullValue

public static <T> org.hamcrest.Matcher<T> notNullValue()

create a new constraint on an object.

Type Parameters:

T - the actual value's type

Returns:

a Matcher that will take an object as a parameter

notNullValue

public static <T> org.hamcrest.Matcher<T> notNullValue(@Nullable
                                                       String description)

create a new constraint on an object.

Type Parameters:

T - the actual value's type

Parameters:

description - the name of the value, for instance "file"

Returns:

a Matcher that will take an object as a parameter

nullValue

public static <T> org.hamcrest.Matcher<T> nullValue()

create a new constraint on an object.

Type Parameters:

T - the actual value's type

Returns:

a Matcher that will take an object as a parameter

nullValue

public static <T> org.hamcrest.Matcher<T> nullValue(@Nullable
                                                    String description)

create a new constraint on an object.

Type Parameters:

T - the actual value's type

Parameters:

description - the name of the value, for instance "file"

Returns:

a Matcher that will take an object as a parameter

fileExists

public static <T> org.hamcrest.Matcher<T> fileExists()

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Returns:

a Matcher that will take an file as a parameter

fileExists

public static <T> org.hamcrest.Matcher<T> fileExists(@Nullable
                                                     String description)

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Parameters:

description - the name of the file, for instance "xmlFile"

Returns:

a Matcher that will take an file as a parameter

fileDoesntExist

public static <T> org.hamcrest.Matcher<T> fileDoesntExist()

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Returns:

a Matcher that will take an file as a parameter

fileDoesntExist

public static <T> org.hamcrest.Matcher<T> fileDoesntExist(@Nullable
                                                          String description)

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Parameters:

description - the name of the file, for instance "xmlFile"

Returns:

a Matcher that will take an file as a parameter

fileContains

public static <T> org.hamcrest.Matcher<T> fileContains(String text,
                                                       @Nullable
                                                       String description)

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Parameters:

text - the text to check the presence for in the given file

description - the name of the file, for instance "xmlFile"

Returns:

a Matcher that will take an file as a parameter

fileContains

public static <T> org.hamcrest.Matcher<T> fileContains(String text)

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Parameters:

text - the text to check the presence for in the given file

Returns:

a Matcher that will take an file as a parameter

fileDoesntContain

public static <T> org.hamcrest.Matcher<T> fileDoesntContain(String text)

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Parameters:

text - the text to check the presence for in the given file

Returns:

a Matcher that will take an file as a parameter

fileDoesntContain

public static <T> org.hamcrest.Matcher<T> fileDoesntContain(String text,
                                                            @Nullable
                                                            String description)

create a new constraint on a file.

Type Parameters:

T - the actual value's type

Parameters:

text - the text to check the presence for in the given file

description - the name of the file, for instance "xmlFile"

Returns:

a Matcher that will take an file as a parameter

containsFileCount

public static <T> org.hamcrest.Matcher<T> containsFileCount(int refFileCount)

create a new constraint on a directory.

Type Parameters:

T - the actual value's type

Parameters:

refFileCount - the reference file count

Returns:

a Matcher that will take an file as a parameter

containsFileCount

public static <T> org.hamcrest.Matcher<T> containsFileCount(int refFileCount,
                                                            @Nullable
                                                            String description)

create a new constraint on a directory.

Type Parameters:

T - the actual value's type

Parameters:

refFileCount - the reference file count

description - the name of the dir, for instance "outputDir"

Returns:

a Matcher that will take an file as a parameter

startsWith

public static <T> org.hamcrest.Matcher<T> startsWith(String ref)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an String as a parameter

startsWith

public static <T> org.hamcrest.Matcher<T> startsWith(String ref,
                                                     @Nullable
                                                     String description)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " firstName"

Returns:

a Matcher that will take an String as a parameter

endsWith

public static <T> org.hamcrest.Matcher<T> endsWith(String ref)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an String as a parameter

endsWith

public static <T> org.hamcrest.Matcher<T> endsWith(String ref,
                                                   @Nullable
                                                   String description)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " firstName"

Returns:

a Matcher that will take an String as a parameter

contains

public static <T> org.hamcrest.Matcher<T> contains(String ref,
                                                   @Nullable
                                                   String description)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " firstName"

Returns:

a Matcher that will take an String as a parameter

contains

public static <T> org.hamcrest.Matcher<T> contains(String ref)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an String as a parameter

doesntContain

public static <T> org.hamcrest.Matcher<T> doesntContain(String ref,
                                                        @Nullable
                                                        String description)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

description - the name of the value, for instance " firstName"

Returns:

a Matcher that will take an String as a parameter

doesntContain

public static <T> org.hamcrest.Matcher<T> doesntContain(String ref)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

ref - the reference value

Returns:

a Matcher that will take an String as a parameter

isIn

public static <T> org.hamcrest.Matcher<T> isIn(String[] ref)

isIn

public static <T> org.hamcrest.Matcher<T> isIn(String[] ref,
                                               @Nullable
                                               String description)

isIn

public static <T> org.hamcrest.Matcher<T> isIn(String methodName,
                                               Object[] ref)

isIn

public static <T> org.hamcrest.Matcher<T> isIn(String methodName,
                                               Object[] ref,
                                               @Nullable
                                               String description)

isLowerCase

public static <T> org.hamcrest.Matcher<T> isLowerCase()

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Returns:

a Matcher that will take an String as a parameter

isLowerCase

public static <T> org.hamcrest.Matcher<T> isLowerCase(@Nullable
                                                      String description)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

description - the name of the value, for instance " firstName"

Returns:

a Matcher that will take an String as a parameter

isUpperCase

public static <T> org.hamcrest.Matcher<T> isUpperCase()

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Returns:

a Matcher that will take an String as a parameter

isUpperCase

public static <T> org.hamcrest.Matcher<T> isUpperCase(@Nullable
                                                      String description)

create a new constraint on an String.

Type Parameters:

T - the actual value's type

Parameters:

description - the name of the value, for instance " firstName"

Returns:

a Matcher that will take an String as a parameter

instanceOf

public static <T> org.hamcrest.Matcher<T> instanceOf(Class<?> c)

create a new constraint on an instance.

Type Parameters:

T - the actual value's type

Parameters:

c - the class the instance should be an instance of

Returns:

a Matcher that will take an file as a parameter

instanceOf

public static <T> org.hamcrest.Matcher<T> instanceOf(Class<?> c,
                                                     @Nullable
                                                     String description)

create a new constraint on an instance.

Type Parameters:

T - the actual value's type

Parameters:

c - the class the instance should be an instance of

description - the name the bvalue, for instance "firstName"

Returns:

a Matcher that will take an file as a parameter