Module io.helidon.json.schema

Package io.helidon.json.schema

Interface SchemaBoolean

All Superinterfaces:

Prototype.Api, SchemaItem

All Known Implementing Classes:

SchemaBoolean.BuilderBase.SchemaBooleanImpl

public interface SchemaBoolean
extends Prototype.Api, SchemaItem

Json schema related to the boolean value.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SchemaBoolean.Builder	Fluent API builder for SchemaBoolean.
static class	SchemaBoolean.BuilderBase<BUILDER extends SchemaBoolean.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SchemaBoolean>	Fluent API builder base for SchemaBoolean.

Method Summary

Modifier and Type	Method	Description
static SchemaBoolean.Builder	builder()	Create a new fluent API builder to customize configuration.
static SchemaBoolean.Builder	builder(SchemaBoolean instance)	Create a new fluent API builder from an existing instance.
static SchemaBoolean	create()	Create a new instance with default values.
default void	generate(Hson.Struct.Builder builder)	Deprecated, for removal: This API element is subject to removal in a future version. this method is not intended to be broadly used.
SchemaType	schemaType()

Methods inherited from interface io.helidon.json.schema.SchemaItem

description, required, schemaType, title

Method Details

builder

static SchemaBoolean.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static SchemaBoolean.Builder builder(SchemaBoolean instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static SchemaBoolean create()

Create a new instance with default values.

Returns:

a new instance

schemaType

SchemaType schemaType()

generate

@Deprecated(forRemoval=true,
            since="4.3.0")
default void generate(Hson.Struct.Builder builder)

Deprecated, for removal: This API element is subject to removal in a future version.

this method is not intended to be broadly used. Will be removed later.

Generated the Json schema item to the Json. This method servers mainly as a helpful tool for the Json generation. It should not be used.

Parameters:

builder - hson struct builder