GenerableDetail.GuideDetail

public final class GenerableDetail.GuideDetail

Holds the details of a single property in a Generable class, including its metadata and constraints specified by the Guide annotation.

Summary

Public constructors
GuideDetail(
    @NonNull String name,
    @NonNull KClass<@NonNull ?> type,
    boolean nullable,
    String description,
    Integer maxItems,
    Integer minItems,
    Double maximum,
    Double minimum,
    String[] enumValues,
    boolean isList,
    KClass<@NonNull ?> listItemType
)

Public methods
final String

Description of the field, matching Guide.description.
final String[]

Possible enum values, matching Guide.enumValues.
final KClass<@NonNull ?>

The class type of the list items, if the property is a list.
final Integer

Maximum number of items, matching Guide.maxItems.
final Double

Maximum value, matching Guide.maximum.
final Integer

Minimum number of items, matching Guide.minItems.
final Double

Minimum value, matching Guide.minimum.
final @NonNull String

The name of the property.
final boolean

Whether the property is nullable.
final @NonNull KClass<@NonNull ?>

The class type of the property.
final boolean

Whether the property is a list.

Public constructors

GuideDetail

public GuideDetail(
    @NonNull String name,
    @NonNull KClass<@NonNull ?> type,
    boolean nullable,
    String description,
    Integer maxItems,
    Integer minItems,
    Double maximum,
    Double minimum,
    String[] enumValues,
    boolean isList,
    KClass<@NonNull ?> listItemType
)

Public methods

getDescription

public final String getDescription()

Description of the field, matching Guide.description.

getEnumValues

public final String[] getEnumValues()

Possible enum values, matching Guide.enumValues.

getListItemType

public final KClass<@NonNull ?> getListItemType()

The class type of the list items, if the property is a list.

getMaxItems

public final Integer getMaxItems()

Maximum number of items, matching Guide.maxItems.

getMaximum

public final Double getMaximum()

Maximum value, matching Guide.maximum.

getMinItems

public final Integer getMinItems()

Minimum number of items, matching Guide.minItems.

getMinimum

public final Double getMinimum()

Minimum value, matching Guide.minimum.

getName

public final @NonNull String getName()

The name of the property.

getNullable

public final boolean getNullable()

Whether the property is nullable.

getType

public final @NonNull KClass<@NonNull ?> getType()

The class type of the property.

isList

public final boolean isList()

Whether the property is a list.