org.exparity.hamcrest.date

Class IsWithin

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeDiagnosingMatcher<Date>

org.exparity.hamcrest.date.IsWithin

All Implemented Interfaces:

org.hamcrest.Matcher<Date>, org.hamcrest.SelfDescribing

public class IsWithin
extends org.hamcrest.TypeSafeDiagnosingMatcher<Date>

A matcher that tests that the examined date is within a defined period of the reference date

Author:

Stewart Bissett

Constructor Summary

Constructors

Constructor and Description
IsWithin(long period, TimeUnit unit, Date expected)

Method Summary

Methods

Modifier and Type	Method and Description
void	describeTo(org.hamcrest.Description description)
protected boolean	matchesSafely(Date actual, org.hamcrest.Description mismatchDesc)
static org.hamcrest.Matcher<Date>	within(long period, TimeUnit unit, Date date) Creates a matcher that matches when the examined date is within a given period of the reference date For example:
static org.hamcrest.Matcher<Date>	within(long period, TimeUnit unit, DayMonthYear date) Creates a matcher that matches when the examined date is within a given period of the reference date For example:
static org.hamcrest.Matcher<Date>	within(long period, TimeUnit unit, int year, Months month, int day) Creates a matcher that matches when the examined date is within a given period of the reference date For example:
static org.hamcrest.Matcher<Date>	within(long period, TimeUnit unit, int year, Months month, int date, int hour, int minute, int second, int milliseconds) Creates a matcher that matches when the examined date is within a given period of the reference date For example:

Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IsWithin

public IsWithin(long period,
        TimeUnit unit,
        Date expected)

Method Detail

matchesSafely

protected boolean matchesSafely(Date actual,
                    org.hamcrest.Description mismatchDesc)

Specified by:

matchesSafely in class org.hamcrest.TypeSafeDiagnosingMatcher<Date>

describeTo

public void describeTo(org.hamcrest.Description description)

within

public static org.hamcrest.Matcher<Date> within(long period,
                                TimeUnit unit,
                                Date date)

Creates a matcher that matches when the examined date is within a given period of the reference date

For example:

 assertThat(myDate, within(10, TimeUnit.MINUTES, new Date()))
 

Parameters:

period - the timeunit interval the examined date should be with

unit - the timeunit to define the length of the period

date - the reference date against which the examined date is checked

within

public static org.hamcrest.Matcher<Date> within(long period,
                                TimeUnit unit,
                                DayMonthYear date)

Creates a matcher that matches when the examined date is within a given period of the reference date

For example:

 assertThat(myDate, within(2, TimeUnit.DAYS, Moments.today()))
 

Parameters:

period - the timeunit interval the examined date should be with

unit - the timeunit to define the length of the period

date - the reference date against which the examined date is checked

within

public static org.hamcrest.Matcher<Date> within(long period,
                                TimeUnit unit,
                                int year,
                                Months month,
                                int day)

Creates a matcher that matches when the examined date is within a given period of the reference date

For example:

 assertThat(myDate, within(5, TimeUnit.DAYS, 2012, Months.MAY, 12));
 

Parameters:

period - the timeunit interval the examined date should be with

unit - the timeunit to define the length of the period

year - the year against which the examined date is checked

month - the month against which the examined date is checked

day - the day of the month against which the examined date is checked

within

public static org.hamcrest.Matcher<Date> within(long period,
                                TimeUnit unit,
                                int year,
                                Months month,
                                int date,
                                int hour,
                                int minute,
                                int second,
                                int milliseconds)

Creates a matcher that matches when the examined date is within a given period of the reference date

For example:

 assertThat(myDate, within(1, TimeUnit.MINUTES, 2012, Months.MAY, 12, 23, 00, 01));
 

Parameters:

period - the timeunit interval the examined date should be with

unit - the timeunit to define the length of the period

year - the year against which the examined date is checked

month - the month against which the examined date is checked

day - the day of the month against which the examined date is checked

hour - the hour of the day against which the examined date is checked

minute - the minute of the hour against which the examined date is checked

second - the second of the minute against which the examined date is checked

second - the millisecond of the second against which the examined date is checked