public abstract Class AbstractLocalDateAssert<SELF extends AbstractLocalDateAssert<SELF>>

Verifies that actual LocalDate is on the given day.

Example:

 // Assertion succeeds:
assertThat(LocalDate.of(2000, 12, 31)).hasDayOfMonth(31);

// Assertion fails:
assertThat(LocalDate.of(2000, 12, 31)).hasDayOfMonth(1);

Parameters

day:int

the given numeric day.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not on the given day.

Since

3.23.0

Verifies that actual LocalDate is in the given month.

Example:

 // Assertion succeeds:
assertThat(LocalDate.of(2000, 12, 31)).hasMonth(Month.DECEMBER);

// Assertion fails:
assertThat(LocalDate.of(2000, 12, 31)).hasMonth(Month.JANUARY);

Parameters

month:Month

the given Month.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not in the given month.

Since

3.23.0

Verifies that actual LocalDate is in the given month.

Example:

 // Assertion succeeds:
assertThat(LocalDate.of(2000, 12, 31)).hasMonthValue(12);

// Assertion fails:
assertThat(LocalDate.of(2000, 12, 31)).hasMonthValue(11);

Parameters

month:int

the given month's value between 1 and 12 inclusive.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not in the given month.

Since

3.23.0

Verifies that actual LocalDate is in the given year.

Example:

 // Assertion succeeds:
assertThat(LocalDate.of(2000, 12, 31)).hasYear(2000);

// Assertion fails:
assertThat(LocalDate.of(2000, 12, 31)).hasYear(2001);

Parameters

year:int

the given year.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not in the given year.

Since

3.23.0

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

Example :

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

Parameters

other:LocalDate

the given LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not strictly after the given one.

IllegalArgumentException:

if other LocalDate is null.

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

localDateAsString:String

String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not strictly after the LocalDate built from given String.

IllegalArgumentException:

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

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:LocalDate

the given LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not after or equals to the given one.

IllegalArgumentException:

if other LocalDate is null.

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

localDateAsString:String

String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not after or equals to the LocalDate built from given String.

IllegalArgumentException:

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

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

Example :

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

Parameters

other:LocalDate

the given LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not strictly before the given one.

IllegalArgumentException:

if other LocalDate is null.

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 String in comparison to avoid writing the code to perform the conversion
assertThat(parse("2000-01-01")).isBefore("2000-01-02");

Parameters

localDateAsString:String

String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not strictly before the LocalDate built from given String.

IllegalArgumentException:

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

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:LocalDate

the given LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not before or equals to the given one.

IllegalArgumentException:

if other LocalDate is null.

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

localDateAsString:String

String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not before or equals to the LocalDate built from given String.

IllegalArgumentException:

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

Verifies that the actual LocalDate is in the [start, end] period (start and end included).

Example:

 LocalDate localDate = LocalDate.now();

// assertions succeed:
assertThat(localDate).isBetween(localDate.minusDays(1), localDate.plusDays(1))
                     .isBetween(localDate, localDate.plusDays(1))
                     .isBetween(localDate.minusDays(1), localDate)
                     .isBetween(localDate, localDate);

// assertions fail:
assertThat(localDate).isBetween(localDate.minusDays(10), localDate.minusDays(1));
assertThat(localDate).isBetween(localDate.plusDays(1), localDate.plusDays(10));

Parameters

startInclusive:LocalDate

the start value (inclusive), expected not to be null.

endInclusive:LocalDate

the end value (inclusive), expected not to be null.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual value is null.
• if the actual value is not in [start, end] period.

NullPointerException:

• if start value is null.
• if end value is null.

Since

3.7.1

Same assertion as isBetween(LocalDate, LocalDate) but here you pass LocalDate String representations which must follow ISO LocalDate format to allow calling LocalDate#parse(CharSequence) method.

Example:

 LocalDate firstOfJanuary2000 = LocalDate.parse("2000-01-01");

// assertions succeed:
assertThat(firstOfJanuary2000).isBetween("1999-01-01", "2001-01-01")
                              .isBetween("2000-01-01", "2001-01-01")
                              .isBetween("1999-01-01", "2000-01-01")
                              .isBetween("2000-01-01", "2000-01-01");

