org.exparity.hamcrest.date

Class LocalDateMatchers

java.lang.Object

org.exparity.hamcrest.date.LocalDateMatchers

public abstract class LocalDateMatchers
extends Object

Static factory for creating Matcher instances for comparing LocalDate instances

Author:

Stewart Bissett

Constructor Summary

Constructors

Constructor and Description
LocalDateMatchers()

Method Summary

Modifier and Type	Method and Description
static DateMatcher<LocalDate>	after(int year, Month month, int dayOfMonth) Creates a matcher that matches when the examined date is after the end of the reference year For example:
static DateMatcher<LocalDate>	after(LocalDate date) Creates a matcher that matches when the examined date is after the reference date For example:
static DateMatcher<LocalDate>	before(int year, Month month, int dayOfMonth) Creates a matcher that matches when the examined date is before the end of the reference year For example:
static DateMatcher<LocalDate>	before(LocalDate date) Creates a matcher that matches when the examined date is before the reference date For example:
static DateMatcher<LocalDate>	isApril() Creates a matcher that matches when the examined date is in April For example:
static DateMatcher<LocalDate>	isAugust() Creates a matcher that matches when the examined date is in August For example:
static DateMatcher<LocalDate>	isDay(int year, Month month, int dayOfMonth) Creates a matcher that matches when the examined date is on the same day of the year as the reference date For example:
static DateMatcher<LocalDate>	isDayOfMonth(int dayOfMonth) Creates a matcher that matches when the examined date is on the expected day of the month For example:
static DateMatcher<LocalDate>	isDayOfWeek(DayOfWeek... daysOfWeek) Creates a matcher that matches when the examined date is on a monday For example:
static DateMatcher<LocalDate>	isDayOfWeek(DayOfWeek dayOfWeek) Creates a matcher that matches when the examined date is on a monday For example:
static DateMatcher<LocalDate>	isDecember() Creates a matcher that matches when the examined date is in December For example:
static DateMatcher<LocalDate>	isFebruary() Creates a matcher that matches when the examined date is in February For example:
static DateMatcher<LocalDate>	isFirstDayOfMonth() Creates a matcher that matches when the examined date is on the first day of the month For example:
static DateMatcher<LocalDate>	isFriday() Creates a matcher that matches when the examined date is on a friday For example:
static DateMatcher<LocalDate>	isJanuary() Creates a matcher that matches when the examined date is in January For example:
static DateMatcher<LocalDate>	isJuly() Creates a matcher that matches when the examined date is in July For example:
static DateMatcher<LocalDate>	isJune() Creates a matcher that matches when the examined date is in June For example:
static DateMatcher<LocalDate>	isLastDayOfMonth() Creates a matcher that matches when the examined date is on the first day of the month For example:
static DateMatcher<LocalDate>	isLeapYear() Creates a matcher that matches when the examined date is a leap year For example:
static DateMatcher<LocalDate>	isMarch() Creates a matcher that matches when the examined date is in March For example:
static DateMatcher<LocalDate>	isMaximum(ChronoField field) Creates a matcher that matches when the examined date is on the maximum value of the given date part in its period For example:
static DateMatcher<LocalDate>	isMay() Creates a matcher that matches when the examined date is in May For example:
static DateMatcher<LocalDate>	isMinimum(ChronoField field) Creates a matcher that matches when the examined date is on the maximum value of the given date part in its period For example:
static DateMatcher<LocalDate>	isMonday() Creates a matcher that matches when the examined date is on a monday For example:
static DateMatcher<LocalDate>	isMonth(Month month) Creates a matcher that matches when the examined date is in the expected month For example:
static DateMatcher<LocalDate>	isNovember() Creates a matcher that matches when the examined date is in November For example:
static DateMatcher<LocalDate>	isOctober() Creates a matcher that matches when the examined date is in October For example:
static DateMatcher<LocalDate>	isSaturday() Creates a matcher that matches when the examined date is on a saturday For example:
static DateMatcher<LocalDate>	isSeptember() Creates a matcher that matches when the examined date is in September For example:
static DateMatcher<LocalDate>	isSunday() Creates a matcher that matches when the examined date is on a sunday For example:
static DateMatcher<LocalDate>	isThursday() Creates a matcher that matches when the examined date is on a thursday For example:
static DateMatcher<LocalDate>	isToday() Creates a matcher that matches when the examined date is today For example:
static DateMatcher<LocalDate>	isTomorrow() Creates a matcher that matches when the examined date is tomorrow For example:
static DateMatcher<LocalDate>	isTuesday() Creates a matcher that matches when the examined date is on a tuesday For example:
static DateMatcher<LocalDate>	isWednesday() Creates a matcher that matches when the examined date is on a wednesday For example:
static DateMatcher<LocalDate>	isWeekday() Creates a matcher that matches when the examined date is on a weekday For example:
static DateMatcher<LocalDate>	isWeekend() Creates a matcher that matches when the examined date is on a weekend For example:
static DateMatcher<LocalDate>	isYear(int year) Creates a matcher that matches when the examined date is on the same year as the reference year For example:
static DateMatcher<LocalDate>	isYesterday() Creates a matcher that matches when the examined date is yesterday For example:
static DateMatcher<LocalDate>	sameDay(LocalDate date) Creates a matcher that matches when the examined date is on the same day of the year as the reference date For example:
static DateMatcher<LocalDate>	sameDayOfMonth(LocalDate date) Creates a matcher that matches when the examined date is on the same day of the month as the reference date For example:
static DateMatcher<LocalDate>	sameDayOfWeek(LocalDate date) Creates a matcher that matches when the examined date is on the same day of the week as the reference date For example:
static DateMatcher<LocalDate>	sameMonthOfYear(LocalDate date) Creates a matcher that matches when the examined date is on the same month as the reference date For example:
static DateMatcher<LocalDate>	sameOrAfter(int year, Month month, int day) Creates a matcher that matches when the examined date is on the same day or after the start of the reference date For example:
static DateMatcher<LocalDate>	sameOrAfter(LocalDate date) Creates a matcher that matches when the examined date is at the same instant or after the reference date For example:
static DateMatcher<LocalDate>	sameOrBefore(int year, Month month, int day) Creates a matcher that matches when the examined date is on the same day or before the start of the reference date For example:
static DateMatcher<LocalDate>	sameOrBefore(LocalDate date) Creates a matcher that matches when the examined date is at the same instant or before the reference date For example:
static DateMatcher<LocalDate>	sameYear(LocalDate date) Creates a matcher that matches when the examined date is on the same year as the reference date For example:
static DateMatcher<LocalDate>	within(long period, ChronoUnit unit, int year, Month month, int dayofMonth) Creates a matcher that matches when the examined date is within a given period of the reference date For example:
static DateMatcher<LocalDate>	within(long period, ChronoUnit unit, LocalDate date) Creates a matcher that matches when the examined date is within a defined period the reference date For example:

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDateMatchers

