Class SchemaObject.Builder

java.lang.Object

io.helidon.json.schema.SchemaItem.BuilderBase<SchemaObject.Builder, SchemaObject>

io.helidon.json.schema.SchemaObject.BuilderBase<SchemaObject.Builder, SchemaObject>

io.helidon.json.schema.SchemaObject.Builder

All Implemented Interfaces:

Prototype.Builder<SchemaObject.Builder, SchemaObject>, Builder<SchemaObject.Builder, SchemaObject>, Supplier<SchemaObject>

Enclosing interface:

SchemaObject

public static class SchemaObject.Builder
extends SchemaObject.BuilderBase<SchemaObject.Builder, SchemaObject>
implements Builder<SchemaObject.Builder, SchemaObject>

Fluent API builder for SchemaObject.

Nested Class Summary

Nested classes/interfaces inherited from class SchemaObject.BuilderBase

SchemaObject.BuilderBase.SchemaObjectImpl

Modifier and Type	Class	Description
protected static class	SchemaObject.BuilderBase.SchemaObjectImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class SchemaItem.BuilderBase

SchemaItem.BuilderBase.SchemaItemImpl

Modifier and Type	Class	Description
protected static class	SchemaItem.BuilderBase.SchemaItemImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
SchemaObject	build()	Create an instance from this builder.
SchemaObject	buildPrototype()	Create an instance of the prototype.

Methods inherited from class SchemaObject.BuilderBase

addArrayProperties, addArrayProperty, addArrayProperty, addBooleanProperties, addBooleanProperty, addBooleanProperty, addIntegerProperties, addIntegerProperty, addIntegerProperty, additionalProperties, additionalProperties, addNullProperties, addNullProperty, addNullProperty, addNumberProperties, addNumberProperty, addNumberProperty, addObjectProperties, addObjectProperty, addObjectProperty, addSchema, addStringProperties, addStringProperty, addStringProperty, arrayProperties, arrayProperties, booleanProperties, booleanProperties, clearAdditionalProperties, clearMaxProperties, clearMinProperties, from, from, integerProperties, integerProperties, maxProperties, maxProperties, minProperties, minProperties, nullProperties, nullProperties, numberProperties, numberProperties, objectProperties, objectProperties, preBuildPrototype, stringProperties, stringProperties, toString, validatePrototype

