Package org.assertj.core.api

Class AbstractTemporalAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,TEMPORAL>

org.assertj.core.api.AbstractTemporalAssert<SELF,TEMPORAL>

All Implemented Interfaces:

Assert<SELF,TEMPORAL>, Descriptable<SELF>, ExtensionPoints<SELF,TEMPORAL>

Direct Known Subclasses:

AbstractInstantAssert, AbstractLocalDateAssert, AbstractLocalDateTimeAssert, AbstractLocalTimeAssert, AbstractOffsetDateTimeAssert, AbstractOffsetTimeAssert, AbstractZonedDateTimeAssert

public abstract class AbstractTemporalAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
extends AbstractAssert<SELF,TEMPORAL>

Base class for all implementations of assertions for Temporals.

Since:

3.7.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Comparables	comparables

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, assertionErrorCreator, conditions, info, myself, objects, throwUnsupportedExceptionOnEquals

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTemporalAssert(TEMPORAL actual, Class<?> selfType)	Creates a new AbstractTemporalAssert.

Method Summary

Modifier and Type	Method	Description
protected TEMPORAL	getActual()
SELF	isCloseTo(String otherAsString, TemporalOffset<? super TEMPORAL> offset)	Same assertion as isCloseTo(Temporal, TemporalOffset) but the TEMPORAL is built from a given String that follows predefined ISO date format Predefined Formatters to allow calling parse(String))} method.
SELF	isCloseTo(TEMPORAL other, TemporalOffset<? super TEMPORAL> offset)	Verifies that the actual Temporal is close to the other according to the given TemporalOffset.
protected abstract TEMPORAL	parse(String temporalAsString)	Obtains an instance of TEMPORAL from a string representation in ISO date format.

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, asInstanceOf, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, setCustomRepresentation, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, withAssertionState, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Field Detail

comparables

Comparables comparables

Constructor Detail

AbstractTemporalAssert

protected AbstractTemporalAssert(TEMPORAL actual,
                                 Class<?> selfType)

Creates a new AbstractTemporalAssert.

Parameters:

selfType - the "self type"

actual - the actual value to verify

Method Detail

getActual

protected TEMPORAL getActual()

isCloseTo

public SELF isCloseTo(TEMPORAL other,
                      TemporalOffset<? super TEMPORAL> offset)

Verifies that the actual Temporal is close to the other according to the given TemporalOffset.

You can build the offset parameter using Assertions.within(long, TemporalUnit) or Assertions.byLessThan(long, TemporalUnit).

Example:

 LocalTime _07_10 = LocalTime.of(7, 10);
 LocalTime _07_42 = LocalTime.of(7, 42);

 // assertions will pass
 assertThat(_07_10).isCloseTo(_07_42, within(1, ChronoUnit.HOURS));
 assertThat(_07_10).isCloseTo(_07_42, within(32, ChronoUnit.MINUTES));

 // assertions will fail
 assertThat(_07_10).isCloseTo(_07_42, byLessThan(32, ChronoUnit.MINUTES));
 assertThat(_07_10).isCloseTo(_07_42, within(10, ChronoUnit.SECONDS));

Parameters:

other - the temporal to compare actual to

offset - the offset used for comparison

Returns:

this assertion object

Throws:

NullPointerException - if Temporal or TemporalOffset parameter is null.

AssertionError - if the actual Temporal is null.

AssertionError - if the actual Temporal is not close to the given for a provided offset.

isCloseTo

public SELF isCloseTo(String otherAsString,
                      TemporalOffset<? super TEMPORAL> offset)

Same assertion as isCloseTo(Temporal, TemporalOffset) but the TEMPORAL is built from a given String that follows predefined ISO date format Predefined Formatters to allow calling parse(String))} method.

Example :

 assertThat(LocalTime.parse("07:10:30")).isCloseTo("07:12:11", within(5, ChronoUnit.MINUTES));

Parameters:

otherAsString - String representing a TEMPORAL.

offset - the offset used for comparison

Returns:

this assertion object.

Throws:

AssertionError - if the actual Temporal is null.

NullPointerException - if temporal string representation or TemporalOffset parameter is null.

AssertionError - if the actual Temporal is null.

AssertionError - if the actual Temporal is not close to the given for a provided offset.

parse

protected abstract TEMPORAL parse(String temporalAsString)

Obtains an instance of TEMPORAL from a string representation in ISO date format.

Parameters:

temporalAsString - the string to parse, not null

Returns:

the parsed TEMPORAL, not null