Package net.jqwik.time.api.arbitraries

Interface YearMonthArbitrary

All Superinterfaces:

Arbitrary<java.time.YearMonth>

@API(status=EXPERIMENTAL,
     since="1.4.0")
public interface YearMonthArbitrary
extends Arbitrary<java.time.YearMonth>

Fluent interface to configure the generation of year and month values. By default, year and months 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	Description
YearMonthArbitrary	atTheEarliest(java.time.YearMonth min)	Set the allowed lower min (included) bounder of generated year and month values.
YearMonthArbitrary	atTheLatest(java.time.YearMonth max)	Set the allowed upper max (included) bounder of generated year and month values.
default YearMonthArbitrary	between(java.time.YearMonth min, java.time.YearMonth max)	Set the allowed lower min (included) and upper max (included) bounder of generated year and month values.
YearMonthArbitrary	leapYears(boolean withLeapYears)	Decide whether leap years are generated or not
default YearMonthArbitrary	monthBetween(int min, int max)	Set the allowed lower min (included) and upper max (included) bounder of generated month values.
YearMonthArbitrary	monthBetween(java.time.Month min, java.time.Month max)	Set the allowed lower min (included) and upper max (included) bounder of generated month values.
YearMonthArbitrary	onlyMonths(java.time.Month... months)	Set an array of allowed months.
default YearMonthArbitrary	yearBetween(int min, int max)	Set the allowed lower min (included) and upper max (included) bounder of generated year values.
YearMonthArbitrary	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, fixGenSize, flatMap, forEachValue, generator, generator, generatorWithEmbeddedEdgeCases, ignoreException, injectDuplicates, injectNull, iterator, list, map, optional, sample, sampleStream, set, stream, tuple1, tuple2, tuple3, tuple4, tuple5, withoutEdgeCases

Method Detail

between

default YearMonthArbitrary between(java.time.YearMonth min,
                                   java.time.YearMonth max)

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

atTheEarliest

YearMonthArbitrary atTheEarliest(java.time.YearMonth min)

Set the allowed lower min (included) bounder of generated year and month values.

atTheLatest

YearMonthArbitrary atTheLatest(java.time.YearMonth max)

Set the allowed upper max (included) bounder of generated year and month values.

yearBetween

YearMonthArbitrary 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 values can be between 1 and Year.MAX_VALUE.

yearBetween

default YearMonthArbitrary 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.

monthBetween

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

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

Set an array of allowed months.

leapYears

YearMonthArbitrary leapYears(boolean withLeapYears)

Decide whether leap years are generated or not