Modifier and Type	Method	Description
SchemaObject.Builder	addArrayProperties(Map<String, ? extends SchemaArray> arrayProperties)	Map of all array properties.
SchemaObject.Builder	addArrayProperty(String key, SchemaArray addArrayProperty)	Map of all array properties.
SchemaObject.Builder	addArrayProperty(String key, Consumer<SchemaArray.Builder> consumer)	Map of all array properties.
SchemaObject.Builder	addBooleanProperties(Map<String, ? extends SchemaBoolean> booleanProperties)	Map of all boolean properties.
SchemaObject.Builder	addBooleanProperty(String key, SchemaBoolean addBooleanProperty)	Map of all boolean properties.
SchemaObject.Builder	addBooleanProperty(String key, Consumer<SchemaBoolean.Builder> consumer)	Map of all boolean properties.
SchemaObject.Builder	addIntegerProperties(Map<String, ? extends SchemaInteger> integerProperties)	Map of all integer properties.
SchemaObject.Builder	addIntegerProperty(String key, SchemaInteger addIntegerProperty)	Map of all integer properties.
SchemaObject.Builder	addIntegerProperty(String key, Consumer<SchemaInteger.Builder> consumer)	Map of all integer properties.
Optional<Boolean>	additionalProperties()	Whether any additional properties are allowed.
SchemaObject.Builder	additionalProperties(boolean additionalProperties)	Whether any additional properties are allowed.
SchemaObject.Builder	addNullProperties(Map<String, ? extends SchemaNull> nullProperties)	Map of all null properties.
SchemaObject.Builder	addNullProperty(String key, SchemaNull addNullProperty)	Map of all null properties.
SchemaObject.Builder	addNullProperty(String key, Consumer<SchemaNull.Builder> consumer)	Map of all null properties.
SchemaObject.Builder	addNumberProperties(Map<String, ? extends SchemaNumber> numberProperties)	Map of all number properties.
SchemaObject.Builder	addNumberProperty(String key, SchemaNumber addNumberProperty)	Map of all number properties.
SchemaObject.Builder	addNumberProperty(String key, Consumer<SchemaNumber.Builder> consumer)	Map of all number properties.
SchemaObject.Builder	addObjectProperties(Map<String, ? extends SchemaObject> objectProperties)	Map of all object properties.
SchemaObject.Builder	addObjectProperty(String key, SchemaObject addObjectProperty)	Map of all object properties.
SchemaObject.Builder	addObjectProperty(String key, Consumer<SchemaObject.Builder> consumer)	Map of all object properties.
SchemaObject.Builder	addSchema(String name, Schema schema)	Add JSON schema property based on the provided schema root type.
SchemaObject.Builder	addStringProperties(Map<String, ? extends SchemaString> stringProperties)	Map of all string properties.
SchemaObject.Builder	addStringProperty(String key, SchemaString addStringProperty)	Map of all string properties.
SchemaObject.Builder	addStringProperty(String key, Consumer<SchemaString.Builder> consumer)	Map of all string properties.
Map<String, SchemaArray>	arrayProperties()	Map of all array properties.
SchemaObject.Builder	arrayProperties(Map<String, ? extends SchemaArray> arrayProperties)	Map of all array properties.
Map<String, SchemaBoolean>	booleanProperties()	Map of all boolean properties.
SchemaObject.Builder	booleanProperties(Map<String, ? extends SchemaBoolean> booleanProperties)	Map of all boolean properties.
SchemaObject.Builder	clearAdditionalProperties()	Clear existing value of additionalProperties.
SchemaObject.Builder	clearMaxProperties()	Clear existing value of maxProperties.
SchemaObject.Builder	clearMinProperties()	Clear existing value of minProperties.
SchemaObject.Builder	from(SchemaObject prototype)	Update this builder from an existing prototype instance.
SchemaObject.Builder	from(SchemaObject.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Map<String, SchemaInteger>	integerProperties()	Map of all integer properties.
SchemaObject.Builder	integerProperties(Map<String, ? extends SchemaInteger> integerProperties)	Map of all integer properties.
Optional<Integer>	maxProperties()	Maximum number of the object properties.
SchemaObject.Builder	maxProperties(int maxProperties)	Maximum number of the object properties.
Optional<Integer>	minProperties()	Minimum number of the object properties.
SchemaObject.Builder	minProperties(int minProperties)	Minimum number of the object properties.
Map<String, SchemaNull>	nullProperties()	Map of all null properties.
SchemaObject.Builder	nullProperties(Map<String, ? extends SchemaNull> nullProperties)	Map of all null properties.
Map<String, SchemaNumber>	numberProperties()	Map of all number properties.
SchemaObject.Builder	numberProperties(Map<String, ? extends SchemaNumber> numberProperties)	Map of all number properties.
Map<String, SchemaObject>	objectProperties()	Map of all object properties.
SchemaObject.Builder	objectProperties(Map<String, ? extends SchemaObject> objectProperties)	Map of all object properties.
protected void	preBuildPrototype()	Handles providers and decorators.
Map<String, SchemaString>	stringProperties()	Map of all string properties.
SchemaObject.Builder	stringProperties(Map<String, ? extends SchemaString> stringProperties)	Map of all string properties.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class SchemaItem.BuilderBase

clearDescription, clearTitle, description, description, from, from, required, required, title, title

Modifier and Type	Method	Description
SchemaObject.Builder	clearDescription()	Clear existing value of description.
SchemaObject.Builder	clearTitle()	Clear existing value of title.
Optional<String>	description()	Description of the item.
SchemaObject.Builder	description(String description)	Description of the item.
SchemaObject.Builder	from(SchemaItem prototype)	Update this builder from an existing prototype instance.
SchemaObject.Builder	from(SchemaItem.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
boolean	required()	Used in the object properties to mark required property.
SchemaObject.Builder	required(boolean required)	Used in the object properties to mark required property.
Optional<String>	title()	Title of the item.
SchemaObject.Builder	title(String title)	Title of the item.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default SchemaObject	get()
default SchemaObject.Builder	identity()	Instance of this builder as the correct type.
default SchemaObject.Builder	update(Consumer<SchemaObject.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default SchemaObject.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public SchemaObject buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<SchemaObject.Builder, SchemaObject>

Returns:

an instance of the setup object created from this builder

build

public SchemaObject build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<SchemaObject.Builder, SchemaObject>

Returns:

instance of the built type