Module io.helidon.json.schema

Package io.helidon.json.schema

Interface SchemaInteger

All Superinterfaces:

Prototype.Api, SchemaItem

All Known Implementing Classes:

SchemaInteger.BuilderBase.SchemaIntegerImpl

public interface SchemaInteger
extends Prototype.Api, SchemaItem

Json schema related to the integer numbers.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

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

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

description, required, schemaType, title

Method Details

builder

static SchemaInteger.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

multipleOf

Optional<Long> multipleOf()

Value restriction to be a multiple of a given integer number.

Returns:

multiple value restriction

minimum

Optional<Long> minimum()

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

Returns:

minimal value

maximum

Optional<Long> maximum()

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

Returns:

maximal value

exclusiveMaximum

Optional<Long> exclusiveMaximum()

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

Returns:

maximal exclusive value

exclusiveMinimum

Optional<Long> exclusiveMinimum()

Minimal exclusive value of the integer 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)