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 forTemporal
s.- Since:
- 3.7.0
-
-
Field Summary
Fields Modifier and Type Field Description (package private) org.assertj.core.internal.Comparables
comparables
-
Fields inherited from class org.assertj.core.api.AbstractAssert
actual, assertionErrorCreator, conditions, customRepresentation, info, myself, objects, printAssertionsDescription, throwUnsupportedExceptionOnEquals
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractTemporalAssert(TEMPORAL actual, Class<?> selfType)
Creates a new
.AbstractTemporalAssert
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected TEMPORAL
getActual()
SELF
isCloseTo(String otherAsString, TemporalOffset<? super TEMPORAL> offset)
Same assertion asisCloseTo(Temporal, TemporalOffset)
but theTEMPORAL
is built from a given String that follows predefined ISO date format Predefined Formatters to allow callingparse(String)
)} method.SELF
isCloseTo(TEMPORAL other, TemporalOffset<? super TEMPORAL> offset)
Verifies that the actualTemporal
is close to the other according to the givenTemporalOffset
.protected abstract TEMPORAL
parse(String temporalAsString)
Obtains an instance ofTEMPORAL
from a string representation in ISO date format.SELF
usingComparator(Comparator<? super TEMPORAL> customComparator)
Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.SELF
usingComparator(Comparator<? super TEMPORAL> customComparator, String customComparatorDescription)
Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.SELF
usingDefaultComparator()
Revert to standard comparison for the incoming assertion checks.-
Methods inherited from class org.assertj.core.api.AbstractAssert
asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingRecursiveComparison, usingRecursiveComparison, withAssertionState, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.assertj.core.api.Descriptable
as, as, as, describedAs
-
-
-
-
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 actualTemporal
is close to the other according to the givenTemporalOffset
.You can build the offset parameter using
Assertions.within(long, TemporalUnit)
orAssertions.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 tooffset
- the offset used for comparison- Returns:
- this assertion object
- Throws:
NullPointerException
- ifTemporal
orTemporalOffset
parameter isnull
.AssertionError
- if the actualTemporal
isnull
.AssertionError
- if the actualTemporal
is not close to the given for a provided offset.
-
isCloseTo
public SELF isCloseTo(String otherAsString, TemporalOffset<? super TEMPORAL> offset)
Same assertion asisCloseTo(Temporal, TemporalOffset)
but theTEMPORAL
is built from a given String that follows predefined ISO date format Predefined Formatters to allow callingparse(String)
)} method.Example :
assertThat(LocalTime.parse("07:10:30")).isCloseTo("07:12:11", within(5, ChronoUnit.MINUTES));
- Parameters:
otherAsString
- String representing aTEMPORAL
.offset
- the offset used for comparison- Returns:
- this assertion object.
- Throws:
AssertionError
- if the actualTemporal
isnull
.NullPointerException
- if temporal string representation orTemporalOffset
parameter isnull
.AssertionError
- if the actualTemporal
isnull
.AssertionError
- if the actualTemporal
is not close to the given for a provided offset.
-
parse
protected abstract TEMPORAL parse(String temporalAsString)
Obtains an instance ofTEMPORAL
from a string representation in ISO date format.- Parameters:
temporalAsString
- the string to parse, not null- Returns:
- the parsed
TEMPORAL
, not null
-
usingComparator
public SELF usingComparator(Comparator<? super TEMPORAL> customComparator)
Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam);
- Specified by:
usingComparator
in interfaceAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
- Overrides:
usingComparator
in classAbstractAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
- Parameters:
customComparator
- the comparator to use for the incoming assertion checks.- Returns:
this
assertion object.
-
usingComparator
public SELF usingComparator(Comparator<? super TEMPORAL> customComparator, String customComparatorDescription)
Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator, "Hobbit Race Comparator").isEqualTo(sam);
- Specified by:
usingComparator
in interfaceAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
- Overrides:
usingComparator
in classAbstractAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
- Parameters:
customComparator
- the comparator to use for the incoming assertion checks.customComparatorDescription
- comparator description to be used in assertion error messages- Returns:
this
assertion object.
-
usingDefaultComparator
public SELF usingDefaultComparator()
Revert to standard comparison for the incoming assertion checks.This method should be used to disable a custom comparison strategy set by calling
usingComparator
.- Specified by:
usingDefaultComparator
in interfaceAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
- Overrides:
usingDefaultComparator
in classAbstractAssert<SELF extends AbstractTemporalAssert<SELF,TEMPORAL>,TEMPORAL extends Temporal>
- Returns:
this
assertion object.
-
-