org.exparity.hamcrest.date.core.function

Class LocalDateTimeFunction

java.lang.Object

org.exparity.hamcrest.date.core.function.LocalDateTimeFunction

All Implemented Interfaces:

TemporalFunction<LocalDateTime>

public class LocalDateTimeFunction
extends Object
implements TemporalFunction<LocalDateTime>

Implementation of TemporalFunction for LocalDateTime objects.

Author:

Stewart Bissett

Constructor Summary

Constructors

Constructor and Description
LocalDateTimeFunction()

Method Summary

Modifier and Type	Method and Description
String	describe(LocalDateTime temporal, Locale locale) Describe a temporal type
Interval	interval(LocalDateTime expected, LocalDateTime other, ChronoUnit unit) Return the interval between two temporals
boolean	isAfter(LocalDateTime expected, LocalDateTime actual) Test if a temporal is after another temporal
boolean	isBefore(LocalDateTime expected, LocalDateTime actual) Test if a temporal is before another temporal
boolean	isSame(LocalDateTime expected, LocalDateTime 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

Constructor Detail

LocalDateTimeFunction

public LocalDateTimeFunction()

Method Detail

isAfter

public boolean isAfter(LocalDateTime expected,
                       LocalDateTime actual)

Description copied from interface: TemporalFunction

Test if a temporal is after another temporal

Specified by:

isAfter in interface TemporalFunction<LocalDateTime>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

Returns:

a boolean

isBefore

public boolean isBefore(LocalDateTime expected,
                        LocalDateTime actual)

Description copied from interface: TemporalFunction

Test if a temporal is before another temporal

Specified by:

isBefore in interface TemporalFunction<LocalDateTime>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

Returns:

a boolean

isSame

public boolean isSame(LocalDateTime expected,
                      LocalDateTime actual)

Description copied from interface: TemporalFunction

Test if a temporal is the same as another temporal

Specified by:

isSame in interface TemporalFunction<LocalDateTime>

Parameters:

expected - the temporal to test for

actual - the temporal to test against

Returns:

a boolean

interval

public Interval interval(LocalDateTime expected,
                         LocalDateTime other,
                         ChronoUnit unit)

Description copied from interface: TemporalFunction

Return the interval between two temporals

Specified by:

interval in interface TemporalFunction<LocalDateTime>

Parameters:

expected - the temporal to test for

other - the temporal to test against

unit - the unit to measure the interval in

Returns:

an Interval

describe

public String describe(LocalDateTime temporal,
                       Locale locale)

Description copied from interface: TemporalFunction

Describe a temporal type

Specified by:

describe in interface TemporalFunction<LocalDateTime>

Parameters:

temporal - the temporal instance to describe

locale - the locale to describe the temporal in

Returns:

a string description of the temporal