net.jqwik.time.api.arbitraries

Interface OffsetDateTimeArbitrary

All Superinterfaces:

Arbitrary<java.time.OffsetDateTime>

@API(status=EXPERIMENTAL,
     since="1.5.5")
public interface OffsetDateTimeArbitrary
extends Arbitrary<java.time.OffsetDateTime>

Fluent interface to configure the generation of offset date time values. All generated offset date times use the Gregorian Calendar, even if they are before October 15, 1582. By default, offset date times with years between 1900 and 2500 are generated.

Nested Class Summary

Nested classes/interfaces inherited from interface net.jqwik.api.Arbitrary

Arbitrary.ArbitraryFacade

Method Summary

Modifier and Type	Method and Description
OffsetDateTimeArbitrary	atTheEarliest(java.time.LocalDateTime min) Set the allowed lower min (included) bounder of the local part of generated offset date time values.
OffsetDateTimeArbitrary	atTheLatest(java.time.LocalDateTime max) Set the allowed upper max (included) bounder of the local part of generated offset date time values.
default OffsetDateTimeArbitrary	between(java.time.LocalDateTime min, java.time.LocalDateTime max) Set the allowed lower min (included) and upper max (included) bounder of the local part of generated offset date time values.
OffsetDateTimeArbitrary	dateBetween(java.time.LocalDate min, java.time.LocalDate max) Set the allowed lower min (included) and upper max (included) bounder of generated offset date values.
OffsetDateTimeArbitrary	dayOfMonthBetween(int min, int max) Set the allowed lower min (included) and upper max (included) bounder of generated day of month values.
OffsetDateTimeArbitrary	hourBetween(int min, int max) Set the allowed lower min (included) and upper max (included) bounder of generated hour values.
OffsetDateTimeArbitrary	minuteBetween(int min, int max) Set the allowed lower min (included) and upper max (included) bounder of generated minute values.
default OffsetDateTimeArbitrary	monthBetween(int min, int max) Set the allowed lower min (included) and upper max (included) bounder of generated month values.
OffsetDateTimeArbitrary	monthBetween(java.time.Month min, java.time.Month max) Set the allowed lower min (included) and upper max (included) bounder of generated month values.
OffsetDateTimeArbitrary	offsetBetween(java.time.ZoneOffset min, java.time.ZoneOffset max) Set the allowed lower min (included) and upper max (included) bounder of generated offset values.
OffsetDateTimeArbitrary	ofPrecision(java.time.temporal.ChronoUnit ofPrecision) Constrain the precision of generated values.
OffsetDateTimeArbitrary	onlyDaysOfWeek(java.time.DayOfWeek... daysOfWeek) Set an array of allowed daysOfWeek.
OffsetDateTimeArbitrary	onlyMonths(java.time.Month... months) Set an array of allowed months.
OffsetDateTimeArbitrary	secondBetween(int min, int max) Set the allowed lower min (included) and upper max (included) bounder of generated second values.
OffsetDateTimeArbitrary	timeBetween(java.time.LocalTime min, java.time.LocalTime max) Set the allowed lower min (included) and upper max (included) bounder of generated offset time values.
default OffsetDateTimeArbitrary	yearBetween(int min, int max) Set the allowed lower min (included) and upper max (included) bounder of generated year values.
OffsetDateTimeArbitrary	yearBetween(java.time.Year min, java.time.Year max) Set the allowed lower min (included) and upper max (included) bounder of generated year values.

Methods inherited from interface net.jqwik.api.Arbitrary

allValues, array, asGeneric, collect, dontShrink, edgeCases, edgeCases, edgeCases, exhaustive, exhaustive, filter, filter, fixGenSize, flatMap, forEachValue, generator, generator, generatorWithEmbeddedEdgeCases, ignoreException, ignoreException, ignoreExceptions, ignoreExceptions, injectDuplicates, injectNull, isGeneratorMemoizable, iterator, list, map, optional, optional, sample, sampleStream, set, stream, tuple1, tuple2, tuple3, tuple4, tuple5, withoutEdgeCases

Method Detail

between

default OffsetDateTimeArbitrary between(java.time.LocalDateTime min,
                                        java.time.LocalDateTime max)

Set the allowed lower min (included) and upper max (included) bounder of the local part of generated offset date 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.

atTheEarliest

OffsetDateTimeArbitrary atTheEarliest(java.time.LocalDateTime min)

Set the allowed lower min (included) bounder of the local part of generated offset date 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.

atTheLatest

OffsetDateTimeArbitrary atTheLatest(java.time.LocalDateTime max)

Set the allowed upper max (included) bounder of the local part of generated offset date 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.

dateBetween

OffsetDateTimeArbitrary dateBetween(java.time.LocalDate min,
                                    java.time.LocalDate max)

Set the allowed lower min (included) and upper max (included) bounder of generated offset date values.

yearBetween

OffsetDateTimeArbitrary 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 OffsetDateTimeArbitrary 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

OffsetDateTimeArbitrary 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 OffsetDateTimeArbitrary 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

OffsetDateTimeArbitrary onlyMonths(java.time.Month... months)

Set an array of allowed months.

dayOfMonthBetween

OffsetDateTimeArbitrary 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

OffsetDateTimeArbitrary onlyDaysOfWeek(java.time.DayOfWeek... daysOfWeek)

Set an array of allowed daysOfWeek.

timeBetween

OffsetDateTimeArbitrary timeBetween(java.time.LocalTime min,
                                    java.time.LocalTime max)

Set the allowed lower min (included) and upper max (included) bounder of generated offset 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

OffsetDateTimeArbitrary 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

OffsetDateTimeArbitrary 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

OffsetDateTimeArbitrary 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.

offsetBetween

OffsetDateTimeArbitrary offsetBetween(java.time.ZoneOffset min,
                                      java.time.ZoneOffset max)

Set the allowed lower min (included) and upper max (included) bounder of generated offset values. The offsets can be between -12:00:00 and +14:00:00.

ofPrecision

OffsetDateTimeArbitrary 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.