Package net.jqwik.time.api.arbitraries

Interface InstantArbitrary

  • All Superinterfaces:
    Arbitrary<java.time.Instant>
    @API(status=EXPERIMENTAL,
     since="1.5.4")
public interface InstantArbitrary
extends Arbitrary<java.time.Instant>
    Fluent interface to configure the generation of instant values. All generated instants use the Gregorian Calendar, even if they are before October 15, 1582. By default, instants with years between 1900 and 2500 are generated. Max possible year is 999_999_999.

    • Method Detail

      • between

        default InstantArbitrary between​(java.time.Instant min,
                                 java.time.Instant max)
        Set the allowed lower min (included) and upper max (included) bounder of generated instant values. If you don't explicitly set the precision and use min/max values with precision milliseconds/microseconds/nanoseconds, the precision of your min/max value is implicitly set.

      • atTheEarliest

        InstantArbitrary atTheEarliest​(java.time.Instant min)
        Set the allowed lower min (included) bounder of generated instant values. If you don't explicitly set the precision and use min/max values with precision milliseconds/microseconds/nanoseconds, the precision of your min/max value is implicitly set.

      • atTheLatest

        InstantArbitrary atTheLatest​(java.time.Instant max)
        Set the allowed upper max (included) bounder of generated instant values. If you don't explicitly set the precision and use min/max values with precision milliseconds/microseconds/nanoseconds, the precision of your min/max value is implicitly set.

      • dateBetween

        InstantArbitrary dateBetween​(java.time.LocalDate min,
                             java.time.LocalDate max)
        Set the allowed lower min (included) and upper max (included) bounder of generated local date values.

      • yearBetween

        InstantArbitrary yearBetween​(java.time.Year min,
                             java.time.Year max)
        Set the allowed lower min (included) and upper max (included) bounder of generated year values. The years can be between 1 and Year.MAX_VALUE.

        Calling this method is equivalent to calling dateBetween(LocalDate, LocalDate) assuming Jan 1 and Dec 31 as first and last day of those years.

      • yearBetween

        default InstantArbitrary yearBetween​(int min,
                                     int max)
        Set the allowed lower min (included) and upper max (included) bounder of generated year values. The int values can be between 1 and Year.MAX_VALUE.

        Calling this method is equivalent to calling dateBetween(LocalDate, LocalDate) assuming Jan 1 and Dec 31 as first and last day of those years.

      • monthBetween

        InstantArbitrary monthBetween​(java.time.Month min,
                              java.time.Month max)
        Set the allowed lower min (included) and upper max (included) bounder of generated month values.

      • monthBetween

        default InstantArbitrary monthBetween​(int min,
                                      int max)
        Set the allowed lower min (included) and upper max (included) bounder of generated month values. The int values can be between 1 and 12.

      • onlyMonths

        InstantArbitrary onlyMonths​(java.time.Month... months)
        Set an array of allowed months.

      • dayOfMonthBetween

        InstantArbitrary dayOfMonthBetween​(int min,
                                   int max)
        Set the allowed lower min (included) and upper max (included) bounder of generated day of month values. The int values can be between 1 and 31.

      • onlyDaysOfWeek

        InstantArbitrary onlyDaysOfWeek​(java.time.DayOfWeek... daysOfWeek)
        Set an array of allowed daysOfWeek.

      • timeBetween

        InstantArbitrary timeBetween​(java.time.LocalTime min,
                             java.time.LocalTime max)
        Set the allowed lower min (included) and upper max (included) bounder of generated local time values. If you don't explicitly set the precision and use min/max values with precision milliseconds/microseconds/nanoseconds, the precision of your min/max value is implicitly set.

      • hourBetween

        InstantArbitrary hourBetween​(int min,
                             int max)
        Set the allowed lower min (included) and upper max (included) bounder of generated hour values. The hours can be between 0 and 23.

      • minuteBetween

        InstantArbitrary minuteBetween​(int min,
                               int max)
        Set the allowed lower min (included) and upper max (included) bounder of generated minute values. The minutes can be between 0 and 59.

      • secondBetween

        InstantArbitrary secondBetween​(int min,
                               int max)
        Set the allowed lower min (included) and upper max (included) bounder of generated second values. The minutes can be between 0 and 59.

      • ofPrecision

        InstantArbitrary ofPrecision​(java.time.temporal.ChronoUnit ofPrecision)
        Constrain the precision of generated values. Default value: Seconds. If you don't explicitly set the precision and use min/max values with precision milliseconds/microseconds/nanoseconds, the precision of your min/max value is implicitly set.