Package software.amazon.smithy.jsonschema

Enum Class JsonSchemaConfig.UnionStrategy

java.lang.Object

java.lang.Enum<JsonSchemaConfig.UnionStrategy>

software.amazon.smithy.jsonschema.JsonSchemaConfig.UnionStrategy

All Implemented Interfaces:

Serializable, Comparable<JsonSchemaConfig.UnionStrategy>, Constable

Enclosing class:

JsonSchemaConfig

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

Configures how Smithy union 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
OBJECT	Converts to an empty object "{}".
ONE_OF	Converts to a schema that uses "oneOf".
STRUCTURE	Converts to an object with properties just like a structure.

Method Summary

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

ONE_OF

public static final JsonSchemaConfig.UnionStrategy ONE_OF

Converts to a schema that uses "oneOf".

This is the default setting used if not configured.

OBJECT

public static final JsonSchemaConfig.UnionStrategy OBJECT

Converts to an empty object "{}".

STRUCTURE

public static final JsonSchemaConfig.UnionStrategy STRUCTURE

Converts to an object with properties just like a structure.

Method Details

values

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