Package software.amazon.smithy.jsonschema

Class Schema.Builder

java.lang.Object

software.amazon.smithy.jsonschema.Schema.Builder

All Implemented Interfaces:

SmithyBuilder<Schema>

Enclosing class:

Schema

public static final class Schema.Builder
extends Object
implements SmithyBuilder<Schema>

Abstract class used to build Schema components.

Method Summary

Modifier and Type	Method	Description
Schema.Builder	additionalProperties(Schema additionalProperties)
Schema.Builder	allOf(List<Schema> allOf)
Schema.Builder	anyOf(List<Schema> anyOf)
Schema	build()	Creates an immutable object that is created from the properties that have been set on the builder.
Schema.Builder	comment(String comment)
Schema.Builder	constValue(Node constValue)
Schema.Builder	contentEncoding(String contentEncoding)
Schema.Builder	contentMediaType(String contentMediaType)
Schema.Builder	defaultValue(Node defaultValue)
Schema.Builder	description(String description)
Schema.Builder	disableProperty(String propertyName)	Disables a specific JSON schema property by name.
Schema.Builder	enumValues(Collection<String> enumValues)
Schema.Builder	examples(Node examples)
Schema.Builder	exclusiveMaximum(Number exclusiveMaximum)
Schema.Builder	exclusiveMinimum(Number exclusiveMinimum)
Schema.Builder	extensions(Map<String,Node> extensions)
Schema.Builder	format(String format)
Optional<String>	getFormat()
Schema.Builder	items(Schema items)
Schema.Builder	maximum(Number maximum)
Schema.Builder	maxItems(Integer maxItems)
Schema.Builder	maxLength(Long maxLength)
Schema.Builder	maxProperties(Integer maxProperties)
Schema.Builder	minimum(Number minimum)
Schema.Builder	minItems(Integer minItems)
Schema.Builder	minLength(Long minLength)
Schema.Builder	minProperties(Integer minProperties)
Schema.Builder	multipleOf(Number multipleOf)
Schema.Builder	not(Schema not)
Schema.Builder	oneOf(List<Schema> oneOf)
Schema.Builder	pattern(String pattern)
Schema.Builder	patternProperties(Map<String,Schema> patternProperties)
Schema.Builder	properties(Map<String,Schema> properties)
Schema.Builder	propertyNames(Schema propertyNames)
Schema.Builder	putExtension(String key, ToNode value)
Schema.Builder	putPatternProperty(String key, Schema value)
Schema.Builder	putProperty(String key, Schema value)
Schema.Builder	readOnly(boolean readOnly)
Schema.Builder	ref(String ref)
Schema.Builder	removeExtension(String key)
Schema.Builder	removePatternProperty(String key)
Schema.Builder	removeProperty(String key)
Schema.Builder	required(Collection<String> required)
Schema.Builder	title(String title)
Schema.Builder	type(String type)
Schema.Builder	uniqueItems(boolean uniqueItems)
Schema.Builder	writeOnly(boolean writeOnly)

Methods inherited from class java.lang.Object

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

Method Details

build

public Schema build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface SmithyBuilder<Schema>

Returns:

an instance of T

ref

public Schema.Builder ref(String ref)

type

public Schema.Builder type(String type)

defaultValue

public Schema.Builder defaultValue(Node defaultValue)

enumValues

public Schema.Builder enumValues(Collection<String> enumValues)

constValue

public Schema.Builder constValue(Node constValue)

multipleOf

public Schema.Builder multipleOf(Number multipleOf)

maximum

public Schema.Builder maximum(Number maximum)

exclusiveMaximum

public Schema.Builder exclusiveMaximum(Number exclusiveMaximum)

minimum

public Schema.Builder minimum(Number minimum)

exclusiveMinimum

public Schema.Builder exclusiveMinimum(Number exclusiveMinimum)

maxLength

public Schema.Builder maxLength(Long maxLength)

minLength

public Schema.Builder minLength(Long minLength)

pattern

public Schema.Builder pattern(String pattern)

items

public Schema.Builder items(Schema items)

maxItems

public Schema.Builder maxItems(Integer maxItems)

minItems

public Schema.Builder minItems(Integer minItems)

uniqueItems

public Schema.Builder uniqueItems(boolean uniqueItems)

maxProperties

public Schema.Builder maxProperties(Integer maxProperties)

minProperties

public Schema.Builder minProperties(Integer minProperties)

required

public Schema.Builder required(Collection<String> required)

properties

public Schema.Builder properties(Map<String,Schema> properties)

putProperty

public Schema.Builder putProperty(String key,
 Schema value)

removeProperty

public Schema.Builder removeProperty(String key)

additionalProperties

public Schema.Builder additionalProperties(Schema additionalProperties)

propertyNames

public Schema.Builder propertyNames(Schema propertyNames)

patternProperties

public Schema.Builder patternProperties(Map<String,Schema> patternProperties)

putPatternProperty

public Schema.Builder putPatternProperty(String key,
 Schema value)

removePatternProperty

public Schema.Builder removePatternProperty(String key)

allOf

public Schema.Builder allOf(List<Schema> allOf)

anyOf

public Schema.Builder anyOf(List<Schema> anyOf)

oneOf

public Schema.Builder oneOf(List<Schema> oneOf)

not

public Schema.Builder not(Schema not)

title

public Schema.Builder title(String title)

description

public Schema.Builder description(String description)

getFormat

public Optional<String> getFormat()

format

public Schema.Builder format(String format)

readOnly

public Schema.Builder readOnly(boolean readOnly)

writeOnly

public Schema.Builder writeOnly(boolean writeOnly)

comment

public Schema.Builder comment(String comment)

contentEncoding

public Schema.Builder contentEncoding(String contentEncoding)

contentMediaType

public Schema.Builder contentMediaType(String contentMediaType)

examples

public Schema.Builder examples(Node examples)

extensions

public Schema.Builder extensions(Map<String,Node> extensions)

putExtension

public Schema.Builder putExtension(String key,
 ToNode value)

removeExtension

public Schema.Builder removeExtension(String key)

disableProperty

public Schema.Builder disableProperty(String propertyName)

Disables a specific JSON schema property by name.

Parameters:

propertyName - Property name to remove (e.g., "propertyNames").

Returns:

Returns the builder.