Package software.amazon.smithy.jsonschema

Enum Class JsonSchemaConfig.MapStrategy

java.lang.Object

java.lang.Enum<JsonSchemaConfig.MapStrategy>

software.amazon.smithy.jsonschema.JsonSchemaConfig.MapStrategy

All Implemented Interfaces:

Serializable, Comparable<JsonSchemaConfig.MapStrategy>, Constable

Enclosing class:

JsonSchemaConfig

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

Configures how Smithy map 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
PATTERN_PROPERTIES	Converts to a schema that uses "patternProperties".
PROPERTY_NAMES	Converts to a schema that uses a combination of "propertyNames" and "additionalProperties".

Method Summary

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

PROPERTY_NAMES

public static final JsonSchemaConfig.MapStrategy PROPERTY_NAMES

Converts to a schema that uses a combination of "propertyNames" and "additionalProperties".

This is the default setting used if not configured.

PATTERN_PROPERTIES

public static final JsonSchemaConfig.MapStrategy PATTERN_PROPERTIES

Converts to a schema that uses "patternProperties". If a map's key member or its target does not have a pattern trait, a default indicating one or more of any character (".+") is applied.

Method Details

values

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