org.assertj.jodatime.api

Class LocalDateTimeAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<LocalDateTimeAssert,org.joda.time.LocalDateTime>

org.assertj.jodatime.api.LocalDateTimeAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<LocalDateTimeAssert,org.joda.time.LocalDateTime>, org.assertj.core.api.Descriptable<LocalDateTimeAssert>, org.assertj.core.api.ExtensionPoints<LocalDateTimeAssert,org.joda.time.LocalDateTime>

public class LocalDateTimeAssert
extends org.assertj.core.api.AbstractAssert<LocalDateTimeAssert,org.joda.time.LocalDateTime>

Assertions fot Joda LocalDateTime type.

Author:

Paweł Stawicki, Joel Costigliola

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_LOCAL_DATE_TIME_PARAMETER_MESSAGE

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalDateTimeAssert(Class<LocalDateTimeAssert> selfType, org.joda.time.LocalDateTime actual) Creates a new LocalDateTimeAssert.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.joda.time.LocalDateTime	getActual()
LocalDateTimeAssert	isAfter(org.joda.time.LocalDateTime other) Verifies that the actual LocalDateTime is strictly after the given one.
LocalDateTimeAssert	isAfter(String localDateTimeAsString) Same assertion as isAfter(LocalDateTime) but the LocalDateTime is built from given a String that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isAfterOrEqualTo(org.joda.time.LocalDateTime other) Verifies that the actual LocalDateTime is after or equals to the given one.
LocalDateTimeAssert	isAfterOrEqualTo(String localDateTimeAsString) Same assertion as isAfterOrEqualTo(LocalDateTime) but the LocalDateTime is built from given String, which must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isBefore(org.joda.time.LocalDateTime other) Verifies that the actual LocalDateTime is strictly before the given one.
LocalDateTimeAssert	isBefore(String localDateTimeAsString) Same assertion as isBefore(LocalDateTime) but the LocalDateTime is built from given String, which must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isBeforeOrEqualTo(org.joda.time.LocalDateTime other) Verifies that the actual LocalDateTime is before or equals to the given one.
LocalDateTimeAssert	isBeforeOrEqualTo(String localDateTimeAsString) Same assertion as isBeforeOrEqualTo(LocalDateTime) but the LocalDateTime is built from given String, which must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isEqualTo(String dateTimeAsString) Same assertion as AbstractAssert.isEqualTo(Object) (where Object is expected to be LocalDateTime) but here you pass LocalDateTime String representation that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isEqualToIgnoringHours(org.joda.time.LocalDateTime other) Verifies that actual and given LocalDateTime have same year, month and day fields (hour, minute, second and millisecond fields are ignored in comparison).
LocalDateTimeAssert	isEqualToIgnoringMillis(org.joda.time.LocalDateTime other) Verifies that actual and given LocalDateTime have same year, month, day, hour, minute and second fields, (millisecond fields are ignored in comparison).
LocalDateTimeAssert	isEqualToIgnoringMinutes(org.joda.time.LocalDateTime other) Verifies that actual and given LocalDateTime have same year, month, day and hour fields (minute, second and millisecond fields are ignored in comparison).
LocalDateTimeAssert	isEqualToIgnoringSeconds(org.joda.time.LocalDateTime other) Verifies that actual and given LocalDateTime have same year, month, day, hour and minute fields (second and millisecond fields are ignored in comparison).
LocalDateTimeAssert	isIn(String... dateTimesAsString) Same assertion as AbstractAssert.isIn(Object...) (where Objects are expected to be LocalDateTime) but here you pass LocalDateTime String representations that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isNotEqualTo(String dateTimeAsString) Same assertion as AbstractAssert.isNotEqualTo(Object) (where Object is expected to be LocalDateTime) but here you pass LocalDateTime String representation that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.
LocalDateTimeAssert	isNotIn(String... dateTimesAsString) Same assertion as AbstractAssert.isNotIn(Object...) (where Objects are expected to be LocalDateTime) but here you pass LocalDateTime String representations that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NULL_LOCAL_DATE_TIME_PARAMETER_MESSAGE

public static final String NULL_LOCAL_DATE_TIME_PARAMETER_MESSAGE

See Also:

Constant Field Values

Constructor Detail

LocalDateTimeAssert

protected LocalDateTimeAssert(Class<LocalDateTimeAssert> selfType,
                   org.joda.time.LocalDateTime actual)

Creates a new LocalDateTimeAssert.

Parameters:

selfType - the "self type"

actual - the actual value to verify

Method Detail

getActual

protected org.joda.time.LocalDateTime getActual()

