Guide

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])
public annotation Guide

Annotates a field to provide a additional information when generating the field.

This is an experimental feature.

Summary

Public constructors
Guide(
    @NonNull String description,
    int maxItems,
    int minItems,
    double maximum,
    double minimum,
    @NonNull String[] enumValues
)

Public methods
final @NonNull String

Description of the field.
final @NonNull String[]

If the field is a String, this is the list of possible values for the field.
final int

If the field is a list, this is the maximum number of items to generate for a list.
final double

If the field is a Int, Long, Float, or Double, this is the maximum value of the field.
final int

If the field is a list, this is the minimum number of items to generate for a list.
final double

If the field is a Int, Long, Float, or Double, this is the minimum value of the field.

Public constructors

Guide

public Guide(
    @NonNull String description,
    int maxItems,
    int minItems,
    double maximum,
    double minimum,
    @NonNull String[] enumValues
)

Public methods

getDescription

public final @NonNull String getDescription()

Description of the field.

getEnumValues

public final @NonNull String[] getEnumValues()

If the field is a String, this is the list of possible values for the field.

getMaxItems

public final int getMaxItems()

If the field is a list, this is the maximum number of items to generate for a list. This must be greater than or equal to 0. A negative value will be ignored.

getMaximum

public final double getMaximum()

If the field is a Int, Long, Float, or Double, this is the maximum value of the field.

getMinItems

public final int getMinItems()

If the field is a list, this is the minimum number of items to generate for a list. This must be greater than or equal to 0. A negative value will be ignored.

getMinimum

public final double getMinimum()

If the field is a Int, Long, Float, or Double, this is the minimum value of the field.