Package io.vertx.mutiny.json.schema

Class JsonSchema

java.lang.Object
io.vertx.mutiny.json.schema.JsonSchema
All Implemented Interfaces:
MutinyDelegate
public class JsonSchema extends Object implements MutinyDelegate
A Json-Schema holder.

There are 2 kinds of Json-Schema's:

  • JSON Object based
  • Boolean based

This is a common interface to handle all kinds of schemas.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Paulo Lopes
See Also:
  • JsonSchema

  • Field Details

    • EXCLUDE_ANNOTATIONS

      public static final Predicate<String> EXCLUDE_ANNOTATIONS
      Predicate to filter out annotation keys.

    • EXCLUDE_ANNOTATION_ENTRIES

      public static final Predicate<Map.Entry<String,Object>> EXCLUDE_ANNOTATION_ENTRIES
      Predicate to filter out annotation keys.

    • __TYPE_ARG

      public static final TypeArg<JsonSchema> __TYPE_ARG

  • Constructor Details

    • JsonSchema

      public JsonSchema(io.vertx.json.schema.JsonSchema delegate)
      Create a new instance of JsonSchema delegating to the given (non-null) instance of JsonSchema.

    • JsonSchema

      public JsonSchema(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.json.schema.JsonSchema getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • of

      public static JsonSchema of(io.vertx.core.json.JsonObject json)
      Factory method to create a JsonSchema from a JsonObject.
      Parameters:
      json - a JSON Object.
      Returns:
      a wrapper for the input object.

    • of

      public static JsonSchema of(String id, io.vertx.core.json.JsonObject json)
      Factory method to create a JsonSchema from a JsonObject.
      Parameters:
      id - will force the given id as the schema $id.
      json - a JSON Object.
      Returns:
      a wrapper for the input object.

    • of

      public static JsonSchema of(boolean bool)
      Factory method to create a JsonSchema from a Boolean.
      Parameters:
      bool - a boolean.
      Returns:
      a wrapper for the input object.

    • annotate

      public JsonSchema annotate(String key, String value)
      Annotates the schema. An annotation is a extra key-value added to the schema that are not relevant for validation but can be used to store pre-computed state.
      Parameters:
      key - a key
      value - a value

    • get

      public <R> R get(String key)
      Get a type casted value by key.
      Parameters:
      key - a key
      Returns:
      the value or null

    • get

      public <R> R get(String key, R fallback)
      Get a type casted value by key. If the key is missing, then the fallback value is returned.
      Parameters:
      key - a key
      fallback - fallback when key is not present
      Returns:
      the value or null

    • containsKey

      public boolean containsKey(String key)
      Checks if the given key is present in the schema object.
      Parameters:
      key - a key
      Returns:
      true if present

    • fieldNames

      public Set<String> fieldNames()
      Returns the field names on the underlying object.
      Returns:
      field names

    • newInstance

      public static JsonSchema newInstance(io.vertx.json.schema.JsonSchema delegate)
      Creates a new instance of the JsonSchema.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object