Module io.helidon.json.schema

Package io.helidon.json.schema

Interface SchemaNumber

All Superinterfaces:

Prototype.Api, SchemaItem

All Known Implementing Classes:

SchemaNumber.BuilderBase.SchemaNumberImpl

public interface SchemaNumber
extends Prototype.Api, SchemaItem

Json schema related to the numbers.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SchemaNumber.Builder	builder()	Create a new fluent API builder to customize configuration.
static SchemaNumber.Builder	builder(SchemaNumber instance)	Create a new fluent API builder from an existing instance.
static SchemaNumber	create()	Create a new instance with default values.
Optional<Double>	exclusiveMaximum()	Maximal exclusive value of the number.
Optional<Double>	exclusiveMinimum()	Minimal exclusive value of the number.
default void	generate(Hson.Struct.Builder builder)
Optional<Double>	maximum()	Maximal value of the number.
Optional<Double>	minimum()	Minimal value of the number.
Optional<Double>	multipleOf()	Value restriction to be a multiple of a given number.
SchemaType	schemaType()

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

description, required, schemaType, title

Method Details

builder

static SchemaNumber.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static SchemaNumber.Builder builder(SchemaNumber 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 SchemaNumber create()

Create a new instance with default values.

Returns:

a new instance

multipleOf

Optional<Double> multipleOf()

Value restriction to be a multiple of a given number.

Returns:

multiple value restriction

minimum

Optional<Double> minimum()

Minimal value of the number. Cannot be higher than maximal configured value. Mutually exclusive to exclusiveMinimum().

Returns:

minimal value

maximum

Optional<Double> maximum()

Maximal value of the number. Cannot be lower than minimal configured value. Mutually exclusive to exclusiveMaximum().

Returns:

maximal value

exclusiveMaximum

Optional<Double> exclusiveMaximum()

Maximal exclusive value of the number. Cannot be lower than minimal configured value. Mutually exclusive to maximum().

Returns:

maximal exclusive value

exclusiveMinimum

Optional<Double> exclusiveMinimum()

Minimal exclusive value of the number. Cannot be higher than maximal configured value. Mutually exclusive to minimum().

Returns:

minimal exclusive value

schemaType

SchemaType schemaType()

generate

default void generate(Hson.Struct.Builder builder)