org.assertj.core.api

Class AbstractLocalTimeAssert<S extends AbstractLocalTimeAssert<S>>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,java.time.LocalTime>

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

All Implemented Interfaces:

Assert<S,java.time.LocalTime>, Descriptable<S>, ExtensionPoints<S,java.time.LocalTime>

Direct Known Subclasses:

LocalTimeAssert

public abstract class AbstractLocalTimeAssert<S extends AbstractLocalTimeAssert<S>>
extends AbstractAssert<S,java.time.LocalTime>

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_LOCAL_TIME_PARAMETER_MESSAGE

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLocalTimeAssert(java.time.LocalTime actual, Class<?> selfType) Creates a new AbstractLocalTimeAssert.

Method Summary

Modifier and Type	Method and Description
protected java.time.LocalTime	getActual()
S	hasSameHourAs(java.time.LocalTime other) Verifies that actual and given LocalTime have same hour fields (minute, second and nanosecond fields are ignored in comparison).
S	isAfter(java.time.LocalTime other) Verifies that the actual LocalTime is strictly after the given one.
S	isAfter(String localTimeAsString) Same assertion as isAfter(LocalTime) but the LocalTime is built from given a String that must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isAfterOrEqualTo(java.time.LocalTime other) Verifies that the actual LocalTime is after or equals to the given one.
S	isAfterOrEqualTo(String localTimeAsString) Same assertion as isAfterOrEqualTo(LocalTime) but the LocalTime is built from given String, which must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isBefore(java.time.LocalTime other) Verifies that the actual LocalTime is strictly before the given one.
S	isBefore(String localTimeAsString) Same assertion as isBefore(LocalTime) but the LocalTime is built from given String, which must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isBeforeOrEqualTo(java.time.LocalTime other) Verifies that the actual LocalTime is before or equals to the given one.
S	isBeforeOrEqualTo(String localTimeAsString) Same assertion as isBeforeOrEqualTo(LocalTime) but the LocalTime is built from given String, which must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isEqualTo(String localTimeAsString) Same assertion as AbstractAssert.isEqualTo(Object) (where Object is expected to be LocalTime) but here you pass LocalTime String representation that must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isEqualToIgnoringNanos(java.time.LocalTime other) Verifies that actual and given LocalTime have same hour, minute and second fields (nanosecond fields are ignored in comparison).
S	isEqualToIgnoringSeconds(java.time.LocalTime other) Verifies that actual and given LocalTime have same hour and minute fields (second and nanosecond fields are ignored in comparison).
S	isIn(String... localTimesAsString) Same assertion as AbstractAssert.isIn(Object...) (where Objects are expected to be LocalTime) but here you pass LocalTime String representations that must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isNotEqualTo(String localTimeAsString) Same assertion as AbstractAssert.isNotEqualTo(Object) (where Object is expected to be LocalTime) but here you pass LocalTime String representation that must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.
S	isNotIn(String... localTimesAsString) Same assertion as AbstractAssert.isNotIn(Object...) (where Objects are expected to be LocalTime) but here you pass LocalTime String representations that must follow ISO LocalTime format to allow calling LocalTime.parse(CharSequence) method.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NULL_LOCAL_TIME_PARAMETER_MESSAGE

public static final String NULL_LOCAL_TIME_PARAMETER_MESSAGE

See Also:

Constant Field Values

Constructor Detail

AbstractLocalTimeAssert

protected AbstractLocalTimeAssert(java.time.LocalTime actual,
                                  Class<?> selfType)

Creates a new AbstractLocalTimeAssert.

Parameters:

selfType - the "self type"

actual - the actual value to verify

Method Detail

getActual

protected java.time.LocalTime getActual()

isBefore

public S isBefore(java.time.LocalTime other)

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

Example :

 assertThat(parse("12:00:00")).isBefore(parse("13:00:00"));
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

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

isBefore

public S isBefore(String localTimeAsString)

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

Example :

 // you can express expected LocalTime as String (AssertJ taking care of the conversion)
 assertThat(parse("12:59")).isBefore("13:00");
 

Parameters:

localTimeAsString - String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

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

isBeforeOrEqualTo

public S isBeforeOrEqualTo(java.time.LocalTime other)

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

Example :

 assertThat(parse("12:00:00")).isBeforeOrEqualTo(parse("12:00:00"))
                                        .isBeforeOrEqualTo(parse("12:00:01"));
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

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

isBeforeOrEqualTo

public S isBeforeOrEqualTo(String localTimeAsString)

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

Example :

 // you can express expected LocalTime as String (AssertJ taking care of the conversion)
 assertThat(parse("12:00:00")).isBeforeOrEqualTo("12:00:00")
                              .isBeforeOrEqualTo("13:00:00");
 

Parameters:

localTimeAsString - String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

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

isAfterOrEqualTo

public S isAfterOrEqualTo(java.time.LocalTime other)

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

Example :

 assertThat(parse("13:00:00")).isAfterOrEqualTo(parse("13:00:00"))
                              .isAfterOrEqualTo(parse("12:00:00"));
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

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

isAfterOrEqualTo

