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 java.lang.Object implements SmithyBuilder<Schema>
Abstract class used to build Schema components.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Schema.BuilderadditionalProperties(Schema additionalProperties)Schema.BuilderallOf(java.util.List<Schema> allOf)Schema.BuilderanyOf(java.util.List<Schema> anyOf)Schemabuild()Creates an immutable object that is created from the properties that have been set on the builder.Schema.Buildercomment(java.lang.String comment)Schema.BuilderconstValue(Node constValue)Schema.BuildercontentEncoding(java.lang.String contentEncoding)Schema.BuildercontentMediaType(java.lang.String contentMediaType)Schema.BuilderdefaultValue(Node defaultValue)Schema.Builderdeprecated(boolean deprecated)Schema.Builderdescription(java.lang.String description)Schema.BuilderdisableProperty(java.lang.String propertyName)Disables a specific JSON schema property by name.Schema.BuilderenumValues(java.util.Collection<java.lang.String> enumValues)Schema.Builderexamples(Node examples)Schema.BuilderexclusiveMaximum(java.lang.Number exclusiveMaximum)Schema.BuilderexclusiveMinimum(java.lang.Number exclusiveMinimum)Schema.Builderextensions(java.util.Map<java.lang.String,Node> extensions)Schema.Builderformat(java.lang.String format)java.util.Optional<java.lang.String>getFormat()Schema.BuilderintEnumValues(java.util.Collection<java.lang.Integer> intEnumValues)Schema.Builderitems(Schema items)Schema.Buildermaximum(java.lang.Number maximum)Schema.BuildermaxItems(java.lang.Integer maxItems)Schema.BuildermaxLength(java.lang.Long maxLength)Schema.BuildermaxProperties(java.lang.Integer maxProperties)Schema.Builderminimum(java.lang.Number minimum)Schema.BuilderminItems(java.lang.Integer minItems)Schema.BuilderminLength(java.lang.Long minLength)Schema.BuilderminProperties(java.lang.Integer minProperties)Schema.BuildermultipleOf(java.lang.Number multipleOf)Schema.Buildernot(Schema not)Schema.BuilderoneOf(java.util.List<Schema> oneOf)Schema.Builderpattern(java.lang.String pattern)Schema.BuilderpatternProperties(java.util.Map<java.lang.String,Schema> patternProperties)Schema.Builderproperties(java.util.Map<java.lang.String,Schema> properties)Schema.BuilderpropertyNames(Schema propertyNames)Schema.BuilderputExtension(java.lang.String key, ToNode value)Schema.BuilderputPatternProperty(java.lang.String key, Schema value)Schema.BuilderputProperty(java.lang.String key, Schema value)Schema.BuilderreadOnly(boolean readOnly)Schema.Builderref(java.lang.String ref)Schema.BuilderremoveExtension(java.lang.String key)Schema.BuilderremovePatternProperty(java.lang.String key)Schema.BuilderremoveProperty(java.lang.String key)Schema.Builderrequired(java.util.Collection<java.lang.String> required)Schema.Buildertitle(java.lang.String title)Schema.Buildertype(java.lang.String type)Schema.BuilderuniqueItems(boolean uniqueItems)Schema.BuilderwriteOnly(boolean writeOnly)
-
-
-
Method Detail
-
build
public Schema build()
Description copied from interface:SmithyBuilderCreates an immutable object that is created from the properties that have been set on the builder.- Specified by:
buildin interfaceSmithyBuilder<Schema>- Returns:
- an instance of T
-
ref
public Schema.Builder ref(java.lang.String ref)
-
type
public Schema.Builder type(java.lang.String type)
-
defaultValue
public Schema.Builder defaultValue(Node defaultValue)
-
enumValues
public Schema.Builder enumValues(java.util.Collection<java.lang.String> enumValues)
-
intEnumValues
public Schema.Builder intEnumValues(java.util.Collection<java.lang.Integer> intEnumValues)
-
constValue
public Schema.Builder constValue(Node constValue)
-
multipleOf
public Schema.Builder multipleOf(java.lang.Number multipleOf)
-
maximum
public Schema.Builder maximum(java.lang.Number maximum)
-
exclusiveMaximum
public Schema.Builder exclusiveMaximum(java.lang.Number exclusiveMaximum)
-
minimum
public Schema.Builder minimum(java.lang.Number minimum)
-
exclusiveMinimum
public Schema.Builder exclusiveMinimum(java.lang.Number exclusiveMinimum)
-
maxLength
public Schema.Builder maxLength(java.lang.Long maxLength)
-
minLength
public Schema.Builder minLength(java.lang.Long minLength)
-
pattern
public Schema.Builder pattern(java.lang.String pattern)
-
items
public Schema.Builder items(Schema items)
-
maxItems
public Schema.Builder maxItems(java.lang.Integer maxItems)
-
minItems
public Schema.Builder minItems(java.lang.Integer minItems)
-
uniqueItems
public Schema.Builder uniqueItems(boolean uniqueItems)
-
maxProperties
public Schema.Builder maxProperties(java.lang.Integer maxProperties)
-
minProperties
public Schema.Builder minProperties(java.lang.Integer minProperties)
-
required
public Schema.Builder required(java.util.Collection<java.lang.String> required)
-
properties
public Schema.Builder properties(java.util.Map<java.lang.String,Schema> properties)
-
putProperty
public Schema.Builder putProperty(java.lang.String key, Schema value)
-
removeProperty
public Schema.Builder removeProperty(java.lang.String key)
-
additionalProperties
public Schema.Builder additionalProperties(Schema additionalProperties)
-
propertyNames
public Schema.Builder propertyNames(Schema propertyNames)
-
patternProperties
public Schema.Builder patternProperties(java.util.Map<java.lang.String,Schema> patternProperties)
-
putPatternProperty
public Schema.Builder putPatternProperty(java.lang.String key, Schema value)
-
removePatternProperty
public Schema.Builder removePatternProperty(java.lang.String key)
-
allOf
public Schema.Builder allOf(java.util.List<Schema> allOf)
-
anyOf
public Schema.Builder anyOf(java.util.List<Schema> anyOf)
-
oneOf
public Schema.Builder oneOf(java.util.List<Schema> oneOf)
-
not
public Schema.Builder not(Schema not)
-
title
public Schema.Builder title(java.lang.String title)
-
description
public Schema.Builder description(java.lang.String description)
-
getFormat
public java.util.Optional<java.lang.String> getFormat()
-
format
public Schema.Builder format(java.lang.String format)
-
readOnly
public Schema.Builder readOnly(boolean readOnly)
-
writeOnly
public Schema.Builder writeOnly(boolean writeOnly)
-
comment
public Schema.Builder comment(java.lang.String comment)
-
contentEncoding
public Schema.Builder contentEncoding(java.lang.String contentEncoding)
-
contentMediaType
public Schema.Builder contentMediaType(java.lang.String contentMediaType)
-
examples
public Schema.Builder examples(Node examples)
-
deprecated
public Schema.Builder deprecated(boolean deprecated)
-
extensions
public Schema.Builder extensions(java.util.Map<java.lang.String,Node> extensions)
-
putExtension
public Schema.Builder putExtension(java.lang.String key, ToNode value)
-
removeExtension
public Schema.Builder removeExtension(java.lang.String key)
-
disableProperty
public Schema.Builder disableProperty(java.lang.String propertyName)
Disables a specific JSON schema property by name.- Parameters:
propertyName- Property name to remove (e.g., "propertyNames").- Returns:
- Returns the builder.
-
-