AbstractDateAssert (AssertJ fluent assertions 1.7.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.assertj.core.api
Class AbstractDateAssert<S extends AbstractDateAssert<S>>

java.lang.Object
  org.assertj.core.api.AbstractAssert<S,Date>
      org.assertj.core.api.AbstractDateAssert<S>


Type Parameters:: S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

All Implemented Interfaces:: Assert<S,Date>, Descriptable<S>, ExtensionPoints<S,Date>

Direct Known Subclasses:: DateAssert

public abstract class AbstractDateAssert<S extends AbstractDateAssert<S>>
extends AbstractAssert<S,Date>
extends AbstractAssert<S,Date>

Base class for all implementations of assertions for Dates.

Note that assertions with date parameter comes with two flavor, one is obviously a Date and the other is a String representing a Date.
For the latter, the default format follows ISO 8901 : "yyyy-MM-dd", user can override it with a custom format by calling withDateFormat(DateFormat).
The user custom format will then be used for all next Date assertions (i.e not limited to the current assertion) in the test suite.
To turn back to default format, simply call withDefaultDateFormatsOnly().

Author:: Tomasz Nurkiewicz (thanks for giving assertions idea), Joel Costigliola, Mikhail Mazursky, William Delanoue

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert
`actual, info, myself`

Constructor Summary
`protected`	`AbstractDateAssert(Date actual, Class<?> selfType)`

Method Summary
`S`	`hasTime(long timestamp)` Verifies that the actual `Date` has the same time as the given timestamp.
`S`	`isAfter(Date other)` Verifies that the actual `Date` is strictly after the given one.
`S`	`isAfter(String dateAsString)` Same assertion as `isAfter(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isAfterOrEqualsTo(Date other)` Verifies that the actual `Date` is after or equals to the given one.
`S`	`isAfterOrEqualsTo(String dateAsString)` Same assertion as `isAfterOrEqualsTo(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isAfterYear(int year)` Verifies that the actual `Date` is strictly after the given year.
`S`	`isBefore(Date other)` Verifies that the actual `Date` is strictly before the given one.
`S`	`isBefore(String dateAsString)` Same assertion as `isBefore(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isBeforeOrEqualsTo(Date other)` Verifies that the actual `Date` is before or equals to the given one.
`S`	`isBeforeOrEqualsTo(String dateAsString)` Same assertion as `isBeforeOrEqualsTo(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isBeforeYear(int year)` Verifies that the actual `Date` is strictly before the given year.
`S`	`isBetween(Date start, Date end)` Verifies that the actual `Date` is in [start, end[ period (start included, end excluded).
`S`	`isBetween(Date start, Date end, boolean inclusiveStart, boolean inclusiveEnd)` Verifies that the actual `Date` is in the given period defined by start and end dates. To include start in the period set inclusiveStart parameter to `true`. To include end in the period set inclusiveEnd parameter to `true`.
`S`	`isBetween(String start, String end)` Same assertion as `isBetween(Date, Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isBetween(String start, String end, boolean inclusiveStart, boolean inclusiveEnd)` Same assertion as `isBetween(Date, Date, boolean, boolean)`but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isCloseTo(Date other, long deltaInMilliseconds)` Verifies that the actual `Date` is close to the other date by less than delta (expressed in milliseconds), if difference is equals to delta it's ok.
`S`	`isCloseTo(String dateAsString, long deltaInMilliseconds)` Same assertion as `isCloseTo(Date, long)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isEqualTo(String dateAsString)` Same assertion as `isEqualTo(Date date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isEqualToIgnoringHours(Date date)` Same assertion as `AbstractAssert.isEqualTo(Object)`}} but given Date is represented as String either with one of the default supported date format or user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isEqualToIgnoringHours(String dateAsString)` Same assertion as `isEqualToIgnoringHours(Date)` but given Date is represented as String either with one of the default supported date format or user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isEqualToIgnoringMillis(Date date)` Same assertion as `AbstractAssert.isEqualTo(Object)`}} but given Date should not take care of milliseconds precision.
`S`	`isEqualToIgnoringMillis(String dateAsString)` Same assertion as `isEqualToIgnoringMillis(Date)` but given Date is represented as String either with one of the default supported date format or user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isEqualToIgnoringMinutes(Date date)` Same assertion as `AbstractAssert.isEqualTo(Object)`}} but given Date should not take care of minutes, seconds and milliseconds precision.
`S`	`isEqualToIgnoringMinutes(String dateAsString)` Same assertion as `isEqualToIgnoringMinutes(Date)` but given Date is represented as String either with one of the default supported date format or user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isEqualToIgnoringSeconds(Date date)` Same assertion as `AbstractAssert.isEqualTo(Object)`}} but given Date should not take care of seconds and milliseconds precision.
`S`	`isEqualToIgnoringSeconds(String dateAsString)` Same assertion as `isEqualToIgnoringSeconds(Date)` but given Date is represented as String either with one of the default supported date format or user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isIn(String... datesAsString)` Same assertion as `Assert.isIn(Object...)`but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameDayAs(Date other)` Verifies that actual and given `Date` have the same day of month, month and year fields values.
`S`	`isInSameDayAs(String dateAsString)` Same assertion as `isInSameDayAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameHourAs(Date other)` Verifies that actual and given `Date` have same hour, day, month and year fields values.
`S`	`isInSameHourAs(String dateAsString)` Same assertion as `isInSameHourAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameHourWindowAs(Date other)` Verifies that actual and given `Date` are chronologically in the same hour (i.e.
`S`	`isInSameHourWindowAs(String dateAsString)` Same assertion as `isInSameHourWindowAs(java.util.Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameMinuteAs(Date other)` Verifies that actual and given `Date` have same minute, same hour, day, month and year fields values.
`S`	`isInSameMinuteAs(String dateAsString)` Same assertion as `isInSameMinuteAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameMinuteWindowAs(Date other)` Verifies that actual and given `Date` are chronologically in the same hour (i.e.
`S`	`isInSameMinuteWindowAs(String dateAsString)` Same assertion as `isInSameMinuteWindowAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameMonthAs(Date other)` Verifies that actual and given `Date` have same month and year fields.
`S`	`isInSameMonthAs(String dateAsString)` Same assertion as `isInSameMonthAs(Date)`but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameSecondAs(Date other)` Verifies that actual and given `Date` have same second, minute, hour, day, month and year fields values.
`S`	`isInSameSecondAs(String dateAsString)` Same assertion as `isInSameSecondAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameSecondWindowAs(Date other)` Verifies that actual and given `Date` are chronologically strictly in the same second (i.e.
`S`	`isInSameSecondWindowAs(String dateAsString)` Same assertion as `isInSameSecondWindowAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInSameYearAs(Date other)` Verifies that actual and given `Date` are in the same year.
`S`	`isInSameYearAs(String dateAsString)` Same assertion as `isInSameYearAs(Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isInTheFuture()` Verifies that the actual `Date` is strictly in the future.
`S`	`isInThePast()` Verifies that the actual `Date` is strictly in the past.
`S`	`isInWithStringDateCollection(Collection<String> datesAsString)` Same assertion as `Assert.isIn(Iterable)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isNotBetween(Date start, Date end)` Verifies that the actual `Date` is not in [start, end[ period
`S`	`isNotBetween(Date start, Date end, boolean inclusiveStart, boolean inclusiveEnd)` Verifies that the actual `Date` is not in the given period defined by start and end dates. To include start in the period set inclusiveStart parameter to `true`. To include end in the period set inclusiveEnd parameter to `true`.
`S`	`isNotBetween(String start, String end)` Same assertion as `isNotBetween(Date, Date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isNotBetween(String start, String end, boolean inclusiveStart, boolean inclusiveEnd)` Same assertion as `isNotBetween(Date, Date, boolean, boolean)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isNotEqualTo(String dateAsString)` Same assertion as `isNotEqualTo(Date date)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isNotIn(String... datesAsString)` Same assertion as `Assert.isNotIn(Object...)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isNotInWithStringDateCollection(Collection<String> datesAsString)` Same assertion as `Assert.isNotIn(Iterable)` but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method `withDateFormat(DateFormat)`).
`S`	`isToday()` Verifies that the actual `Date` is today, that is matching current year, month and day (no check on hour, minute, second, milliseconds).
`S`	`isWithinDayOfMonth(int dayOfMonth)` Verifies that the actual `Date` day of month is equal to the given day of month.
`S`	`isWithinDayOfWeek(int dayOfWeek)` Verifies that the actual `Date` day of week is equal to the given day of week (see `Calendar.DAY_OF_WEEK` for valid values).
`S`	`isWithinHourOfDay(int hourOfDay)` Verifies that the actual `Date` hour of day is equal to the given hour of day (24-hour clock).
`S`	`isWithinMillisecond(int millisecond)` Verifies that the actual `Date` millisecond is equal to the given millisecond.
`S`	`isWithinMinute(int minute)` Verifies that the actual `Date` minute is equal to the given minute.
`S`	`isWithinMonth(int month)` Verifies that the actual `Date` month is equal to the given month, month value starting at 1 (January=1, February=2, ...).
`S`	`isWithinSecond(int second)` Verifies that the actual `Date` second is equal to the given second.
`S`	`isWithinYear(int year)` Verifies that the actual `Date` year is equal to the given year.
`static void`	`registerCustomDateFormat(DateFormat userCustomDateFormat)` Add the given date format to the ones used to parse date String in String based Date assertions like `isEqualTo(String)`.
`static void`	`registerCustomDateFormat(String userCustomDateFormatPattern)` Add the given date format to the ones used to parse date String in String based Date assertions like `isEqualTo(String)`.
`static void`	`useDateFormat(DateFormat userCustomDateFormat)` Deprecated. : use `registerCustomDateFormat(java.text.DateFormat)` instead.
`static void`	`useDateFormat(String userCustomDateFormatPattern)` Deprecated. : use `registerCustomDateFormat(String)` instead.
`static void`	`useDefaultDateFormats()` Deprecated. : use `useDefaultDateFormatsOnly()` instead.
`static void`	`useDefaultDateFormatsOnly()` Remove all registered custom date formats => use only the defaults date formats to parse string as date.
`static void`	`useIsoDateFormat()` Deprecated. use `useDefaultDateFormatsOnly()` instead.
`S`	`usingComparator(Comparator<? super Date> customComparator)` Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
`S`	`usingDefaultComparator()` Revert to standard comparison for incoming assertion checks.
`S`	`withDateFormat(DateFormat userCustomDateFormat)` Instead of using default date formats for the date String based Date assertions like `isEqualTo(String)`, AssertJ is gonna use any date formats registered with one of these methods : `withDateFormat(String)` this method `registerCustomDateFormat(java.text.DateFormat)` `registerCustomDateFormat(String)` Beware that : this will be the case for all future Date assertions in the test suite once a custom date format is registered, the default date formats are not used anymore To revert to default format, call `useDefaultDateFormatsOnly()` or `withDefaultDateFormatsOnly()`.
`S`	`withDateFormat(String userCustomDateFormatPattern)` Instead of using default date formats for the date String based Date assertions like `isEqualTo(String)`, AssertJ is gonna use any date formats registered with one of these methods : this method `withDateFormat(java.text.DateFormat)` `registerCustomDateFormat(java.text.DateFormat)` `registerCustomDateFormat(String)` Beware that : this will be the case for all future Date assertions in the test suite once a custom date format is registered, the default date formats are not used anymore To revert to default format, call `useDefaultDateFormatsOnly()` or `withDefaultDateFormatsOnly()`.
`S`	`withDefaultDateFormats()` Deprecated. use `withDefaultDateFormatsOnly()` instead.
`S`	`withDefaultDateFormatsOnly()` Remove all registered custom date formats => use only the defaults date formats to parse string as date.
`S`	`withIsoDateFormat()` Deprecated. use `withDefaultDateFormatsOnly()` instead.

Methods inherited from class org.assertj.core.api.AbstractAssert
`as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage`

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

as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AbstractDateAssert

protected AbstractDateAssert(Date actual,
                             Class<?> selfType)

Method Detail

isEqualTo

public S isEqualTo(String dateAsString)

Same assertion as isEqualTo(Date date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isEqualTo("2002-12-18");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isEqualTo("2002-12-19");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringHours

public S isEqualToIgnoringHours(String dateAsString)

Same assertion as isEqualToIgnoringHours(Date) but given Date is represented as String either with one of the default supported date format or user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // OK : all dates fields are the same up to minutes excluded
 assertThat("2003-04-26T13:01:35").isEqualToIgnoringHours("2003-04-26T14:02:35");

 // KO : fail as day fields differ
 assertThat("2003-04-26T14:01:35").isEqualToIgnoringHours("2003-04-27T13:02:35");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring hours, minutes, seconds and milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringHours

public S isEqualToIgnoringHours(Date date)

Same assertion as AbstractAssert.isEqualTo(Object)}} but given Date is represented as String either with one of the default supported date format or user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 Date date1 = parseDatetime("2003-04-26T13:01:35");
 Date date2 = parseDatetime("2003-04-26T14:01:00");
 Date date3 = parseDatetime("2003-04-27T13:01:35");

 // OK : all dates fields are the same up to hours excluded
 assertThat(date1).isEqualToIgnoringHours(date2);

 // KO : fail as day fields differ
 assertThat(date1).isEqualToIgnoringHours(date3);

Parameters:: date - the given Date.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring hours, minutes, seconds and milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringMinutes

public S isEqualToIgnoringMinutes(String dateAsString)

Same assertion as isEqualToIgnoringMinutes(Date) but given Date is represented as String either with one of the default supported date format or user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 withDateFormat("yyyy-MM-dd'T'HH:mm:ss");
 // OK : all dates fields are the same up to minutes excluded
 assertThat("2003-04-26T13:01:35").isEqualToIgnoringMinutes("2003-04-26T13:02:35");

 // KO : fail as hour fields differ
 assertThat("2003-04-26T14:01:35").isEqualToIgnoringMinutes("2003-04-26T13:02:35");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring minutes, seconds and milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringMinutes

public S isEqualToIgnoringMinutes(Date date)

Same assertion as AbstractAssert.isEqualTo(Object)}} but given Date should not take care of minutes, seconds and milliseconds precision.

Example:

 Date date1 = parseDatetime("2003-04-26T13:01:35");
 Date date2 = parseDatetime("2003-04-26T13:02:00");
 Date date3 = parseDatetime("2003-04-26T14:02:00");

 // OK : all dates fields are the same up to minutes excluded
 assertThat(date1).isEqualToIgnoringMinutes(date2);

 // KO : fail as hour fields differ
 assertThat(date1).isEqualToIgnoringMinutes(date3);

Parameters:: date - the given Date.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring minutes, seconds and milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringSeconds

public S isEqualToIgnoringSeconds(String dateAsString)

Same assertion as isEqualToIgnoringSeconds(Date) but given Date is represented as String either with one of the default supported date format or user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 Date date1 = parseDatetime("2003-04-26T13:01:35");

 // OK : all dates fields are the same up to seconds excluded
 assertThat(date1).isEqualToIgnoringSeconds("2003-04-26T13:01:57");

 // KO : fail as minute fields differ
 assertThat(date1).isEqualToIgnoringMinutes("2003-04-26T13:02:00");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring seconds and milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringSeconds

public S isEqualToIgnoringSeconds(Date date)

Same assertion as AbstractAssert.isEqualTo(Object)}} but given Date should not take care of seconds and milliseconds precision.

