Package io.vertx.rxjava3.json.schema
Class Validator
- java.lang.Object
-
- io.vertx.rxjava3.json.schema.Validator
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class Validator extends Object implements io.vertx.lang.rx.RxDelegate
A validator, validates some input object using a well known schema.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<Validator>__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Validatorcreate(JsonSchema schema, JsonSchemaOptions options)Creates a new validator with some initial schema and options.static Validatorcreate(JsonSchema schema, JsonSchemaOptions options, JsonFormatValidator jsonFormatValidator)Creates a new validator with some initial schema, options and a custom JSON format validator.booleanequals(Object o)ValidatorgetDelegate()inthashCode()static ValidatornewInstance(Validator arg)StringtoString()OutputUnitvalidate(Object instance)Validate a given input against the initial schema.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<Validator> __TYPE_ARG
-
-
Method Detail
-
getDelegate
public Validator getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
create
public static Validator create(JsonSchema schema, JsonSchemaOptions options)
Creates a new validator with some initial schema and options.When validation is to be reused, it is recommended to create a
SchemaRepositoryinstance and use theSchemaRepository.validator(io.vertx.rxjava3.json.schema.JsonSchema)} method. The use of aStringkey allows avoiding re-parsing and fast lookups.- Parameters:
schema- the initial schemaoptions- the validator options- Returns:
- a validator instance
-
create
public static Validator create(JsonSchema schema, JsonSchemaOptions options, JsonFormatValidator jsonFormatValidator)
Creates a new validator with some initial schema, options and a custom JSON format validator. When validation is to be reused, it is recommended to create aSchemaRepositoryinstance and use theSchemaRepository.validator(io.vertx.rxjava3.json.schema.JsonSchema)} method. The use of aStringkey allows avoiding re-parsing and fast lookups.- Parameters:
schema- the initial schemaoptions- the validator optionsjsonFormatValidator- the custom JSON format validator- Returns:
- a validator instance
-
validate
public OutputUnit validate(Object instance)
Validate a given input against the initial schema.- Parameters:
instance- instance to validate- Returns:
- returns a output unit object as defined by the options
-
-