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

Class InstantFunction

java.lang.Object

org.exparity.hamcrest.date.core.function.InstantFunction

All Implemented Interfaces:

TemporalFunction<Instant>

public final class InstantFunction
extends Object
implements TemporalFunction<Instant>

Implementation of TemporalFunction for Instant

Constructor Summary

Constructors

Constructor	Description
InstantFunction()

Method Summary

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

InstantFunction

public InstantFunction()

Method Detail

isSame

public boolean isSame(Instant temporal,
                      Instant other)

Description copied from interface: TemporalFunction

Test if a temporal is the same as another temporal

Specified by:

isSame in interface TemporalFunction<Instant>

Parameters:

temporal - the temporal to test for

other - the temporal to test against

Returns:

a boolean

isAfter

public boolean isAfter(Instant temporal,
                       Instant other)

Description copied from interface: TemporalFunction

Test if a temporal is after another temporal

Specified by:

isAfter in interface TemporalFunction<Instant>

Parameters:

temporal - the temporal to test for

other - the temporal to test against

Returns:

a boolean

isBefore

public boolean isBefore(Instant temporal,
                        Instant other)

Description copied from interface: TemporalFunction

Test if a temporal is before another temporal

Specified by:

isBefore in interface TemporalFunction<Instant>

Parameters:

temporal - the temporal to test for

other - the temporal to test against

Returns:

a boolean

interval

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

Description copied from interface: TemporalFunction

Return the interval between two temporals

Specified by:

interval in interface TemporalFunction<Instant>

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(Instant temporal,
                       Locale locale)

Description copied from interface: TemporalFunction

Describe a temporal type

Specified by:

describe in interface TemporalFunction<Instant>

Parameters:

temporal - the temporal instance to describe

locale - the locale to describe the temporal in

Returns:

a string description of the temporal