// assertion fails:
assertThat(firstOfJanuary2000).isBetween("1999-01-01", "1999-12-31");

Parameters

startInclusive:String

the start value (inclusive), expected not to be null.

endInclusive:String

the end value (inclusive), expected not to be null.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual value is null.
• if the actual value is not in [start, end] period.

NullPointerException:

• if start value is null.
• if end value is null.

DateTimeParseException:

if any of the given String can't be converted to a LocalDate.

Since

3.7.1

Same assertion as 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 String in comparison to avoid writing the code to perform the conversion
assertThat(parse("2000-01-01")).isEqualTo("2000-01-01");

Parameters

localDateAsString:String

String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not equal to the LocalDate built from given String.

IllegalArgumentException:

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

Same assertion as 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

localDatesAsString:String[]

String array representing LocalDates.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not in the LocalDates built from given Strings.

IllegalArgumentException:

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

Verifies that the actual LocalDate is strictly in the future.

Example:

 // assertion succeeds:
assertThat(LocalDate.now().plusDays(1)).isInTheFuture();

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not in the future.

Since

3.25.0

Verifies that the actual LocalDate is strictly in the past.

Example:

 // assertion succeeds:
assertThat(LocalDate.now().minusDays(1)).isInThePast();

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not in the past.

Since

3.25.0

Same assertion as 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 String in comparison to avoid writing the code to perform the conversion
assertThat(parse("2000-01-01")).isNotEqualTo("2000-01-15");

Parameters

localDateAsString:String

String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is equal to the LocalDate built from given String.

IllegalArgumentException:

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

Same assertion as 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

localDatesAsString:String[]

Array of String representing a LocalDate.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is in the LocalDates built from given Strings.

IllegalArgumentException:

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

Verifies that the actual LocalDate is in the ]start, end[ period (start and end excluded).

Example:

 LocalDate localDate = LocalDate.now();

// assertion succeeds:
assertThat(localDate).isStrictlyBetween(localDate.minusDays(1), localDate.plusDays(1));

// assertions fail:
assertThat(localDate).isStrictlyBetween(localDate.minusDays(10), localDate.minusDays(1));
assertThat(localDate).isStrictlyBetween(localDate.plusDays(1), localDate.plusDays(10));
assertThat(localDate).isStrictlyBetween(localDate, localDate.plusDays(1));
assertThat(localDate).isStrictlyBetween(localDate.minusDays(1), localDate);

Parameters

startExclusive:LocalDate

the start value (exclusive), expected not to be null.

endExclusive:LocalDate

the end value (exclusive), expected not to be null.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual value is null.
• if the actual value is not in ]start, end[ period.

NullPointerException:

• if start value is null.
• if end value is null.

Since

3.7.1

Same assertion as isStrictlyBetween(LocalDate, LocalDate) but here you pass LocalDate String representations which must follow ISO LocalDate format to allow calling LocalDate#parse(CharSequence) method.

Example:

 LocalDate firstOfJanuary2000 = LocalDate.parse("2000-01-01");

// assertion succeeds:
assertThat(firstOfJanuary2000).isStrictlyBetween("1999-01-01", "2001-01-01");

// assertions fail:
assertThat(firstOfJanuary2000).isStrictlyBetween("1999-01-01", "1999-12-31");
assertThat(firstOfJanuary2000).isStrictlyBetween("2000-01-01", "2001-01-01");
assertThat(firstOfJanuary2000).isStrictlyBetween("1999-01-01", "2000-01-01");

Parameters

startExclusive:String

the start value (exclusive), expected not to be null.

endExclusive:String

the end value (exclusive), expected not to be null.

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual value is null.
• if the actual value is not in ]start, end[ period.

NullPointerException:

• if start value is null.
• if end value is null.

DateTimeParseException:

if any of the given String can't be converted to a LocalDate.

Since

3.7.1

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

Example:

 // assertion succeeds:
assertThat(LocalDate.now()).isToday();

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

Returns:SELF

this assertion object.

Exceptions

AssertionError:

• if the actual LocalDate is null.
• if the actual LocalDate is not today.