org.assertj.core.api

Class AbstractLocalDateAssert<S extends AbstractLocalDateAssert<S>>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,LocalDate>

org.assertj.core.api.AbstractLocalDateAssert<S>

All Implemented Interfaces:

Assert<S,LocalDate>, Descriptable<S>, ExtensionPoints<S,LocalDate>

Direct Known Subclasses:

LocalDateAssert

public abstract class AbstractLocalDateAssert<S extends AbstractLocalDateAssert<S>>
extends AbstractAssert<S,LocalDate>

Assertions for LocalDate type from new Date & Time API introduced in Java 8.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_LOCAL_DATE_TIME_PARAMETER_MESSAGE

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLocalDateAssert(LocalDate actual, Class<?> selfType) Creates a new AbstractLocalDateAssert.

Method Summary

Modifier and Type	Method and Description
protected LocalDate	getActual()
S	isAfter(LocalDate other) Verifies that the actual LocalDate is strictly after the given one.
S	isAfter(String localDateTimeAsString) Same assertion as isAfter(LocalDate) but the LocalDate is built from given a String that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isAfterOrEqualTo(LocalDate other) Verifies that the actual LocalDate is after or equals to the given one.
S	isAfterOrEqualTo(String localDateTimeAsString) Same assertion as isAfterOrEqualTo(LocalDate) but the LocalDate is built from given String, which must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isBefore(LocalDate other) Verifies that the actual LocalDate is strictly before the given one.
S	isBefore(String localDateTimeAsString) Same assertion as isBefore(LocalDate) but the LocalDate is built from given String, which must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isBeforeOrEqualTo(LocalDate other) Verifies that the actual LocalDate is before or equals to the given one.
S	isBeforeOrEqualTo(String localDateTimeAsString) Same assertion as isBeforeOrEqualTo(LocalDate) but the LocalDate is built from given String, which must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isEqualTo(String dateTimeAsString) Same assertion as AbstractAssert.isEqualTo(Object) (where Object is expected to be LocalDate) but here you pass LocalDate String representation that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isIn(String... dateTimesAsString) Same assertion as AbstractAssert.isIn(Object...) (where Objects are expected to be LocalDate) but here you pass LocalDate String representations that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isNotEqualTo(String dateTimeAsString) Same assertion as AbstractAssert.isNotEqualTo(Object) (where Object is expected to be LocalDate) but here you pass LocalDate String representation that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isNotIn(String... dateTimesAsString) Same assertion as AbstractAssert.isNotIn(Object...) (where Objects are expected to be LocalDate) but here you pass LocalDate String representations that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.
S	isToday() Verifies that the actual LocalDate is today, that is matching current year, month and day.

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

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, 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, overridingErrorMessage, satisfies, setCustomRepresentation, throwAssertionError, usingComparator, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Field Detail

NULL_LOCAL_DATE_TIME_PARAMETER_MESSAGE

public static final String NULL_LOCAL_DATE_TIME_PARAMETER_MESSAGE

See Also:

Constant Field Values

Constructor Detail

AbstractLocalDateAssert

protected AbstractLocalDateAssert(LocalDate actual,
                                  Class<?> selfType)

Creates a new AbstractLocalDateAssert.

Parameters:

selfType - the "self type"

actual - the actual value to verify

Method Detail

getActual

protected LocalDate getActual()

isBefore

public S isBefore(LocalDate other)

Verifies that the actual LocalDate is strictly before the given one.

Example :

 assertThat(parse("2000-01-01")).isBefore(parse("2000-01-02"));

Parameters:

other - the given LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if other LocalDate is null.

AssertionError - if the actual LocalDate is not strictly before the given one.

isBefore

public S isBefore(String localDateTimeAsString)

Same assertion as isBefore(LocalDate) but the LocalDate is built from given String, which must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use directly String in comparison to avoid writing the code to perform the conversion
 assertThat(parse("2000-01-01")).isBefore("2000-01-02");

Parameters:

localDateTimeAsString - String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is not strictly before the LocalDate built from given String.

isBeforeOrEqualTo

public S isBeforeOrEqualTo(LocalDate other)

Verifies that the actual LocalDate is before or equals to the given one.

Example :

 assertThat(parse("2000-01-01")).isBeforeOrEqualTo(parse("2000-01-01"))
                                .isBeforeOrEqualTo(parse("2000-01-02"));

Parameters:

other - the given LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if other LocalDate is null.