isBefore

public LocalDateTimeAssert isBefore(org.joda.time.LocalDateTime other)

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

Example :

 assertThat(new LocalDateTime("2000-01-01")).isBefore(new LocalDateTime("2000-01-02"));
 

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

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

isBefore

public LocalDateTimeAssert isBefore(String localDateTimeAsString)

Same assertion as isBefore(LocalDateTime) but the LocalDateTime is built from given String, which must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

Example :

 // use directly String in comparison to avoid a conversion
 assertThat(new LocalDateTime("2000-01-01")).isBefore("2000-01-02");
 

Parameters:

localDateTimeAsString - String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

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

isBeforeOrEqualTo

public LocalDateTimeAssert isBeforeOrEqualTo(org.joda.time.LocalDateTime other)

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

Example :

 assertThat(new LocalDateTime("2000-01-01")).isBeforeOrEqualTo(new LocalDateTime("2000-01-01"))
                                            .isBeforeOrEqualTo(new LocalDateTime("2000-01-02"));
 

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

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

isBeforeOrEqualTo

public LocalDateTimeAssert isBeforeOrEqualTo(String localDateTimeAsString)

Same assertion as isBeforeOrEqualTo(LocalDateTime) but the LocalDateTime is built from given String, which must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

Example :

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

Parameters:

localDateTimeAsString - String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

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

isAfterOrEqualTo

public LocalDateTimeAssert isAfterOrEqualTo(org.joda.time.LocalDateTime other)

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

Example :

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

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

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

isAfterOrEqualTo

public LocalDateTimeAssert isAfterOrEqualTo(String localDateTimeAsString)

Same assertion as isAfterOrEqualTo(LocalDateTime) but the LocalDateTime is built from given String, which must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

Example :

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

Parameters:

localDateTimeAsString - String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

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

isAfter

public LocalDateTimeAssert isAfter(org.joda.time.LocalDateTime other)

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

Example :

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

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

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

isAfter

public LocalDateTimeAssert isAfter(String localDateTimeAsString)

Same assertion as isAfter(LocalDateTime) but the LocalDateTime is built from given a String that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

Example :

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

Parameters:

localDateTimeAsString - String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

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

isEqualTo

public LocalDateTimeAssert isEqualTo(String dateTimeAsString)

Same assertion as AbstractAssert.isEqualTo(Object) (where Object is expected to be LocalDateTime) but here you pass LocalDateTime String representation that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

Example :

 // use directly String in comparison to avoid a conversion
 assertThat(new LocalDateTime("2000-01-01")).isEqualTo("2000-01-01");
 

Parameters:

dateTimeAsString - String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

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

isNotEqualTo

public LocalDateTimeAssert isNotEqualTo(String dateTimeAsString)

Same assertion as AbstractAssert.isNotEqualTo(Object) (where Object is expected to be LocalDateTime) but here you pass LocalDateTime String representation that must follow ISO DateTime format to allow calling LocalDateTime(Object) constructor.

Example :

 // use directly String in comparison to avoid a conversion
 assertThat(new LocalDateTime("2000-01-01")).isNotEqualTo("2000-01-15");
 

Parameters:

dateTimeAsString - String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

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

isIn

public LocalDateTimeAssert isIn(String... dateTimesAsString)

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

Example :

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

Parameters:

dateTimesAsString - String array representing LocalDateTimes.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

AssertionError - if the actual LocalDateTime is not in the LocalDateTimes built from given Strings.

isNotIn

public LocalDateTimeAssert isNotIn(String... dateTimesAsString)

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

Example :

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

Parameters:

dateTimesAsString - Array of String representing a LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

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

AssertionError - if the actual LocalDateTime is in the LocalDateTimes built from given Strings.

isEqualToIgnoringMillis

public LocalDateTimeAssert isEqualToIgnoringMillis(org.joda.time.LocalDateTime other)

Verifies that actual and given LocalDateTime have same year, month, day, hour, minute and second fields, (millisecond fields are ignored in comparison).

Assertion can fail with localDateTimes in same chronological millisecond time window, e.g :

2000-01-01T00:00:01.000 and 2000-01-01T00:00:00.999.

Assertion fails as second fields differ even if time difference is only 1ms.