Example:

 Date date1 = parseDatetime("2003-04-26T13:01:35");
 Date date2 = parseDatetime("2003-04-26T13:01:36");
 Date date3 = parseDatetime("2003-04-26T14:02:00");

 // OK : all dates fields are the same up to seconds excluded
 assertThat(date1).isEqualToIgnoringSeconds(date2);

 // KO : fail as minute fields differ
 assertThat(date1).isEqualToIgnoringSeconds(date3);

Parameters:: date - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring seconds and milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringMillis

public S isEqualToIgnoringMillis(String dateAsString)

Same assertion as isEqualToIgnoringMillis(Date) but given Date is represented as String either with one of the default supported date format or user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 Date date1 = parseDatetimeWithMs("2003-04-26T13:01:35.998");

 // OK : all dates fields are the same up to milliseconds excluded
 assertThat().isEqualToIgnoringMillis("2003-04-26T13:01:35.997");

 // KO : fail as seconds fields differ
 assertThat("2003-04-26T13:01:35.998").isEqualToIgnoringMinutes("2003-04-26T13:01:36.998");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isEqualToIgnoringMillis

public S isEqualToIgnoringMillis(Date date)

Same assertion as AbstractAssert.isEqualTo(Object)}} but given Date should not take care of milliseconds precision.

