software.amazon.smithy.jsonschema

Enum JsonSchemaConfig.UnionStrategy

java.lang.Object

java.lang.Enum<JsonSchemaConfig.UnionStrategy>

software.amazon.smithy.jsonschema.JsonSchemaConfig.UnionStrategy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JsonSchemaConfig.UnionStrategy>

Enclosing class:

JsonSchemaConfig

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

Configures how Smithy union shapes are converted to JSON Schema.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
java.lang.String	toString()
static JsonSchemaConfig.UnionStrategy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JsonSchemaConfig.UnionStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static JsonSchemaConfig.UnionStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JsonSchemaConfig.UnionStrategy c : JsonSchemaConfig.UnionStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static JsonSchemaConfig.UnionStrategy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<JsonSchemaConfig.UnionStrategy>