Code example :

 // successfull assertions
 LocalDateTime localDateTime1 = new LocalDateTime(2000, 1, 1, 0, 0, 1, 0);
 LocalDateTime localDateTime2 = new LocalDateTime(2000, 1, 1, 0, 0, 1, 456);
 assertThat(localDateTime1).isEqualToIgnoringMillis(localDateTime2);
 
 // failing assertions (even if time difference is only 1ms)
 LocalDateTime localDateTimeA = new LocalDateTime(2000, 1, 1, 0, 0, 1, 0);
 LocalDateTime localDateTimeB = new LocalDateTime(2000, 1, 1, 0, 0, 0, 999);
 assertThat(localDateTimeA).isEqualToIgnoringMillis(localDateTimeB);
 

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

AssertionError - if the actual LocalDateTime is are not equal with milliseconds ignored.

isEqualToIgnoringSeconds

public LocalDateTimeAssert isEqualToIgnoringSeconds(org.joda.time.LocalDateTime other)

Verifies that actual and given LocalDateTime have same year, month, day, hour and minute fields (second and millisecond fields are ignored in comparison).

Assertion can fail with LocalDateTimes in same chronological second time window, e.g :

2000-01-01T00:01:00.000 and 2000-01-01T00:00:59.000.

Assertion fails as minute fields differ even if time difference is only 1s.

Code example :

 // successfull assertions
 LocalDateTime localDateTime1 = new LocalDateTime(2000, 1, 1, 23, 50, 0, 0);
 LocalDateTime localDateTime2 = new LocalDateTime(2000, 1, 1, 23, 50, 10, 456);
 assertThat(localDateTime1).isEqualToIgnoringSeconds(localDateTime2);
 
 // failing assertions (even if time difference is only 1ms)
 LocalDateTime localDateTimeA = new LocalDateTime(2000, 1, 1, 23, 50, 00, 000);
 LocalDateTime localDateTimeB = new LocalDateTime(2000, 1, 1, 23, 49, 59, 999);
 assertThat(localDateTimeA).isEqualToIgnoringSeconds(localDateTimeB);
 

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

AssertionError - if the actual LocalDateTime is are not equal with second and millisecond fields ignored.

isEqualToIgnoringMinutes

public LocalDateTimeAssert isEqualToIgnoringMinutes(org.joda.time.LocalDateTime other)

Verifies that actual and given LocalDateTime have same year, month, day and hour fields (minute, second and millisecond fields are ignored in comparison).

Assertion can fail with localDateTimes in same chronological second time window, e.g :

2000-01-01T01:00:00.000 and 2000-01-01T00:59:59.000.

Time difference is only 1s but hour fields differ.

Code example :

 // successfull assertions
 LocalDateTime localDateTime1 = new LocalDateTime(2000, 1, 1, 23, 50, 0, 0);
 LocalDateTime localDateTime2 = new LocalDateTime(2000, 1, 1, 23, 00, 2, 7);
 assertThat(localDateTime1).isEqualToIgnoringMinutes(localDateTime2);
 
 // failing assertions (even if time difference is only 1ms)
 LocalDateTime localDateTimeA = new LocalDateTime(2000, 1, 1, 01, 00, 00, 000);
 LocalDateTime localDateTimeB = new LocalDateTime(2000, 1, 1, 00, 59, 59, 999);
 assertThat(localDateTimeA).isEqualToIgnoringMinutes(localDateTimeB);
 

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

AssertionError - if the actual LocalDateTime is are not equal ignoring minute, second and millisecond fields.

isEqualToIgnoringHours

public LocalDateTimeAssert isEqualToIgnoringHours(org.joda.time.LocalDateTime other)

Verifies that actual and given LocalDateTime have same year, month and day fields (hour, minute, second and millisecond fields are ignored in comparison).

Assertion can fail with localDateTimes in same chronological minute time window, e.g :

2000-01-01T23:59:00.000 and 2000-01-02T00:00:00.000.

Time difference is only 1min but day fields differ.

Code example :

 // successfull assertions
 LocalDateTime localDateTime1 = new LocalDateTime(2000, 1, 1, 23, 59, 59, 999);
 LocalDateTime localDateTime2 = new LocalDateTime(2000, 1, 1, 00, 00, 00, 000);
 assertThat(localDateTime1).isEqualToIgnoringHours(localDateTime2);
 
 // failing assertions (even if time difference is only 1ms)
 LocalDateTime localDateTimeA = new LocalDateTime(2000, 1, 2, 00, 00, 00, 000);
 LocalDateTime localDateTimeB = new LocalDateTime(2000, 1, 1, 23, 59, 59, 999);
 assertThat(localDateTimeA).isEqualToIgnoringHours(localDateTimeB);
 

Parameters:

other - the given LocalDateTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalDateTime is null.

IllegalArgumentException - if other LocalDateTime is null.

AssertionError - if the actual LocalDateTime is are not equal with second and millisecond fields ignored.