public LocalDateMatchers()

Method Detail

after

public static DateMatcher<LocalDate> after(LocalDate date)

Creates a matcher that matches when the examined date is after the reference date

For example:

 MatcherAssert.assertThat(myDate, LocalDateMatchers.after(LocalDate.now()));
 

Parameters:

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

after

public static DateMatcher<LocalDate> after(int year,
                                           Month month,
                                           int dayOfMonth)

Creates a matcher that matches when the examined date is after the end of the reference year

For example:

 MatcherAssert.assertThat(myDate, LocalDateMatchers.after(2012, Month.MAY, 12));
 

Parameters:

year - the year against which the examined date is checked

month - the month against which the examined date is checked

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

before

public static DateMatcher<LocalDate> before(LocalDate date)

Creates a matcher that matches when the examined date is before the reference date

For example:

 MatcherAssert.assertThat(myDate, LocalDateMatchers.before(LocalDate.now()));
 

Parameters:

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

before

public static DateMatcher<LocalDate> before(int year,
                                            Month month,
                                            int dayOfMonth)

Creates a matcher that matches when the examined date is before the end of the reference year

For example:

 MatcherAssert.assertThat(myDate, LocalDateMatchers.before(2012, Month.MAY, 12));
 

Parameters:

year - the year against which the examined date is checked

month - the month against which the examined date is checked

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

sameDay

public static DateMatcher<LocalDate> sameDay(LocalDate date)

Creates a matcher that matches when the examined date is on the same day of the year as the reference date

For example:

 assertThat(myDate, sameDay(LocalDate.now()));
 

Parameters:

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

isDay

public static DateMatcher<LocalDate> isDay(int year,
                                           Month month,
                                           int dayOfMonth)

Creates a matcher that matches when the examined date is on the same day of the year as the reference date

For example:

 assertThat(myDate, isDay(2012, Month.JAN, 1))
 

Parameters:

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

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

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

sameOrBefore

public static DateMatcher<LocalDate> sameOrBefore(LocalDate date)

Creates a matcher that matches when the examined date is at the same instant or before the reference date