Example:

 Date date1 = parseDatetimeAndMs("2003-04-26T13:01:35.001");
 Date date2 = parseDatetimeAndMs("2003-04-26T13:01:35.002");
 Date date3 = parseDatetimeAndMs("2003-04-26T14:01:36.001");

 // OK : all dates fields are the same up to milliseconds excluded
 assertThat(date1).isEqualToIgnoringMillis(date2);

 // KO : fail as second fields differ
 assertThat(date1).isEqualToIgnoringMillis(date3);

Parameters:: date - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are not equal ignoring milliseconds.; AssertionError - if the given date as String could not be converted to a Date.

isNotEqualTo

public S isNotEqualTo(String dateAsString)

Same assertion as isNotEqualTo(Date date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isNotEqualTo("2002-12-19");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isNotEqualTo("2002-12-18");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual and given Date represented as String are equal.; AssertionError - if the given date as String could not be converted to a Date.

isIn

public S isIn(String... datesAsString)

Same assertion as Assert.isIn(Object...)but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isIn("2002-12-17", "2002-12-18", "2002-12-19");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isIn("2002-12-17", "2002-12-19", "2002-12-20");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: datesAsString - the given Dates represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual is not in given Dates represented as String.; AssertionError - if one of the given date as String could not be converted to a Date.

isInWithStringDateCollection

public S isInWithStringDateCollection(Collection<String> datesAsString)

Same assertion as Assert.isIn(Iterable) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isInWithStringDateCollection(
     Arrays.asList("2002-12-17", "2002-12-18", "2002-12-19"));

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isInWithStringDateCollection(
     Arrays.asList("2002-12-17", "2002-12-19", "2002-12-20"));

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Method signature could not be isIn(Collection<String>) because it would be same signature as isIn(Collection<Date>) since java collection type are erased at runtime.

Parameters:: datesAsString - the given Dates represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual is not in given Dates represented as String.; AssertionError - if one of the given date as String could not be converted to a Date.

isNotIn

public S isNotIn(String... datesAsString)

Same assertion as Assert.isNotIn(Object...) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isNotIn("2002-12-17", "2002-12-19");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isNotIn("2002-12-17", "2002-12-18");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: datesAsString - the given Dates represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual is in given Dates represented as String.; AssertionError - if one of the given date as String could not be converted to a Date.

isNotInWithStringDateCollection

public S isNotInWithStringDateCollection(Collection<String> datesAsString)

Same assertion as Assert.isNotIn(Iterable) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isNotInWithStringDateCollection(Arrays.asList("2002-12-17",
 "2002-12-19"));

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isNotInWithStringDateCollection(Arrays.asList("2002-12-17",
 "2002-12-18"));

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Method signature could not be isNotIn(Collection<String>) because it would be same signature as isNotIn(Collection<Date>) since java collection type are erased at runtime.

Parameters:: datesAsString - the given Dates represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if actual is in given Dates represented as String.; AssertionError - if one of the given date as String could not be converted to a Date.

isBefore

public S isBefore(Date other)

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

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBefore(theReturnOfTheKing.getReleaseDate());

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isBefore(theFellowshipOfTheRing.getReleaseDate());

Parameters:: other - the given Date.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if other Date is null.; AssertionError - if the actual Date is not strictly before the given one.

isBefore

public S isBefore(String dateAsString)

Same assertion as isBefore(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBefore("2002-12-19");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isBefore("2002-12-17");
 assertThat(theTwoTowers.getReleaseDate()).isBefore("2002-12-18");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if given date as String is null.; AssertionError - if the actual Date is not strictly before the given Date represented as String.; AssertionError - if the given date as String could not be converted to a Date.

isBeforeOrEqualsTo

public S isBeforeOrEqualsTo(Date other)

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

Parameters:: other - the given Date.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if other Date is null.; AssertionError - if the actual Date is not before or equals to the given one.

isBeforeOrEqualsTo

public S isBeforeOrEqualsTo(String dateAsString)

Same assertion as isBeforeOrEqualsTo(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBeforeOrEqualsTo("2002-12-19");
 assertThat(theTwoTowers.getReleaseDate()).isBeforeOrEqualsTo("2002-12-18");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isBeforeOrEqualsTo("2002-12-17");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if given date as String is null.; AssertionError - if the actual Date is not before or equals to the given Date represented as String.; AssertionError - if the given date as String could not be converted to a Date.

isAfter

public S isAfter(Date other)

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

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isAfter(theFellowshipOfTheRing.getReleaseDate());

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isAfter(theReturnOfTheKing.getReleaseDate());

Parameters:: other - the given Date.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if other Date is null.; AssertionError - if the actual Date is not strictly after the given one.

isAfter

public S isAfter(String dateAsString)

Same assertion as isAfter(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isAfter("2002-12-17");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isAfter("2002-12-18");
 assertThat(theTwoTowers.getReleaseDate()).isAfter("2002-12-19");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if given date as String is null.; AssertionError - if the actual Date is not strictly after the given Date represented as String.; AssertionError - if the given date as String could not be converted to a Date.

isAfterOrEqualsTo

public S isAfterOrEqualsTo(Date other)

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

Parameters:: other - the given Date.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if other Date is null.; AssertionError - if the actual Date is not after or equals to the given one.

isAfterOrEqualsTo

public S isAfterOrEqualsTo(String dateAsString)

Same assertion as isAfterOrEqualsTo(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isAfterOrEqualsTo("2002-12-17");
 assertThat(theTwoTowers.getReleaseDate()).isAfterOrEqualsTo("2002-12-18");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isAfterOrEqualsTo("2002-12-19");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if given date as String is null.; AssertionError - if the actual Date is not after or equals to the given Date represented as String.; AssertionError - if the given date as String could not be converted to a Date.

isBetween

public S isBetween(Date start,
                   Date end)

Verifies that the actual Date is in [start, end[ period (start included, end excluded).

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBetween(theFellowshipOfTheRing.getReleaseDate(),
     theReturnOfTheKing.getReleaseDate());

 // assertion will fail
 assertThat(theFellowshipOfTheRing.getReleaseDate()).isBetween(theTwoTowers.getReleaseDate(),
     theReturnOfTheKing.getReleaseDate());

Parameters:: start - the period start (inclusive), expected not to be null.; end - the period end (exclusive), expected not to be null.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if start Date is null.; NullPointerException - if end Date is null.; AssertionError - if the actual Date is not in [start, end[ period.

isBetween

public S isBetween(String start,
                   String end)

Same assertion as isBetween(Date, Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBetween("2002-12-17", "2002-12-19");

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isBetween("2002-12-15", "2002-12-17");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: start - the period start (inclusive), expected not to be null.; end - the period end (exclusive), expected not to be null.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if start Date as String is null.; NullPointerException - if end Date as String is null.; AssertionError - if the actual Date is not in [start, end[ period.; AssertionError - if one of the given date as String could not be converted to a Date.

isBetween

public S isBetween(Date start,
                   Date end,
                   boolean inclusiveStart,
                   boolean inclusiveEnd)

Verifies that the actual Date is in the given period defined by start and end dates.
To include start in the period set inclusiveStart parameter to true.
To include end in the period set inclusiveEnd parameter to true.

Parameters:: start - the period start, expected not to be null.; end - the period end, expected not to be null.; inclusiveStart - whether to include start date in period.; inclusiveEnd - whether to include end date in period.
Returns:: this assertion object.
Throws:: AssertionError - if actual is null.; NullPointerException - if start Date is null.; NullPointerException - if end Date is null.; AssertionError - if the actual Date is not in (start, end) period.

isBetween

public S isBetween(String start,
                   String end,
                   boolean inclusiveStart,
                   boolean inclusiveEnd)

Same assertion as isBetween(Date, Date, boolean, boolean)but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBetween("2002-12-17", "2002-12-18", false, true);
 assertThat(theTwoTowers.getReleaseDate()).isBetween("2002-12-18", "2002-12-19", true, false);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isBetween("2002-12-17", "2002-12-18", false, false);

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: start - the period start, expected not to be null.; end - the period end, expected not to be null.; inclusiveStart - whether to include start date in period.; inclusiveEnd - whether to include end date in period.
Returns:: this assertion object.
Throws:: AssertionError - if actual is null.; NullPointerException - if start Date as String is null.; NullPointerException - if end Date as String is null.; AssertionError - if the actual Date is not in (start, end) period.; AssertionError - if one of the given date as String could not be converted to a Date.

isNotBetween

public S isNotBetween(Date start,
                      Date end,
                      boolean inclusiveStart,
                      boolean inclusiveEnd)

Verifies that the actual Date is not in the given period defined by start and end dates.
To include start in the period set inclusiveStart parameter to true.
To include end in the period set inclusiveEnd parameter to true.

Parameters:: start - the period start (inclusive), expected not to be null.; end - the period end (exclusive), expected not to be null.; inclusiveStart - whether to include start date in period.; inclusiveEnd - whether to include end date in period.
Returns:: this assertion object.
Throws:: AssertionError - if actual is null.; NullPointerException - if start Date is null.; NullPointerException - if end Date is null.; AssertionError - if the actual Date is not in (start, end) period.

isNotBetween

public S isNotBetween(String start,
                      String end,
                      boolean inclusiveStart,
                      boolean inclusiveEnd)

Same assertion as isNotBetween(Date, Date, boolean, boolean) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isNotBetween("2002-12-17", "2002-12-18", false,
 false);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isNotBetween("2002-12-17", "2002-12-18", false,
 true);
 assertThat(theTwoTowers.getReleaseDate()).isNotBetween("2002-12-18", "2002-12-19", true,
 false);

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: start - the period start (inclusive), expected not to be null.; end - the period end (exclusive), expected not to be null.; inclusiveStart - whether to include start date in period.; inclusiveEnd - whether to include end date in period.
Returns:: this assertion object.
Throws:: AssertionError - if actual is null.; NullPointerException - if start Date as String is null.; NullPointerException - if end Date as String is null.; AssertionError - if the actual Date is not in (start, end) period.; AssertionError - if one of the given date as String could not be converted to a Date.

isNotBetween

public S isNotBetween(Date start,
                      Date end)

Verifies that the actual Date is not in [start, end[ period

Parameters:: start - the period start (inclusive), expected not to be null.; end - the period end (exclusive), expected not to be null.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if start Date is null.; NullPointerException - if end Date is null.; AssertionError - if the actual Date is in [start, end[ period.; AssertionError - if one of the given date as String could not be converted to a Date.

isNotBetween

public S isNotBetween(String start,
                      String end)

Same assertion as isNotBetween(Date, Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 // assertion will pass
 assertThat(theFellowshipOfTheRing.getReleaseDate()).isNotBetween("2002-12-01", "2002-12-10");

 // assertion will fail
 assertThat(theFellowshipOfTheRing.getReleaseDate()).isNotBetween("2002-12-01", "2002-12-19");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: start - the period start (inclusive), expected not to be null.; end - the period end (exclusive), expected not to be null.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; NullPointerException - if start Date as String is null.; NullPointerException - if end Date as String is null.; AssertionError - if the actual Date is in [start, end[ period.; AssertionError - if one of the given date as String could not be converted to a Date.

isInThePast

public S isInThePast()

Verifies that the actual Date is strictly in the past.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isInThePast();

Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date is not in the past.

isToday

public S isToday()

Verifies that the actual Date is today, that is matching current year, month and day (no check on hour, minute, second, milliseconds).

Example:

 // assertion will pass
 assertThat(new Date()).isToday();

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

Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date is not today.

isInTheFuture

public S isInTheFuture()

Verifies that the actual Date is strictly in the future.

Example:

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isInTheFuture();

Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date is not in the future.

isBeforeYear

public S isBeforeYear(int year)

Verifies that the actual Date is strictly before the given year.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isBeforeYear(2004);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isBeforeYear(2002);
 assertThat(theTwoTowers.getReleaseDate()).isBeforeYear(2000);

Parameters:: year - the year to compare actual year to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date year is after or equals to the given year.

isAfterYear

public S isAfterYear(int year)

Verifies that the actual Date is strictly after the given year.

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isAfterYear(2001);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isAfterYear(2002);
 assertThat(theTwoTowers.getReleaseDate()).isAfterYear(2004);

Parameters:: year - the year to compare actual year to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date year is before or equals to the given year.

isWithinYear

public S isWithinYear(int year)

Verifies that the actual Date year is equal to the given year.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isWithinYear(2002);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isWithinYear(2004);

Parameters:: year - the year to compare actual year to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date year is not equal to the given year.

isWithinMonth

public S isWithinMonth(int month)

Verifies that the actual Date month is equal to the given month, month value starting at 1 (January=1, February=2, ...).

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isWithinMonth(12);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isWithinMonth(10);

Parameters:: month - the month to compare actual month to, month value starting at 1 (January=1, February=2, ...).
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date month is not equal to the given month.

isWithinDayOfMonth

public S isWithinDayOfMonth(int dayOfMonth)

Verifies that the actual Date day of month is equal to the given day of month.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(theTwoTowers.getReleaseDate()).isWithinDayOfMonth(18);

 // assertion will fail
 assertThat(theTwoTowers.getReleaseDate()).isWithinDayOfMonth(20);

Parameters:: dayOfMonth - the day of month to compare actual day of month to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date month is not equal to the given day of month.

isWithinDayOfWeek

public S isWithinDayOfWeek(int dayOfWeek)

Verifies that the actual Date day of week is equal to the given day of week (see Calendar.DAY_OF_WEEK for valid values).

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinDayOfWeek(Calendar.SATURDAY);

 // assertion will fail
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinDayOfWeek(Calendar.MONDAY);

Parameters:: dayOfWeek - the day of week to compare actual day of week to, see Calendar.DAY_OF_WEEK for valid values
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date week is not equal to the given day of week.

isWithinHourOfDay

public S isWithinHourOfDay(int hourOfDay)

Verifies that the actual Date hour of day is equal to the given hour of day (24-hour clock).

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinHourOfDay(13);

 // assertion will fail
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinHourOfDay(22);

Parameters:: hourOfDay - the hour of day to compare actual hour of day to (24-hour clock)
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date hour is not equal to the given hour.

isWithinMinute

public S isWithinMinute(int minute)

Verifies that the actual Date minute is equal to the given minute.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinMinute(20);

 // assertion will fail
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinMinute(17);

Parameters:: minute - the minute to compare actual minute to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date minute is not equal to the given minute.

isWithinSecond

public S isWithinSecond(int second)

Verifies that the actual Date second is equal to the given second.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 // assertion will pass
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinSecond(35);

 // assertion will fail
 assertThat(new Date(parseDatetime("2003-04-26T13:20:35").getTime()).isWithinSecond(11);

Parameters:: second - the second to compare actual second to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date second is not equal to the given second.

isWithinMillisecond

public S isWithinMillisecond(int millisecond)

Verifies that the actual Date millisecond is equal to the given millisecond.

Examples:

 // assertion will pass
 assertThat(parseDatetimeWithMs("2003-04-26T13:20:35.017")).isWithinMillisecond(17);

 // assertion will fail
 assertThat(parseDatetimeWithMs("2003-04-26T13:20:35.017")).isWithinMillisecond(25);

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Parameters:: millisecond - the millisecond to compare actual millisecond to
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date millisecond is not equal to the given millisecond.

isInSameYearAs

public S isInSameYearAs(Date other)

Verifies that actual and given Date are in the same year.

Example:

 Date date1 = parse("2003-04-26");
 Date date2 = parse("2003-05-27");

 assertThat(date1).isInSameYearAs(date2);

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same year.

isInSameYearAs

public S isInSameYearAs(String dateAsString)

Same assertion as isInSameYearAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 Date date1 = parse("2003-04-26");
 assertThat(date1).isInSameYearAs("2003-05-27");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date represented as String are not in the same year.; AssertionError - if the given date as String could not be converted to a Date.

isInSameMonthAs

public S isInSameMonthAs(Date other)

Verifies that actual and given Date have same month and year fields.

Example:

 Date date1 = parse("2003-04-26");
 Date date2 = parse("2003-04-27");

 assertThat(date1).isInSameMonthAs(date2);

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same month.

isInSameMonthAs

public S isInSameMonthAs(String dateAsString)

Same assertion as isInSameMonthAs(Date)but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 Date date1 = parse("2003-04-26");
 assertThat(date1).isInSameMonthAs("2003-04-27");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same month.

isInSameDayAs

public S isInSameDayAs(Date other)

Verifies that actual and given Date have the same day of month, month and year fields values.

Example:

 Date date1 = parseDatetime("2003-04-26T23:17:00");
 Date date2 = parseDatetime("2003-04-26T12:30:00");

 assertThat(date1).isInSameDayAs(date2);

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same day of month.

isInSameDayAs

public S isInSameDayAs(String dateAsString)

Same assertion as isInSameDayAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Example:

 Date date1 = parseDatetime("2003-04-26T23:17:00");
 assertThat(date1).isInSameDayAs("2003-04-26");

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same day of month.

isInSameHourWindowAs

public S isInSameHourWindowAs(Date other)

Verifies that actual and given Date are chronologically in the same hour (i.e. their time difference <= 1 hour).

This assertion succeeds as time difference is exactly = 1h:

 Date date1 = parseDatetime("2003-04-26T13:00:00");
 Date date2 = parseDatetime("2003-04-26T14:00:00");
 assertThat(date1).isInSameHourWindowAs(date2)

Two dates can have different hour fields and yet be in the same chronological hour, example:

 Date date1 = parseDatetime("2003-04-26T13:00:00");
 Date date2 = parseDatetime("2003-04-26T12:59:59");
 // succeeds as time difference == 1s
 assertThat(date1).isInSameHourWindowAs(date2)

This assertion fails as time difference is more than one hour:

 Date date1 = parseDatetime("2003-04-26T13:00:00");
 Date date2 = parseDatetime("2003-04-26T14:00:01");
 assertThat(date1).isInSameHourWindowAs(date2)

To compare date's hour fields only (without day, month and year), you can write :

 assertThat(myDate).isWithinHour(hourOfDayOf(otherDate))

see hourOfDayOf to get the hour of a given Date.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator)).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same hour.

isInSameHourWindowAs

public S isInSameHourWindowAs(String dateAsString)

Same assertion as isInSameHourWindowAs(java.util.Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same day of month.

isInSameHourAs

public S isInSameHourAs(Date other)

Verifies that actual and given Date have same hour, day, month and year fields values.

Example:

 Date date1 = parseDatetime("2003-01-01T12:00:00");
 Date date2 = parseDatetime("2003-01-01T12:30:00");

 // succeeds
 assertThat(date1).isInSameHourAs(date2);

This assertion does not make a true chronological comparison since two dates can have different hour fields and yet be in the same chronological hour, e.g:

 // dates in the same hour time window but with different hour fields
 Date date1 = parseDatetime("2003-01-01T12:00:00");
 Date date2 = parseDatetime("2003-01-01T11:59:00");

If you want to assert that two dates are chronologically in the same hour time window use isInSameHourWindowAs assertion (note that if isInSameHourAs succeeds then isInSameHourWindowAs will succeed too).

If you want to compare hour only (without day, month and year), you could write : assertThat(myDate).isWithinHour(hourOfDayOf(otherDate))
see Dates.hourOfDayOf(Date) to get the hour of a given Date.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same hour.

isInSameHourAs

public S isInSameHourAs(String dateAsString)

Same assertion as isInSameHourAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same hour.

isInSameMinuteWindowAs

public S isInSameMinuteWindowAs(Date other)

Verifies that actual and given Date are chronologically in the same hour (i.e. their time difference <= 1 hour).

Example:

 Date date1 = parseDatetime("2003-01-01T12:01:00");
 Date date2 = parseDatetime("2003-01-01T12:01:30");

 // succeeds because date time difference < 1 min
 assertThat(date1).isInSameMinuteWindowAs(date2);

Two dates can have different minute fields and yet be in the same chronological minute, example:

 Date date1 = parseDatetime("2003-01-01T12:01:00");
 Date date3 = parseDatetime("2003-01-01T12:00:59");

 // succeeds as time difference == 1s even though minutes fields differ
 assertThat(date1).isInSameMinuteWindowAs(date3)

This assertion fails as time difference is >= one minute:

 Date date1 = parseDatetime("2003-01-01T12:01:00");
 Date date2 = parseDatetime("2003-01-01T12:02:00");

 // fails, time difference should hae been < 1 min
 assertThat(date1).isInSameMinuteWindowAs(date2); // ERROR

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator)).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same minute.

isInSameMinuteWindowAs

public S isInSameMinuteWindowAs(String dateAsString)

Same assertion as isInSameMinuteWindowAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same minute.

isInSameMinuteAs

public S isInSameMinuteAs(Date other)

Verifies that actual and given Date have same minute, same hour, day, month and year fields values.

Example:

 Date date1 = parseDatetime("2003-01-01T12:01:00");
 Date date2 = parseDatetime("2003-01-01T12:01:30");

 // succeeds because the all the fields up to minutes are the same
 assertThat(date1).isInSameMinuteAs(date2);

It does not make a true chronological comparison since two dates can have different minute fields and yet be in the same chronological minute, e.g:

 // dates in the same minute time window but with different minute fields
 Date date1 = parseDatetime("2003-01-01T12:01:00");
 Date date3 = parseDatetime("2003-01-01T12:00:59");

 // fails because minutes fields differ even though time difference is only 1s !
 assertThat(date1).isInSameMinuteAs(date3); // ERROR

If you want to assert that two dates are in the same minute time window use isInSameMinuteWindowAs assertion (note that if isInSameMinuteAs succeeds then isInSameMinuteWindowAs will succeed too).

If you want to compare minute field only (without hour, day, month and year), you could write : assertThat(myDate).isWithinMinute(minuteOf(otherDate))
using Dates.minuteOf(Date) to get the minute of a given Date.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator)).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same minute.

isInSameMinuteAs

public S isInSameMinuteAs(String dateAsString)

Same assertion as isInSameMinuteAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same minute.

isInSameSecondWindowAs

public S isInSameSecondWindowAs(Date other)

Verifies that actual and given Date are chronologically strictly in the same second (i.e. their time difference < 1 second).

Example:

 Date date1 = parseDatetimeWithMs("2003-04-26T13:01:02.123");
 Date date2 = parseDatetimeWithMs("2003-04-26T13:01:02.456");

 // succeeds as time difference is < 1s
 assertThat(date1).isInSameSecondWindowAs(date2);

Two dates can have different second fields and yet be in the same chronological second, example:

 Date date1 = parseDatetimeWithMs("2003-04-26T13:01:02.999");
 Date date2 = parseDatetimeWithMs("2003-04-26T13:01:03.000");

 // succeeds as time difference is 1ms < 1s
 assertThat(date1).isInSameSecondWindowAs(date2);

Those assertions fail as time difference is greater or equal to one second:

 Date date1 = parseDatetimeWithMs("2003-04-26T13:01:01.000");
 Date date2 = parseDatetimeWithMs("2003-04-26T13:01:02.000");

 // fails as time difference = 1s
 assertThat(date1).isInSameSecondWindowAs(date2); // ERROR

 Date date3 = parseDatetimeWithMs("2003-04-26T13:01:02.001");
 // fails as time difference > 1s
 assertThat(date1).isInSameSecondWindowAs(date3); // ERROR

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same second.

isInSameSecondWindowAs

public S isInSameSecondWindowAs(String dateAsString)

Same assertion as isInSameSecondWindowAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same second.

isInSameSecondAs

public S isInSameSecondAs(Date other)

Verifies that actual and given Date have same second, minute, hour, day, month and year fields values.

 Date date1 = parseDatetimeWithMs("2003-01-01T12:00:01.000");
 Date date2 = parseDatetimeWithMs("2003-01-01T12:00:01.250");

 // succeeds because the all the time fields up to seconds are the same
 assertThat(date1).isInSameSecondAs(date2);

It does not make a true chronological comparison since two dates can have different second fields and yet be in the same chronological second, e.g:

 Date date1 = parseDatetimeWithMs("2003-01-01T12:00:01.000");
 Date date3 = parseDatetimeWithMs("2003-01-01T12:00:00.999");

 // fails because seconds fields differ even though time difference is only 1ms !
 assertThat(date1).isInSameSecondAs(date3); // ERROR

If you want to assert that two dates are in the same second time window use isInSameSecondWindowAs assertion.

If you want to compare second fields only (without minute, hour, day, month and year), you could write : assertThat(myDate).isWithinSecond(secondOf(otherDate))
using Dates.secondOf(Date) to get the second of a given Date.

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator)).

Parameters:: other - the given Date to compare actual Date to.
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if actual and given Date are not in the same second.

isInSameSecondAs

public S isInSameSecondAs(String dateAsString)

Same assertion as isInSameSecondAs(Date) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

isCloseTo

public S isCloseTo(Date other,
                   long deltaInMilliseconds)

Verifies that the actual Date is close to the other date by less than delta (expressed in milliseconds), if difference is equals to delta it's ok.

One can use handy TimeUnit to convert a duration in milliseconds, for example you can express a delta of 5 seconds with TimeUnit.SECONDS.toMillis(5).

Note that using a custom comparator has no effect on this assertion (see usingComparator(Comparator).

Example:

 Date date1 = new Date();
 Date date2 = new Date(date1.getTime() + 100);

 // assertion will pass
 assertThat(date1).isCloseTo(date2, 80);
 assertThat(date1).isCloseTo(date2, 100);

 // assertion will fail
 assertThat(date1).isCloseTo(date2, 101);

Parameters:: other - the date to compare actual to; deltaInMilliseconds - the delta used for date comparison, expressed in milliseconds
Returns:: this assertion object.
Throws:: NullPointerException - if Date parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if the actual Date week is not close to the given date by less than delta.

isCloseTo

public S isCloseTo(String dateAsString,
                   long deltaInMilliseconds)

Same assertion as isCloseTo(Date, long) but given date is represented as String either with one of the supported defaults date format or a user custom date format (set with method withDateFormat(DateFormat)).

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Parameters:: dateAsString - the given Date represented as String in default or custom date format.; deltaInMilliseconds - the delta used for date comparison, expressed in milliseconds
Returns:: this assertion object.
Throws:: NullPointerException - if dateAsString parameter is null.; AssertionError - if the actual Date is null.; AssertionError - if the actual Date week is not close to the given date by less than delta.

hasTime

public S hasTime(long timestamp)

Verifies that the actual Date has the same time as the given timestamp.

Both time or timestamp express a number of milliseconds since January 1, 1970, 00:00:00 GMT.

Example:

 assertThat(new Date(42)).hasTime(42);

Parameters:: timestamp - the timestamp to compare actual time to.
Returns:: this assertion object.
Throws:: AssertionError - if the actual Date is null.; AssertionError - if the actual Date time is not equal to the given timestamp.
See Also:: Date.getTime()

withDateFormat

public S withDateFormat(DateFormat userCustomDateFormat)

Instead of using default date formats for the date String based Date assertions like isEqualTo(String), AssertJ is gonna use any date formats registered with one of these methods :

Beware that :

this will be the case for all future Date assertions in the test suite
once a custom date format is registered, the default date formats are not used anymore

To revert to default format, call useDefaultDateFormatsOnly() or withDefaultDateFormatsOnly().

Parameters:: userCustomDateFormat - the new Date format used for String based Date assertions.
Returns:: this assertion object.

withDateFormat

public S withDateFormat(String userCustomDateFormatPattern)

Instead of using default date formats for the date String based Date assertions like isEqualTo(String), AssertJ is gonna use any date formats registered with one of these methods :

Beware that :

this will be the case for all future Date assertions in the test suite
once a custom date format is registered, the default date formats are not used anymore

To revert to default format, call useDefaultDateFormatsOnly() or withDefaultDateFormatsOnly().

Parameters:: userCustomDateFormatPattern - the new Date format string pattern used for String based Date assertions.
Returns:: this assertion object.

registerCustomDateFormat

public static void registerCustomDateFormat(DateFormat userCustomDateFormat)

Add the given date format to the ones used to parse date String in String based Date assertions like isEqualTo(String).

User date formats are used before default ones in the order they have been registered (first registered, first used).

AssertJ is gonna use any date formats registered with one of these methods :

Beware that AssertJ will use the newly registered format for all remaining Date assertions in the test suite

To revert to default formats only, call useDefaultDateFormatsOnly() or withDefaultDateFormatsOnly().

Code examples:

 Date date = ... // set to 2003 April the 26th
 assertThat(date).isEqualTo("2003-04-26");

 try {
   // date with a custom format : failure since the default formats don't match.
   assertThat(date).isEqualTo("2003/04/26");
 } catch (AssertionError e) {
   assertThat(e).hasMessage("Failed to parse 2003/04/26 with any of these date formats: " +
                            "[yyyy-MM-dd'T'HH:mm:ss.SSS, yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd]");
 }

 // registering a custom date format to make the assertion pass
 registerCustomDateFormat(new SimpleDateFormat("yyyy/MM/dd")); // registerCustomDateFormat("yyyy/MM/dd") would work to.
 assertThat(date).isEqualTo("2003/04/26");

 // the default formats are still available and should work
 assertThat(date).isEqualTo("2003-04-26");

Parameters:: userCustomDateFormat - the new Date format used for String based Date assertions.

registerCustomDateFormat

public static void registerCustomDateFormat(String userCustomDateFormatPattern)

Add the given date format to the ones used to parse date String in String based Date assertions like isEqualTo(String).

User date formats are used before default ones in the order they have been registered (first registered, first used).

AssertJ is gonna use any date formats registered with one of these methods :

Beware that AssertJ will use the newly registered format for all remaining Date assertions in the test suite

To revert to default formats only, call useDefaultDateFormatsOnly() or withDefaultDateFormatsOnly().

Code examples:

 Date date = ... // set to 2003 April the 26th
 assertThat(date).isEqualTo("2003-04-26");

 try {
   // date with a custom format : failure since the default formats don't match.
   assertThat(date).isEqualTo("2003/04/26");
 } catch (AssertionError e) {
   assertThat(e).hasMessage("Failed to parse 2003/04/26 with any of these date formats: " +
                            "[yyyy-MM-dd'T'HH:mm:ss.SSS, yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd]");
 }

 // registering a custom date format to make the assertion pass
 registerCustomDateFormat("yyyy/MM/dd");
 assertThat(date).isEqualTo("2003/04/26");

 // the default formats are still available and should work
 assertThat(date).isEqualTo("2003-04-26");

Parameters:: userCustomDateFormatPattern - the new Date format pattern used for String based Date assertions.

useDefaultDateFormatsOnly

public static void useDefaultDateFormatsOnly()

Remove all registered custom date formats => use only the defaults date formats to parse string as date.

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

withDefaultDateFormatsOnly

public S withDefaultDateFormatsOnly()

Remove all registered custom date formats => use only the defaults date formats to parse string as date.

Beware that the default formats are expressed in the current local timezone.

Defaults date format (expressed in the local time zone) are :

yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd

Example of valid string date representations:

2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26

Returns:: this assertion

usingComparator

public S usingComparator(Comparator<? super Date> customComparator)

Description copied from class: AbstractAssert

Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.

Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.

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 interface Assert<S extends AbstractDateAssert<S>,Date>
Overrides:: usingComparator in class AbstractAssert<S extends AbstractDateAssert<S>,Date>

Parameters:: customComparator - the comparator to use for incoming assertion checks.
Returns:: this assertion object.

usingDefaultComparator

public S usingDefaultComparator()

Description copied from class: AbstractAssert

Revert to standard comparison for incoming assertion checks.

This method should be used to disable a custom comparison strategy set by calling Assert.usingComparator(Comparator).

Specified by:: usingDefaultComparator in interface Assert<S extends AbstractDateAssert<S>,Date>
Overrides:: usingDefaultComparator in class AbstractAssert<S extends AbstractDateAssert<S>,Date>

Returns:: this assertion object.

useDateFormat

@Deprecated
public static void useDateFormat(DateFormat userCustomDateFormat)

Deprecated. : use registerCustomDateFormat(java.text.DateFormat) instead.

useDateFormat

@Deprecated
public static void useDateFormat(String userCustomDateFormatPattern)

Deprecated. : use registerCustomDateFormat(String) instead.

withIsoDateFormat

@Deprecated
public S withIsoDateFormat()

Deprecated. use withDefaultDateFormatsOnly() instead.

withDefaultDateFormats

@Deprecated
public S withDefaultDateFormats()

Deprecated. use withDefaultDateFormatsOnly() instead.

useIsoDateFormat

@Deprecated
public static void useIsoDateFormat()

Deprecated. use useDefaultDateFormatsOnly() instead.

useDefaultDateFormats

@Deprecated
public static void useDefaultDateFormats()

Deprecated. : use useDefaultDateFormatsOnly() instead.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.assertj.core.api Class AbstractDateAssert<S extends AbstractDateAssert<S>>

AbstractDateAssert

isEqualTo

isEqualToIgnoringHours

isEqualToIgnoringHours

isEqualToIgnoringMinutes

isEqualToIgnoringMinutes

isEqualToIgnoringSeconds

isEqualToIgnoringSeconds

isEqualToIgnoringMillis

isEqualToIgnoringMillis

isNotEqualTo

isIn

isInWithStringDateCollection

isNotIn

isNotInWithStringDateCollection

isBefore

isBefore

isBeforeOrEqualsTo

isBeforeOrEqualsTo

isAfter

isAfter

isAfterOrEqualsTo

isAfterOrEqualsTo

isBetween

isBetween

isBetween

isBetween

isNotBetween

isNotBetween

isNotBetween

isNotBetween

isInThePast

isToday

isInTheFuture

isBeforeYear

isAfterYear

isWithinYear

isWithinMonth

isWithinDayOfMonth

isWithinDayOfWeek

isWithinHourOfDay

isWithinMinute

isWithinSecond

isWithinMillisecond

isInSameYearAs

isInSameYearAs

isInSameMonthAs

isInSameMonthAs

isInSameDayAs

isInSameDayAs

isInSameHourWindowAs

isInSameHourWindowAs

isInSameHourAs

isInSameHourAs

isInSameMinuteWindowAs

isInSameMinuteWindowAs

isInSameMinuteAs

isInSameMinuteAs

isInSameSecondWindowAs

isInSameSecondWindowAs

isInSameSecondAs

isInSameSecondAs

isCloseTo

isCloseTo

hasTime

withDateFormat

withDateFormat

registerCustomDateFormat

registerCustomDateFormat

useDefaultDateFormatsOnly

withDefaultDateFormatsOnly

usingComparator

usingDefaultComparator

useDateFormat

useDateFormat

withIsoDateFormat

withDefaultDateFormats

useIsoDateFormat

useDefaultDateFormats

org.assertj.core.api
Class AbstractDateAssert<S extends AbstractDateAssert<S>>