Module io.helidon.json.schema

Package io.helidon.json.schema

Interface SchemaString

All Superinterfaces:

Prototype.Api, SchemaItem

All Known Implementing Classes:

SchemaString.BuilderBase.SchemaStringImpl

public interface SchemaString
extends Prototype.Api, SchemaItem

Json schema related to the strings.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SchemaString.Builder	builder()	Create a new fluent API builder to customize configuration.
static SchemaString.Builder	builder(SchemaString instance)	Create a new fluent API builder from an existing instance.
static SchemaString	create()	Create a new instance with default values.
default void	generate(Hson.Struct.Builder builder)	Generated the Json schema item to the Json.
Optional<Long>	maxLength()	Maximum length of the string.
Optional<Long>	minLength()	Minimum length of the string.
Optional<String>	pattern()	String pattern to follow.
SchemaType	schemaType()

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

description, required, schemaType, title

Method Details

builder

static SchemaString.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

generate

default void generate(Hson.Struct.Builder builder)

Description copied from interface: SchemaItem

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.

Specified by:

generate in interface SchemaItem

Parameters:

builder - hson struct builder

maxLength

Optional<Long> maxLength()

Maximum length of the string.

Returns:

maximum string length

minLength

Optional<Long> minLength()

Minimum length of the string.

Returns:

minimum string length

pattern

Optional<String> pattern()

String pattern to follow.

Returns:

string pattern

schemaType

SchemaType schemaType()