For example:

 assertThat(myDate, isSameOrBefore(new Date()))
 

Parameters:

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

sameOrBefore

public static DateMatcher<LocalDate> sameOrBefore(int year,
                                                  Month month,
                                                  int day)

Creates a matcher that matches when the examined date is on the same day or before the start of the reference date

For example:

 assertThat(myDate, isSameOrBefore(2012, Months.MAY, 12));
 

Parameters:

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

sameOrAfter

public static DateMatcher<LocalDate> sameOrAfter(LocalDate date)

Creates a matcher that matches when the examined date is at the same instant or after the reference date

For example:

 assertThat(myDate, isSameOrAfter(new Date()))
 

Parameters:

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

sameOrAfter

public static DateMatcher<LocalDate> sameOrAfter(int year,
                                                 Month month,
                                                 int day)

Creates a matcher that matches when the examined date is on the same day or after the start of the reference date

For example:

 assertThat(myDate, isSameOrAfter(2012, Months.MAY, 12));
 

Parameters:

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

sameMonthOfYear

public static DateMatcher<LocalDate> sameMonthOfYear(LocalDate date)

Creates a matcher that matches when the examined date is on the same month as the reference date

For example:

 assertThat(myDate, sameMonth(new Date()))
 

Parameters:

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

sameDayOfMonth

public static DateMatcher<LocalDate> sameDayOfMonth(LocalDate date)

Creates a matcher that matches when the examined date is on the same day of the month as the reference date

For example:

 assertThat(myDate, sameDayOfMonth(new Date()))
 

Parameters:

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

isDayOfMonth

public static DateMatcher<LocalDate> isDayOfMonth(int dayOfMonth)

Creates a matcher that matches when the examined date is on the expected day of the month

For example:

 assertThat(myDate, isDayOfMonth(4))
 

Parameters:

dayOfMonth - the expected day of the month

sameYear

public static DateMatcher<LocalDate> sameYear(LocalDate date)

Creates a matcher that matches when the examined date is on the same year as the reference date

For example:

 assertThat(myDate, sameYear(new Date()))
 

Parameters:

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

isYear

public static DateMatcher<LocalDate> isYear(int year)

Creates a matcher that matches when the examined date is on the same year as the reference year

For example:

 assertThat(myDate, sameYear(2013))
 

Parameters:

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

within

public static DateMatcher<LocalDate> within(long period,
                                            ChronoUnit unit,
                                            LocalDate date)

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

For example:

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

Parameters:

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

within

public static DateMatcher<LocalDate> within(long period,
                                            ChronoUnit unit,
                                            int year,
                                            Month month,
                                            int dayofMonth)

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

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

isYesterday

public static DateMatcher<LocalDate> isYesterday()

Creates a matcher that matches when the examined date is yesterday

For example:

 assertThat(myDate, isToday());
 

isToday

public static DateMatcher<LocalDate> isToday()

Creates a matcher that matches when the examined date is today

For example:

 assertThat(myDate, isToday());
 

isTomorrow

public static DateMatcher<LocalDate> isTomorrow()

Creates a matcher that matches when the examined date is tomorrow

For example:

 assertThat(myDate, isTomorrow());
 

sameDayOfWeek

public static DateMatcher<LocalDate> sameDayOfWeek(LocalDate date)

Creates a matcher that matches when the examined date is on the same day of the week as the reference date

For example:

 assertThat(myDate, sameDayOfWeek(LocalDate.now()))
 

Parameters:

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

isDayOfWeek

public static DateMatcher<LocalDate> isDayOfWeek(DayOfWeek dayOfWeek)

Creates a matcher that matches when the examined date is on a monday

For example:

 assertThat(myDate, isMonday());
 

isDayOfWeek

public static DateMatcher<LocalDate> isDayOfWeek(DayOfWeek... daysOfWeek)

Creates a matcher that matches when the examined date is on a monday

For example:

 assertThat(myDate, isMonday());
 

isMonday

public static DateMatcher<LocalDate> isMonday()

Creates a matcher that matches when the examined date is on a monday

For example:

 assertThat(myDate, isMonday());
 

isTuesday

public static DateMatcher<LocalDate> isTuesday()

Creates a matcher that matches when the examined date is on a tuesday

For example:

 assertThat(myDate, isTuesday());
 

isWednesday

public static DateMatcher<LocalDate> isWednesday()

Creates a matcher that matches when the examined date is on a wednesday

For example:

 assertThat(myDate, isWednesday());
 

isThursday

public static DateMatcher<LocalDate> isThursday()

