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:

  • 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

    • 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

    • 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()