Package software.amazon.smithy.jsonschema

Enum Class JsonSchemaConfig.EnumStrategy

java.lang.Object

java.lang.Enum<JsonSchemaConfig.EnumStrategy>

software.amazon.smithy.jsonschema.JsonSchemaConfig.EnumStrategy

All Implemented Interfaces:

Serializable, Comparable<JsonSchemaConfig.EnumStrategy>, Constable

Enclosing class:

JsonSchemaConfig

public static enum JsonSchemaConfig.EnumStrategy
extends Enum<JsonSchemaConfig.EnumStrategy>

Configures how Smithy enum shapes are converted to JSON Schema

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
ENUM	Converts to a schema that uses enum, which contains an array of strings
ONE_OF	Converts to a schema that uses oneOf, with an array of const strings and optional descriptions for documentation purposes

Method Summary

Modifier and Type	Method	Description
String	toString()
static JsonSchemaConfig.EnumStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JsonSchemaConfig.EnumStrategy[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENUM

public static final JsonSchemaConfig.EnumStrategy ENUM

Converts to a schema that uses enum, which contains an array of strings

This is the default setting used if not configured.

ONE_OF

public static final JsonSchemaConfig.EnumStrategy ONE_OF

Converts to a schema that uses oneOf, with an array of const strings and optional descriptions for documentation purposes

Method Details

values

public static JsonSchemaConfig.EnumStrategy[] 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 JsonSchemaConfig.EnumStrategy 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

toString

public String toString()

Overrides:

toString in class Enum<JsonSchemaConfig.EnumStrategy>