org.assertj.core.api

Class AbstractOffsetTimeAssert<S extends AbstractOffsetTimeAssert<S>>

java.lang.Object

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

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

All Implemented Interfaces:

Assert<S,OffsetTime>, Descriptable<S>, ExtensionPoints<S,OffsetTime>

Direct Known Subclasses:

OffsetTimeAssert

public abstract class AbstractOffsetTimeAssert<S extends AbstractOffsetTimeAssert<S>>
extends AbstractAssert<S,OffsetTime>

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

Author:

Alexander Bischof

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_OFFSET_TIME_PARAMETER_MESSAGE

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

actual, info, myself

Constructor Summary

Constructors

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

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NULL_OFFSET_TIME_PARAMETER_MESSAGE

public static final String NULL_OFFSET_TIME_PARAMETER_MESSAGE

See Also:

Constant Field Values

Constructor Detail

AbstractOffsetTimeAssert

protected AbstractOffsetTimeAssert(OffsetTime actual,
                                   Class<?> selfType)

Creates a new AbstractOffsetTimeAssert.

Parameters:

selfType - the "self type"

actual - the actual value to verify

Method Detail

getActual

protected OffsetTime getActual()

isBefore

public S isBefore(OffsetTime other)

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

Example :

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

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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

isBefore

public S isBefore(String offsetTimeAsString)

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

Example :

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

Parameters:

offsetTimeAsString - String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

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

isBeforeOrEqualTo

public S isBeforeOrEqualTo(OffsetTime other)

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

Example :

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

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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

isBeforeOrEqualTo

public S isBeforeOrEqualTo(String offsetTimeAsString)

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

Example :

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

Parameters:

offsetTimeAsString - String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

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

isAfterOrEqualTo

public S isAfterOrEqualTo(OffsetTime other)

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

Example :

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

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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

isAfterOrEqualTo

public S isAfterOrEqualTo(String offsetTimeAsString)

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

Example :

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

Parameters:

offsetTimeAsString - String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

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

isAfter

public S isAfter(OffsetTime other)

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

Example :

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

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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

isAfter

public S isAfter(String offsetTimeAsString)

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

Example :

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

Parameters:

offsetTimeAsString - String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

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

isEqualTo

public S isEqualTo(String offsetTimeAsString)

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

Example :

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

Parameters:

offsetTimeAsString - String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

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

isNotEqualTo

public S isNotEqualTo(String offsetTimeAsString)

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

Example :

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

Parameters:

offsetTimeAsString - String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

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

isIn

public S isIn(String... offsetTimesAsString)

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

Example :

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

Parameters:

offsetTimesAsString - String array representing OffsetTimes.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

AssertionError - if the actual OffsetTime is not in the OffsetTimes built from given Strings.

isNotIn

public S isNotIn(String... offsetTimesAsString)

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

Example :

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

Parameters:

offsetTimesAsString - Array of String representing a OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

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

AssertionError - if the actual OffsetTime is in the OffsetTimes built from given Strings.

isEqualToIgnoringNanos

public S isEqualToIgnoringNanos(OffsetTime other)

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

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

23:00:01.000000000+01:00 and 23:00:00.999999999+01:00.

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

Code example :

 // successful assertions
 OffsetTime OffsetTime1 = OffsetTime.of(12, 0, 1, 0, ZoneOffset.UTC);
 OffsetTime OffsetTime2 = OffsetTime.of(12, 0, 1, 456, ZoneOffset.UTC);
 assertThat(OffsetTime1).isEqualToIgnoringNanos(OffsetTime2);
 
 // failing assertions (even if time difference is only 1ns)
 OffsetTime OffsetTimeA = OffsetTime.of(12, 0, 1, 0, ZoneOffset.UTC);
 OffsetTime OffsetTimeB = OffsetTime.of(12, 0, 0, 999999999, ZoneOffset.UTC);
 assertThat(OffsetTimeA).isEqualToIgnoringNanos(OffsetTimeB);

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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

isEqualToIgnoringSeconds

public S isEqualToIgnoringSeconds(OffsetTime other)

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

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

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

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

Code example :

 // successful assertions
 OffsetTime OffsetTime1 = OffsetTime.of(23, 50, 0, 0, ZoneOffset.UTC);
 OffsetTime OffsetTime2 = OffsetTime.of(23, 50, 10, 456, ZoneOffset.UTC);
 assertThat(OffsetTime1).isEqualToIgnoringSeconds(OffsetTime2);
 
 // failing assertions (even if time difference is only 1ms)
 OffsetTime OffsetTimeA = OffsetTime.of(23, 50, 00, 000, ZoneOffset.UTC);
 OffsetTime OffsetTimeB = OffsetTime.of(23, 49, 59, 999, ZoneOffset.UTC);
 assertThat(OffsetTimeA).isEqualToIgnoringSeconds(OffsetTimeB);

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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

isEqualToIgnoringTimezone

public S isEqualToIgnoringTimezone(OffsetTime other)

Verifies that actual and given OffsetTime have same hour, minute, second and nanosecond fields).

Code examples :

 // successful assertions
 OffsetTime offsetTime = OffsetTime.of(12, 0, 0, 0, ZoneOffset.UTC);
 OffsetTime offsetTime2 = OffsetTime.of(12, 0, 0, 0, ZoneOffset.MAX);
 assertThat(offsetTime).isEqualToIgnoringTimezone(offsetTime2);
 
 // failing assertions (even if time difference is only 1ms)
 OffsetTime offsetTime = OffsetTime.of(12, 0, 0, 0, ZoneOffset.UTC);
 OffsetTime offsetTime2 = OffsetTime.of(12, 1, 0, 0, ZoneOffset.UTC);
 assertThat(offsetTime).isEqualToIgnoringTimezone(offsetTime2); 

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

AssertionError - if the actual OffsetTime is not equal with timezone ignored.

hasSameHourAs

public S hasSameHourAs(OffsetTime other)

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

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

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

Time difference is only 1s but hour fields differ.

Code example :

 // successful assertions
 OffsetTime OffsetTime1 = OffsetTime.of(23, 50, 0, 0, ZoneOffset.UTC);
 OffsetTime OffsetTime2 = OffsetTime.of(23, 00, 2, 7, ZoneOffset.UTC);
 assertThat(OffsetTime1).hasSameHourAs(OffsetTime2);
 
 // failing assertions (even if time difference is only 1ms)
 OffsetTime OffsetTimeA = OffsetTime.of(01, 00, 00, 000, ZoneOffset.UTC);
 OffsetTime OffsetTimeB = OffsetTime.of(00, 59, 59, 999, ZoneOffset.UTC);
 assertThat(OffsetTimeA).hasSameHourAs(OffsetTimeB); 

Parameters:

other - the given OffsetTime.

Returns:

this assertion object.

Throws:

AssertionError - if the actual OffsetTime is null.

IllegalArgumentException - if other OffsetTime is null.

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