Package software.amazon.smithy.jsonschema

Class Schema

java.lang.Object

software.amazon.smithy.jsonschema.Schema

All Implemented Interfaces:

ToNode, ToSmithyBuilder<Schema>

public final class Schema
extends Object
implements ToNode, ToSmithyBuilder<Schema>

Defines a single JSON schema.

This supports a subset of the "draft-handrews-json-schema-validation-01" version of JSON Schema. The following properties are not supported:

• dependencies
• if
• then
• else
• examples

Custom properties can be added to the scheme using the Schema.Builder.putExtension(java.lang.String, software.amazon.smithy.model.node.ToNode) method. Custom properties are merged with the schema document when serializing it to a Node object. Any extension properties that conflict with built-in properties overwrite the built-in property.

See Also:

• JSON Schema Validation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Schema.Builder	Abstract class used to build Schema components.

Method Summary

Modifier and Type	Method	Description
static Schema.Builder	builder()
boolean	equals(Object o)
Optional<Schema>	getAdditionalProperties()
Map<String,ToNode>	getAllExtensions()
List<Schema>	getAllOf()
List<Schema>	getAnyOf()
Optional<String>	getComment()
Optional<Node>	getConstValue()
Optional<String>	getContentEncoding()
Optional<String>	getContentMediaType()
Optional<Node>	getDefaultValue()
Optional<String>	getDescription()
Optional<Collection<String>>	getEnumValues()
Optional<Node>	getExamples()
Optional<Number>	getExclusiveMaximum()
Optional<Number>	getExclusiveMinimum()
Optional<ToNode>	getExtension(String key)
Optional<String>	getFormat()
Optional<Schema>	getItems()
Optional<Number>	getMaximum()
Optional<Integer>	getMaxItems()
Optional<Long>	getMaxLength()
Optional<Integer>	getMaxProperties()
Optional<Number>	getMinimum()
Optional<Integer>	getMinItems()
Optional<Long>	getMinLength()
Optional<Integer>	getMinProperties()
Optional<Number>	getMultipleOf()
Optional<Schema>	getNot()
List<Schema>	getOneOf()
Optional<String>	getPattern()
Map<String,Schema>	getPatternProperties()
Map<String,Schema>	getProperties()
Optional<Schema>	getProperty(String key)
Optional<Schema>	getPropertyNames()
boolean	getReadOnly()
Optional<String>	getRef()
Collection<String>	getRequired()
Optional<String>	getTitle()
Optional<String>	getType()
boolean	getUniqueItems()
boolean	getWriteOnly()
int	hashCode()
Optional<Schema>	selectSchema(String... segments)	Selects a nested schema using a variadic list of property names to descend into.
Schema.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static Schema.Builder builder()

getRef

public Optional<String> getRef()

getType

public Optional<String> getType()

getEnumValues

public Optional<Collection<String>> getEnumValues()

getConstValue

public Optional<Node> getConstValue()

getDefaultValue

public Optional<Node> getDefaultValue()

getMultipleOf

public Optional<Number> getMultipleOf()

getMaximum

public Optional<Number> getMaximum()

getExclusiveMaximum

public Optional<Number> getExclusiveMaximum()

getMinimum

public Optional<Number> getMinimum()

getExclusiveMinimum

public Optional<Number> getExclusiveMinimum()

getMaxLength

public Optional<Long> getMaxLength()

getMinLength

public Optional<Long> getMinLength()

getPattern

public Optional<String> getPattern()

getItems

public Optional<Schema> getItems()

getMaxItems

public Optional<Integer> getMaxItems()

getMinItems

public Optional<Integer> getMinItems()

getUniqueItems

public boolean getUniqueItems()

getMaxProperties

public Optional<Integer> getMaxProperties()

getMinProperties

public Optional<Integer> getMinProperties()

getRequired

public Collection<String> getRequired()

getProperties

public Map<String,Schema> getProperties()

getProperty

public Optional<Schema> getProperty(String key)

getAdditionalProperties

public Optional<Schema> getAdditionalProperties()

getPropertyNames

public Optional<Schema> getPropertyNames()

getPatternProperties

public Map<String,Schema> getPatternProperties()

getAllOf

public List<Schema> getAllOf()

getAnyOf

public List<Schema> getAnyOf()

getOneOf

public List<Schema> getOneOf()

getNot

public Optional<Schema> getNot()

getTitle

public Optional<String> getTitle()

getDescription

public Optional<String> getDescription()

getFormat

public Optional<String> getFormat()

getReadOnly

public boolean getReadOnly()

getWriteOnly

public boolean getWriteOnly()

getComment

public Optional<String> getComment()

getExamples

public Optional<Node> getExamples()

getContentEncoding

public Optional<String> getContentEncoding()

getContentMediaType

public Optional<String> getContentMediaType()

getExtension

public Optional<ToNode> getExtension(String key)

getAllExtensions

public Map<String,ToNode> getAllExtensions()

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

selectSchema

public Optional<Schema> selectSchema(String... segments)

Selects a nested schema using a variadic list of property names to descend into.

For example, this method can be used to get the items schema nested inside of an array inside of an object:

 Schema itemsSchema = schema.selectSchema("properties", "foo", "items").get();
 

Parameters:

segments - The properties names to retrieve.

Returns:

Returns the selected Schema.

toBuilder

public Schema.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<Schema>

Returns:

a builder for type T

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object