Package org.springframework.ai.util.json.schema

Enum Class JsonSchemaGenerator.SchemaOption

java.lang.Object

java.lang.Enum<JsonSchemaGenerator.SchemaOption>

org.springframework.ai.util.json.schema.JsonSchemaGenerator.SchemaOption

All Implemented Interfaces:

Serializable, Comparable<JsonSchemaGenerator.SchemaOption>, Constable

Enclosing class:

JsonSchemaGenerator

public static enum JsonSchemaGenerator.SchemaOption
extends Enum<JsonSchemaGenerator.SchemaOption>

Options for generating JSON Schemas.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW_ADDITIONAL_PROPERTIES_BY_DEFAULT	Allow an object to contain additional key/values not defined in the schema.
UPPER_CASE_TYPE_VALUES	Convert all "type" values to upper case.

Method Summary

Modifier and Type	Method	Description
static JsonSchemaGenerator.SchemaOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JsonSchemaGenerator.SchemaOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOW_ADDITIONAL_PROPERTIES_BY_DEFAULT

public static final JsonSchemaGenerator.SchemaOption ALLOW_ADDITIONAL_PROPERTIES_BY_DEFAULT

Allow an object to contain additional key/values not defined in the schema.

UPPER_CASE_TYPE_VALUES

public static final JsonSchemaGenerator.SchemaOption UPPER_CASE_TYPE_VALUES

Convert all "type" values to upper case.

Method Details

values

public static JsonSchemaGenerator.SchemaOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JsonSchemaGenerator.SchemaOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null