Class PeriodGenerator
java.lang.Object
org.instancio.internal.generator.AbstractGenerator<Period>
org.instancio.internal.generator.time.PeriodGenerator
- All Implemented Interfaces:
Generator<Period>
,GeneratorSpec<Period>
,NullableGeneratorSpec<Period>
,PeriodGeneratorSpec
,PeriodSpec
,ValueSpec<Period>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the public API method name of the generator spec.days
(int min, int max) Generate number ofPeriod
days in the given range.months
(int min, int max) Generate number ofPeriod
months in the given range.nullable()
Indicates thatnull
value can be generated.protected Period
tryGenerateNonNull
(Random random) Makes the best effort to return a non-null value.years
(int min, int max) Generate number ofPeriod
years in the given range.Methods inherited from class org.instancio.internal.generator.AbstractGenerator
generate, getContext, hints, isNullable, nullable
-
Constructor Details
-
PeriodGenerator
public PeriodGenerator() -
PeriodGenerator
-
-
Method Details
-
apiMethod
Description copied from class:AbstractGenerator
Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.- Specified by:
apiMethod
in classAbstractGenerator<Period>
- Returns:
- spec name if defined, or
null
otherwise
-
days
Description copied from interface:PeriodGeneratorSpec
Generate number ofPeriod
days in the given range.- Specified by:
days
in interfacePeriodGeneratorSpec
- Specified by:
days
in interfacePeriodSpec
- Parameters:
min
- minimum number of days (inclusive)max
- maximum number of days (inclusive)- Returns:
- spec builder
-
months
Description copied from interface:PeriodGeneratorSpec
Generate number ofPeriod
months in the given range.- Specified by:
months
in interfacePeriodGeneratorSpec
- Specified by:
months
in interfacePeriodSpec
- Parameters:
min
- minimum number of months (inclusive)max
- maximum number of months (inclusive)- Returns:
- spec builder
-
years
Description copied from interface:PeriodGeneratorSpec
Generate number ofPeriod
years in the given range.- Specified by:
years
in interfacePeriodGeneratorSpec
- Specified by:
years
in interfacePeriodSpec
- Parameters:
min
- minimum number of years (inclusive)max
- maximum number of years (inclusive)- Returns:
- spec builder
-
nullable
Description copied from interface:NullableGeneratorSpec
Indicates thatnull
value can be generated.- Specified by:
nullable
in interfaceNullableGeneratorSpec<Period>
- Specified by:
nullable
in interfaceValueSpec<Period>
- Overrides:
nullable
in classAbstractGenerator<Period>
- Returns:
- spec builder
-
tryGenerateNonNull
Description copied from class:AbstractGenerator
Makes the best effort to return a non-null value. However, in certain cases this method will produce anull
.- Specified by:
tryGenerateNonNull
in classAbstractGenerator<Period>
- Parameters:
random
- for generating the value- Returns:
- generated value, either a null or non-null
-