Package org.assertj.core.api

Class AbstractOffsetTimeAssert<SELF extends AbstractOffsetTimeAssert<SELF>>

java.lang.Object
org.assertj.core.api.AbstractAssert<SELF,OffsetTime>
org.assertj.core.api.AbstractTemporalAssert<SELF,OffsetTime>
org.assertj.core.api.AbstractOffsetTimeAssert<SELF>
All Implemented Interfaces:
Assert<SELF,OffsetTime>, Descriptable<SELF>, ExtensionPoints<SELF,OffsetTime>
Direct Known Subclasses:
OffsetTimeAssert
public abstract class AbstractOffsetTimeAssert<SELF extends AbstractOffsetTimeAssert<SELF>> extends AbstractTemporalAssert<SELF,OffsetTime>
Assertions for OffsetTime type from new Date & Time API introduced in Java 8.
Author:
Alexander Bischof

  • Field Details

  • Constructor Details

    • AbstractOffsetTimeAssert

      protected AbstractOffsetTimeAssert(OffsetTime actual, Class<?> selfType)
      Creates a new AbstractOffsetTimeAssert.
      Parameters:
      actual - the actual value to verify
      selfType - the "self type"

  • Method Details

    • isBefore

      public SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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

      @Deprecated public SELF isEqualToIgnoringNanos(OffsetTime other)
      Deprecated.
      Use isCloseTo(OffsetTime, TemporalOffset) instead, although not exactly the same semantics, this is the right way to compare with a given precision.
      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

      @Deprecated public SELF isEqualToIgnoringSeconds(OffsetTime other)
      Deprecated.
      Use isCloseTo(OffsetTime, TemporalOffset) instead, although not exactly the same semantics, this is the right way to compare with a given precision.
      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 SELF 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 SELF 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.

    • isBetween

      public SELF isBetween(OffsetTime startInclusive, OffsetTime endInclusive)
      Verifies that the actual OffsetTime is in the [start, end] period (start and end included).

      Example: 

       OffsetTime offsetTime = OffsetTime.now();

 // assertions succeed:
 assertThat(offsetTime).isBetween(offsetTime.minusSeconds(1), offsetTime.plusSeconds(1))
                       .isBetween(offsetTime, offsetTime.plusSeconds(1))
                       .isBetween(offsetTime.minusSeconds(1), offsetTime)
                       .isBetween(offsetTime, offsetTime);

 // assertions fail:
 assertThat(offsetTime).isBetween(offsetTime.minusSeconds(10), offsetTime.minusSeconds(1));
 assertThat(offsetTime).isBetween(offsetTime.plusSeconds(1), offsetTime.plusSeconds(10));
      Parameters:
      startInclusive - the start value (inclusive), expected not to be null.
      endInclusive - the end value (inclusive), expected not to be null.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual value is null.
      NullPointerException - if start value is null.
      NullPointerException - if end value is null.
      AssertionError - if the actual value is not in [start, end] period.
      Since:
      3.7.1

    • isBetween

      public SELF isBetween(String startInclusive, String endInclusive)
      Same assertion as isBetween(OffsetTime, OffsetTime) but here you pass OffsetTime String representations which must follow ISO OffsetTime format to allow calling OffsetTime.parse(CharSequence) method.

      Example: 

       OffsetTime oneAm = OffsetTime.parse("01:00:00+02:00");

 // assertions succeed:
 assertThat(oneAm).isBetween("00:59:59+02:00", "01:00:01+02:00")
                  .isBetween("01:00:00+02:00", "01:00:01+02:00")
                  .isBetween("00:59:59+02:00", "01:00:00+02:00")
                  .isBetween("01:00:00+02:00", "01:00:00+02:00")

 // assertion fails:
 assertThat(oneAm).isBetween("01:00:01+02:00", "02:00:01+02:00");
      Parameters:
      startInclusive - the start value (inclusive), expected not to be null.
      endInclusive - the end value (inclusive), expected not to be null.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual value is null.
      NullPointerException - if start value is null.
      NullPointerException - if end value is null.
      DateTimeParseException - if any of the given String can't be converted to a OffsetTime.
      AssertionError - if the actual value is not in [start, end] period.
      Since:
      3.7.1

    • isStrictlyBetween

      public SELF isStrictlyBetween(OffsetTime startExclusive, OffsetTime endExclusive)
      Verifies that the actual OffsetTime is in the ]start, end[ period (start and end excluded).

      Example: 

       OffsetTime offsetTime = OffsetTime.now();

 // assertion succeeds:
 assertThat(offsetTime).isStrictlyBetween(offsetTime.minusSeconds(1), offsetTime.plusSeconds(1));

 // assertions fail:
 assertThat(offsetTime).isStrictlyBetween(offsetTime.minusSeconds(10), offsetTime.minusSeconds(1));
 assertThat(offsetTime).isStrictlyBetween(offsetTime.plusSeconds(1), offsetTime.plusSeconds(10));
 assertThat(offsetTime).isStrictlyBetween(offsetTime, offsetTime.plusSeconds(1));
 assertThat(offsetTime).isStrictlyBetween(offsetTime.minusSeconds(1), offsetTime);
      Parameters:
      startExclusive - the start value (exclusive), expected not to be null.
      endExclusive - the end value (exclusive), expected not to be null.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual value is null.
      NullPointerException - if start value is null.
      NullPointerException - if end value is null.
      AssertionError - if the actual value is not in ]start, end[ period.
      Since:
      3.7.1

    • isStrictlyBetween

      public SELF isStrictlyBetween(String startExclusive, String endExclusive)
      Same assertion as isStrictlyBetween(OffsetTime, OffsetTime) but here you pass OffsetTime String representations which must follow ISO OffsetTime format to allow calling OffsetTime.parse(CharSequence) method.

      Example: 

       OffsetTime oneAm = OffsetTime.parse("01:00:00+02:00");

 // assertion succeeds:
 assertThat(oneAm).isStrictlyBetween("00:59:59+02:00", "01:00:01+02:00");

 // assertions fail:
 assertThat(oneAm).isStrictlyBetween("02:00:00+02:00", "03:00:00+02:00");
 assertThat(oneAm).isStrictlyBetween("00:59:59+02:00", "01:00:00+02:00");
 assertThat(oneAm).isStrictlyBetween("01:00:00+02:00", "01:00:01+02:00");
      Parameters:
      startExclusive - the start value (exclusive), expected not to be null.
      endExclusive - the end value (exclusive), expected not to be null.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual value is null.
      NullPointerException - if start value is null.
      NullPointerException - if end value is null.
      DateTimeParseException - if any of the given String can't be converted to a OffsetTime.
      AssertionError - if the actual value is not in ]start, end[ period.
      Since:
      3.7.1

    • isCloseTo

      public SELF isCloseTo(OffsetTime other, TemporalOffset<? super OffsetTime> offset)
      Verifies that the actual OffsetTime is close to the other according to the given TemporalOffset.

      You can build the offset parameter using Assertions.within(long, TemporalUnit) or Assertions.byLessThan(long, TemporalUnit).

      Example: 

       OffsetTime oneAm = OffsetTime.parse("01:00:00+02:00");

 // assertion succeeds:
 assertThat(oneAm).isCloseTo(oneAm.plusHours(1), within(30, ChronoUnit.MINUTES));

 // assertion fails:
 assertThat(oneAm).isCloseTo(_07_42, within(10, ChronoUnit.SECONDS));
      Overrides:
      isCloseTo in class AbstractTemporalAssert<SELF extends AbstractOffsetTimeAssert<SELF>,OffsetTime>
      Parameters:
      other - the offsetTime to compare actual to
      offset - the offset used for comparison
      Returns:
      this assertion object
      Throws:
      NullPointerException - if OffsetTime or TemporalOffset parameter is null.
      AssertionError - if the actual OffsetTime is null.
      AssertionError - if the actual OffsetTime is not close to the given one within the provided offset.

    • parse

      protected OffsetTime parse(String offsetTimeAsString)
      Obtains an instance of TEMPORAL from a string representation in ISO date format.
      Specified by:
      parse in class AbstractTemporalAssert<SELF extends AbstractOffsetTimeAssert<SELF>,OffsetTime>
      Parameters:
      offsetTimeAsString - the string to parse, not null
      Returns:
      the parsed TEMPORAL, not null