Creates a matcher that matches when the examined date is on a thursday

For example:

 assertThat(myDate, isThursday());
 

isFriday

public static DateMatcher<LocalDate> isFriday()

Creates a matcher that matches when the examined date is on a friday

For example:

 assertThat(myDate, isFriday());
 

isSaturday

public static DateMatcher<LocalDate> isSaturday()

Creates a matcher that matches when the examined date is on a saturday

For example:

 assertThat(myDate, isSaturday());
 

isSunday

public static DateMatcher<LocalDate> isSunday()

Creates a matcher that matches when the examined date is on a sunday

For example:

 assertThat(myDate, isSunday());
 

isWeekday

public static DateMatcher<LocalDate> isWeekday()

Creates a matcher that matches when the examined date is on a weekday

For example:

 assertThat(myDate, isWeekday());
 

isWeekend

public static DateMatcher<LocalDate> isWeekend()

Creates a matcher that matches when the examined date is on a weekend

For example:

 assertThat(myDate, isWeekend());
 

isFirstDayOfMonth

public static DateMatcher<LocalDate> isFirstDayOfMonth()

Creates a matcher that matches when the examined date is on the first day of the month

For example:

 assertThat(myDate, isFirstDayOfMonth());
 

isMinimum

public static DateMatcher<LocalDate> isMinimum(ChronoField field)

Creates a matcher that matches when the examined date is on the maximum value of the given date part in its period

For example:

 assertThat(myDate, isMaximumDayOfMonth(ChronoField.DAY_OF_MONTH));
 

Parameters:

field - the temporal field to check

isLastDayOfMonth

public static DateMatcher<LocalDate> isLastDayOfMonth()

Creates a matcher that matches when the examined date is on the first day of the month

For example:

 assertThat(myDate, isFirstDayOfMonth());
 

isMaximum

public static DateMatcher<LocalDate> isMaximum(ChronoField field)

Creates a matcher that matches when the examined date is on the maximum value of the given date part in its period

For example:

 assertThat(myDate, isMaximum(ChronoField.DAY_OF_MONTH));
 

Parameters:

field - the temporal field to check

isMonth

public static DateMatcher<LocalDate> isMonth(Month month)

Creates a matcher that matches when the examined date is in the expected month

For example:

 assertThat(myDate, isMonth(Month.AUGUST));
 

isJanuary

public static DateMatcher<LocalDate> isJanuary()

Creates a matcher that matches when the examined date is in January

For example:

 assertThat(myDate, isJanuary());
 

isFebruary

public static DateMatcher<LocalDate> isFebruary()

Creates a matcher that matches when the examined date is in February

For example:

 assertThat(myDate, isFebruary());
 

isMarch

public static DateMatcher<LocalDate> isMarch()

Creates a matcher that matches when the examined date is in March

For example:

 assertThat(myDate, isMarch());
 

isApril

public static DateMatcher<LocalDate> isApril()

Creates a matcher that matches when the examined date is in April

For example:

 assertThat(myDate, isApril());
 

isMay

public static DateMatcher<LocalDate> isMay()

Creates a matcher that matches when the examined date is in May

For example:

 assertThat(myDate, isMay());
 

isJune

public static DateMatcher<LocalDate> isJune()

Creates a matcher that matches when the examined date is in June

For example:

 assertThat(myDate, isJune());
 

isJuly

public static DateMatcher<LocalDate> isJuly()

Creates a matcher that matches when the examined date is in July

For example:

 assertThat(myDate, isJuly());
 

isAugust

public static DateMatcher<LocalDate> isAugust()

Creates a matcher that matches when the examined date is in August

For example:

 assertThat(myDate, isAugust());
 

isSeptember

public static DateMatcher<LocalDate> isSeptember()

Creates a matcher that matches when the examined date is in September

For example:

 assertThat(myDate, isSeptember());
 

isOctober

public static DateMatcher<LocalDate> isOctober()

Creates a matcher that matches when the examined date is in October

For example:

 assertThat(myDate, isOctober());
 

isNovember

public static DateMatcher<LocalDate> isNovember()

Creates a matcher that matches when the examined date is in November

For example:

 assertThat(myDate, isNovember());
 

isDecember

public static DateMatcher<LocalDate> isDecember()

Creates a matcher that matches when the examined date is in December

For example:

 assertThat(myDate, isDecember());
 

isLeapYear

public static DateMatcher<LocalDate> isLeapYear()

Creates a matcher that matches when the examined date is a leap year

For example:

 assertThat(myDate, isLeapYear());