AssertionError - if the actual LocalDate is not before or equals to the given one.

isBeforeOrEqualTo

public S isBeforeOrEqualTo(String localDateTimeAsString)

Same assertion as isBeforeOrEqualTo(LocalDate) but the LocalDate is built from given String, which must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use String in comparison to avoid conversion
 assertThat(parse("2000-01-01")).isBeforeOrEqualTo("2000-01-01")
                                .isBeforeOrEqualTo("2000-01-02");

Parameters:

localDateTimeAsString - String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is not before or equals to the LocalDate built from given String.

isAfterOrEqualTo

public S isAfterOrEqualTo(LocalDate other)

Verifies that the actual LocalDate is after or equals to the given one.

Example :

 assertThat(parse("2000-01-01")).isAfterOrEqualTo(parse("2000-01-01"))
                                .isAfterOrEqualTo(parse("1999-12-31"));

Parameters:

other - the given LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if other LocalDate is null.

AssertionError - if the actual LocalDate is not after or equals to the given one.

isAfterOrEqualTo

public S isAfterOrEqualTo(String localDateTimeAsString)

Same assertion as isAfterOrEqualTo(LocalDate) but the LocalDate is built from given String, which must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use String in comparison to avoid conversion
 assertThat(parse("2000-01-01")).isAfterOrEqualTo("2000-01-01")
                                .isAfterOrEqualTo("1999-12-31");

Parameters:

localDateTimeAsString - String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is not after or equals to the LocalDate built from given String.

isAfter

public S isAfter(LocalDate other)

Verifies that the actual LocalDate is strictly after the given one.

Example :

 assertThat(parse("2000-01-01")).isAfter(parse("1999-12-31"));

Parameters:

other - the given LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if other LocalDate is null.

AssertionError - if the actual LocalDate is not strictly after the given one.

isAfter

public S isAfter(String localDateTimeAsString)

Same assertion as isAfter(LocalDate) but the LocalDate is built from given a String that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use String in comparison to avoid conversion
 assertThat(parse("2000-01-01")).isAfter("1999-12-31");

Parameters:

localDateTimeAsString - String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is not strictly after the LocalDate built from given String.

isEqualTo

public S isEqualTo(String dateTimeAsString)

Same assertion as AbstractAssert.isEqualTo(Object) (where Object is expected to be LocalDate) but here you pass LocalDate String representation that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use directly String in comparison to avoid writing the code to perform the conversion
 assertThat(parse("2000-01-01")).isEqualTo("2000-01-01");

Parameters:

dateTimeAsString - String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is not equal to the LocalDate built from given String.

isNotEqualTo

public S isNotEqualTo(String dateTimeAsString)

Same assertion as AbstractAssert.isNotEqualTo(Object) (where Object is expected to be LocalDate) but here you pass LocalDate String representation that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use directly String in comparison to avoid writing the code to perform the conversion
 assertThat(parse("2000-01-01")).isNotEqualTo("2000-01-15");

Parameters:

dateTimeAsString - String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is equal to the LocalDate built from given String.

isIn

public S isIn(String... dateTimesAsString)

Same assertion as AbstractAssert.isIn(Object...) (where Objects are expected to be LocalDate) but here you pass LocalDate String representations that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use String based representation of LocalDate
 assertThat(parse("2000-01-01")).isIn("1999-12-31", "2000-01-01");

Parameters:

dateTimesAsString - String array representing LocalDates.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is not in the LocalDates built from given Strings.

isNotIn

public S isNotIn(String... dateTimesAsString)

Same assertion as AbstractAssert.isNotIn(Object...) (where Objects are expected to be LocalDate) but here you pass LocalDate String representations that must follow ISO LocalDate format to allow calling LocalDate.parse(CharSequence) method.

Example :

 // use String based representation of LocalDate
 assertThat(parse("2000-01-01")).isNotIn("1999-12-31", "2000-01-02");

Parameters:

dateTimesAsString - Array of String representing a LocalDate.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

IllegalArgumentException - if given String is null or can't be converted to a LocalDate.

AssertionError - if the actual LocalDate is in the LocalDates built from given Strings.

isToday

public S isToday()

Verifies that the actual LocalDate is today, that is matching current year, month and day.

Example:

 // assertion will pass
 assertThat(LocalDate.now()).isToday();

 // assertion will fail
 assertThat(theFellowshipOfTheRing.getReleaseDate()).isToday();

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDate is null.

AssertionError - if the actual LocalDate is not today.