Package org.exparity.hamcrest.date.core.function

Class DateFunction

java.lang.Object

org.exparity.hamcrest.date.core.function.DateFunction

All Implemented Interfaces:

TemporalFunction<Date>

public class DateFunction
extends Object
implements TemporalFunction<Date>

Implementation of TemporalFunction to wrap Date objects.

Author:

Stewart Bissett

Field Summary

Fields

Modifier and Type	Field	Description
static String	JAVA_SQL_DATE_UNIT

Constructor Summary

Constructors

Constructor	Description
DateFunction()

Method Summary

Modifier and Type	Method	Description
String	describe(Date temporal, Locale locale)	Describe a temporal type
Interval	interval(Date expected, Date actual, ChronoUnit unit)	Return the interval between two temporals
boolean	isAfter(Date expected, Date actual)	Test if a temporal is after another temporal
boolean	isBefore(Date expected, Date actual)	Test if a temporal is before another temporal
boolean	isSame(Date expected, Date actual)	Test if a temporal is the same as another temporal

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_SQL_DATE_UNIT

public static final String JAVA_SQL_DATE_UNIT

See Also:

Constant Field Values

Constructor Detail

DateFunction

public DateFunction()

Method Detail

isAfter

public boolean isAfter(Date expected,
                       Date actual)

Description copied from interface: TemporalFunction

Test if a temporal is after another temporal

Specified by:

isAfter in interface TemporalFunction<Date>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

Returns:

a boolean

isBefore

public boolean isBefore(Date expected,
                        Date actual)

Description copied from interface: TemporalFunction

Test if a temporal is before another temporal

Specified by:

isBefore in interface TemporalFunction<Date>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

Returns:

a boolean

isSame

public boolean isSame(Date expected,
                      Date actual)

Description copied from interface: TemporalFunction

Test if a temporal is the same as another temporal

Specified by:

isSame in interface TemporalFunction<Date>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

Returns:

a boolean

interval

public Interval interval(Date expected,
                         Date actual,
                         ChronoUnit unit)

Description copied from interface: TemporalFunction

Return the interval between two temporals

Specified by:

interval in interface TemporalFunction<Date>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

unit - the unit to measure the interval in

Returns:

an Interval

describe

public String describe(Date temporal,
                       Locale locale)

Description copied from interface: TemporalFunction

Describe a temporal type

Specified by:

describe in interface TemporalFunction<Date>

Parameters:

temporal - the temporal instance to describe

locale - the locale to describe the temporal in

Returns:

a string description of the temporal