public S isAfterOrEqualTo(String localTimeAsString)

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

Example :

 // you can express expected LocalTime as String (AssertJ taking care of the conversion)
 assertThat(parse("13:00:00")).isAfterOrEqualTo("13:00:00")
                              .isAfterOrEqualTo("12:00:00");
 

Parameters:

localTimeAsString - String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

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

isAfter

public S isAfter(java.time.LocalTime other)

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

Example :

 assertThat(parse("13:00:00")).isAfter(parse("12:00:00"));
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

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

isAfter

public S isAfter(String localTimeAsString)

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

Example :

 // you can express expected LocalTime as String (AssertJ taking care of the conversion)
 assertThat(parse("13:00:00")).isAfter("12:00:00");
 

Parameters:

localTimeAsString - String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

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

isEqualTo

public S isEqualTo(String localTimeAsString)

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

Example :

 // you can express expected LocalTime as String (AssertJ taking care of the conversion)
 assertThat(parse("13:00:00")).isEqualTo("13:00:00");
 

Parameters:

localTimeAsString - String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

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

isNotEqualTo

public S isNotEqualTo(String localTimeAsString)

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

Example :

 // you can express expected LocalTime as String (AssertJ taking care of the conversion)
 assertThat(parse("13:00:00")).isNotEqualTo("12:00:00");
 

Parameters:

localTimeAsString - String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

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

isIn

public S isIn(String... localTimesAsString)

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

Example :

 // you can express expected LocalTimes as String (AssertJ taking care of the conversion)
 assertThat(parse("13:00:00")).isIn("12:00:00", "13:00:00");
 

Parameters:

localTimesAsString - String array representing LocalTimes.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

AssertionError - if the actual LocalTime is not in the LocalTimes built from given Strings.

isNotIn

public S isNotIn(String... localTimesAsString)

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

Example :

 // you can express expected LocalTimes as String (AssertJ taking care of the conversion)
 assertThat(parse("13:00:00")).isNotIn("12:00:00", "14:00:00");
 

Parameters:

localTimesAsString - Array of String representing a LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

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

AssertionError - if the actual LocalTime is in the LocalTimes built from given Strings.

isEqualToIgnoringNanos

public S isEqualToIgnoringNanos(java.time.LocalTime other)

Verifies that actual and given LocalTime have same hour, minute and second fields (nanosecond fields are ignored in comparison).

Assertion can fail with localTimes in same chronological nanosecond time window, e.g :

23:00:01.000000000 and 23:00:00.999999999.

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

Code example :

 // successfull assertions
 LocalTime localTime1 = LocalTime.of(12, 0, 1, 0);
 LocalTime localTime2 = LocalTime.of(12, 0, 1, 456);
 assertThat(localTime1).isEqualToIgnoringNanos(localTime2);
 
 // failing assertions (even if time difference is only 1ns)
 LocalTime localTimeA = LocalTime.of(12, 0, 1, 0);
 LocalTime localTimeB = LocalTime.of(12, 0, 0, 999999999);
 assertThat(localTimeA).isEqualToIgnoringNanos(localTimeB);
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

AssertionError - if the actual LocalTime is are not equal with nanoseconds ignored.

isEqualToIgnoringSeconds

public S isEqualToIgnoringSeconds(java.time.LocalTime other)

Verifies that actual and given LocalTime have same hour and minute fields (second and nanosecond fields are ignored in comparison).

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

23:01:00.000 and 23:00:59.000.

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

Code example :

 // successful assertions
 LocalTime localTime1 = LocalTime.of(23, 50, 0, 0);
 LocalTime localTime2 = LocalTime.of(23, 50, 10, 456);
 assertThat(localTime1).isEqualToIgnoringSeconds(localTime2);
 
 // failing assertions (even if time difference is only 1ms)
 LocalTime localTimeA = LocalTime.of(23, 50, 00, 000);
 LocalTime localTimeB = LocalTime.of(23, 49, 59, 999);
 assertThat(localTimeA).isEqualToIgnoringSeconds(localTimeB);
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

AssertionError - if the actual LocalTime is are not equal with second and nanosecond fields ignored.

hasSameHourAs

public S hasSameHourAs(java.time.LocalTime other)

Verifies that actual and given LocalTime have same hour fields (minute, second and nanosecond fields are ignored in comparison).

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

01:00:00.000 and 00:59:59.000.

Time difference is only 1s but hour fields differ.

Code example :

 // successful assertions
 LocalTime localTime1 = LocalTime.of(23, 50, 0, 0);
 LocalTime localTime2 = LocalTime.of(23, 00, 2, 7);
 assertThat(localTime1).hasSameHourAs(localTime2);
 
 // failing assertions (even if time difference is only 1ms)
 LocalTime localTimeA = LocalTime.of(01, 00, 00, 000);
 LocalTime localTimeB = LocalTime.of(00, 59, 59, 999);
 assertThat(localTimeA).hasSameHourAs(localTimeB);
 

Parameters:

other - the given LocalTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual LocalTime is null.

IllegalArgumentException - if other LocalTime is null.

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