Package io.vertx.mutiny.json.schema

Class JsonSchema

java.lang.Object

io.vertx.mutiny.json.schema.JsonSchema

public class JsonSchema
extends Object

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 using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<JsonSchema>	__TYPE_ARG
static Predicate<Map.Entry<String,Object>>	EXCLUDE_ANNOTATION_ENTRIES	Predicate to filter out annotation keys.
static Predicate<String>	EXCLUDE_ANNOTATIONS	Predicate to filter out annotation keys.

Constructor Summary

Constructors

Constructor	Description
JsonSchema(io.vertx.json.schema.JsonSchema delegate)
JsonSchema(Object delegate)

Method Summary

Modifier and Type	Method	Description
JsonSchema	annotate(String key, String value)
boolean	containsKey(String key)
boolean	equals(Object o)
Set<String>	fieldNames()
<R> R	get(String key)
<R> R	get(String key, R fallback)
io.vertx.json.schema.JsonSchema	getDelegate()
int	hashCode()
static JsonSchema	newInstance(io.vertx.json.schema.JsonSchema arg)
static JsonSchema	of(boolean bool)
static JsonSchema	of(io.vertx.core.json.JsonObject json)
static JsonSchema	of(String id, io.vertx.core.json.JsonObject json)
io.vertx.core.json.JsonObject	resolve()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<JsonSchema> __TYPE_ARG

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.

Constructor Detail

JsonSchema

public JsonSchema(io.vertx.json.schema.JsonSchema delegate)

JsonSchema

public JsonSchema(Object delegate)

Method Detail

getDelegate

public io.vertx.json.schema.JsonSchema getDelegate()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public static JsonSchema of(io.vertx.core.json.JsonObject json)

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)

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)

Parameters:

bool - a boolean.

Returns:

a wrapper for the input object.

annotate

public JsonSchema annotate(String key,
                           String value)

Parameters:

key - a key

value - a value

Returns:

the instance of JsonSchema to chain method calls.

get

public <R> R get(String key)

Parameters:

key - a key

Returns:

the value or null

get

public <R> R get(String key,
                 R fallback)

Parameters:

key - a key

fallback - fallback when key is not present

Returns:

the value or null

containsKey

public boolean containsKey(String key)

Parameters:

key - a key

Returns:

true if present

fieldNames

public Set<String> fieldNames()

Returns:

field names

resolve

public io.vertx.core.json.JsonObject resolve()

Returns:

a new representing the schema with $refs replaced by their value.

newInstance

public static JsonSchema newInstance(io.vertx.json.schema.JsonSchema arg)