Interface Parameters
-
public interface ParametersIn this interface you can find all availableParameterProcessorFactoryto use inValidationHandlerBuilder.
To create new schemas using
SchemaBuilder, look at the docs of vertx-json-schema
-
-
Method Summary
Static Methods Modifier and Type Method Description static StyledParameterProcessorFactorydeepObjectParam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates a required deep object parameter.static StyledParameterProcessorFactoryexplodedParam(String parameterName, ArraySchemaBuilder schemaBuilder)Creates a required exploded array parameter.static StyledParameterProcessorFactoryexplodedParam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates a required exploded object parameter.static StyledParameterProcessorFactoryexplodedParam(String parameterName, TupleSchemaBuilder schemaBuilder)Creates a required exploded tuple parameter.static StyledParameterProcessorFactoryjsonParam(String parameterName, SchemaBuilder builder)Creates a required parameter serialized as valid jsonstatic StyledParameterProcessorFactoryoptionalDeepObjectParam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates an optional deep object parameter.static StyledParameterProcessorFactoryoptionalExplodedParam(String parameterName, ArraySchemaBuilder schemaBuilder)Creates an optional exploded array parameter.static StyledParameterProcessorFactoryoptionalExplodedParam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates an optional exploded object parameter.static StyledParameterProcessorFactoryoptionalExplodedParam(String parameterName, TupleSchemaBuilder schemaBuilder)Creates an optional exploded tuple parameter.static StyledParameterProcessorFactoryoptionalJsonParam(String parameterName, SchemaBuilder builder)Creates an optional parameter serialized as valid jsonstatic ParameterProcessorFactoryoptionalParam(String parameterName, ArraySchemaBuilder schemaBuilder)Creates a new optional array parameter serialized as comma separatedstatic ParameterProcessorFactoryoptionalParam(String parameterName, BooleanSchemaBuilder schemaBuilder)Creates a new optional boolean parameterstatic ParameterProcessorFactoryoptionalParam(String parameterName, NumberSchemaBuilder schemaBuilder)Creates a new optional number parameter.static ParameterProcessorFactoryoptionalParam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates an optional object parameter serialized as comma separated, likekey1,value1,key2,value2static ParameterProcessorFactoryoptionalParam(String parameterName, SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)Creates an optional parameter providing aValueParserstatic ParameterProcessorFactoryoptionalParam(String parameterName, StringSchemaBuilder schemaBuilder)Creates a new optional string parameterstatic ParameterProcessorFactoryoptionalParam(String parameterName, TupleSchemaBuilder schemaBuilder)Creates a new optional tuple parameter serialized as comma separatedstatic StyledParameterProcessorFactoryoptionalSerializedParam(String parameterName, ArrayParserFactory arrayParserFactory, ArraySchemaBuilder schemaBuilder)Creates an optional array parameter deserializable using the provided parser factory.static StyledParameterProcessorFactoryoptionalSerializedParam(String parameterName, ObjectParserFactory objectParserFactory, ObjectSchemaBuilder schemaBuilder)Creates an optional object parameter deserializable using the provided parser factory.static StyledParameterProcessorFactoryoptionalSerializedParam(String parameterName, TupleParserFactory tupleParserFactory, TupleSchemaBuilder schemaBuilder)Creates an optional tuple parameter deserializable using the provided parser factory.static ParameterProcessorFactoryparam(String parameterName, ArraySchemaBuilder schemaBuilder)Creates a new required array parameter serialized as comma separatedstatic ParameterProcessorFactoryparam(String parameterName, BooleanSchemaBuilder schemaBuilder)Creates a new required boolean parameterstatic ParameterProcessorFactoryparam(String parameterName, NumberSchemaBuilder schemaBuilder)Creates a new required number parameter.static ParameterProcessorFactoryparam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates a required object parameter serialized as comma separated, likekey1,value1,key2,value2static ParameterProcessorFactoryparam(String parameterName, SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)Creates a required parameter providing aValueParserstatic ParameterProcessorFactoryparam(String parameterName, StringSchemaBuilder schemaBuilder)Creates a new required string parameterstatic ParameterProcessorFactoryparam(String parameterName, TupleSchemaBuilder schemaBuilder)Creates a new required tuple parameter serialized as comma separatedstatic StyledParameterProcessorFactoryserializedParam(String parameterName, ArrayParserFactory arrayParserFactory, ArraySchemaBuilder schemaBuilder)Creates a required array parameter deserializable using the provided parser factory.static StyledParameterProcessorFactoryserializedParam(String parameterName, ObjectParserFactory objectParserFactory, ObjectSchemaBuilder schemaBuilder)Creates a required object parameter deserializable using the provided parser factory.static StyledParameterProcessorFactoryserializedParam(String parameterName, TupleParserFactory tupleParserFactory, TupleSchemaBuilder schemaBuilder)Creates a required tuple parameter deserializable using the provided parser factory.
-
-
-
Method Detail
-
param
static ParameterProcessorFactory param(String parameterName, NumberSchemaBuilder schemaBuilder)
Creates a new required number parameter. Depending on the type provided inschemaBuilder, the parser will parse the number asLongorDouble- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, NumberSchemaBuilder schemaBuilder)
Creates a new optional number parameter. Depending on the type provided inschemaBuilder, the parser will parse the number asLongorDouble- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
static ParameterProcessorFactory param(String parameterName, StringSchemaBuilder schemaBuilder)
Creates a new required string parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, StringSchemaBuilder schemaBuilder)
Creates a new optional string parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
static ParameterProcessorFactory param(String parameterName, BooleanSchemaBuilder schemaBuilder)
Creates a new required boolean parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, BooleanSchemaBuilder schemaBuilder)
Creates a new optional boolean parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
static ParameterProcessorFactory param(String parameterName, ArraySchemaBuilder schemaBuilder)
Creates a new required array parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, ArraySchemaBuilder schemaBuilder)
Creates a new optional array parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
static ParameterProcessorFactory param(String parameterName, TupleSchemaBuilder schemaBuilder)
Creates a new required tuple parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, TupleSchemaBuilder schemaBuilder)
Creates a new optional tuple parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
static ParameterProcessorFactory param(String parameterName, ObjectSchemaBuilder schemaBuilder)
Creates a required object parameter serialized as comma separated, likekey1,value1,key2,value2- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, ObjectSchemaBuilder schemaBuilder)
Creates an optional object parameter serialized as comma separated, likekey1,value1,key2,value2- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
static ParameterProcessorFactory param(String parameterName, SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)
Creates a required parameter providing aValueParser- Parameters:
parameterName-schemaBuilder-valueParser-- Returns:
-
optionalParam
static ParameterProcessorFactory optionalParam(String parameterName, SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)
Creates an optional parameter providing aValueParser- Parameters:
parameterName-schemaBuilder-valueParser-- Returns:
-
jsonParam
static StyledParameterProcessorFactory jsonParam(String parameterName, SchemaBuilder builder)
Creates a required parameter serialized as valid json- Parameters:
parameterName-builder-- Returns:
-
optionalJsonParam
static StyledParameterProcessorFactory optionalJsonParam(String parameterName, SchemaBuilder builder)
Creates an optional parameter serialized as valid json- Parameters:
parameterName-builder-- Returns:
-
serializedParam
static StyledParameterProcessorFactory serializedParam(String parameterName, ArrayParserFactory arrayParserFactory, ArraySchemaBuilder schemaBuilder)
Creates a required array parameter deserializable using the provided parser factory. Look atParsersfor available parser factories- Parameters:
parameterName-arrayParserFactory-schemaBuilder-
-
optionalSerializedParam
static StyledParameterProcessorFactory optionalSerializedParam(String parameterName, ArrayParserFactory arrayParserFactory, ArraySchemaBuilder schemaBuilder)
Creates an optional array parameter deserializable using the provided parser factory. Look atParsersfor available parser factories- Parameters:
parameterName-arrayParserFactory-schemaBuilder-
-
serializedParam
static StyledParameterProcessorFactory serializedParam(String parameterName, TupleParserFactory tupleParserFactory, TupleSchemaBuilder schemaBuilder)
Creates a required tuple parameter deserializable using the provided parser factory. Look atParsersfor available parser factories- Parameters:
parameterName-tupleParserFactory-schemaBuilder-
-
optionalSerializedParam
static StyledParameterProcessorFactory optionalSerializedParam(String parameterName, TupleParserFactory tupleParserFactory, TupleSchemaBuilder schemaBuilder)
Creates an optional tuple parameter deserializable using the provided parser factory. Look atParsersfor available parser factories- Parameters:
parameterName-tupleParserFactory-schemaBuilder-
-
serializedParam
static StyledParameterProcessorFactory serializedParam(String parameterName, ObjectParserFactory objectParserFactory, ObjectSchemaBuilder schemaBuilder)
Creates a required object parameter deserializable using the provided parser factory. Look atParsersfor available parser factories- Parameters:
parameterName-objectParserFactory-schemaBuilder-
-
optionalSerializedParam
static StyledParameterProcessorFactory optionalSerializedParam(String parameterName, ObjectParserFactory objectParserFactory, ObjectSchemaBuilder schemaBuilder)
Creates an optional object parameter deserializable using the provided parser factory. Look atParsersfor available parser factories- Parameters:
parameterName-objectParserFactory-schemaBuilder-
-
explodedParam
static StyledParameterProcessorFactory explodedParam(String parameterName, ArraySchemaBuilder schemaBuilder)
Creates a required exploded array parameter. Exploded parameters looks likeparameterName=item1 ¶meterName=item2- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalExplodedParam
static StyledParameterProcessorFactory optionalExplodedParam(String parameterName, ArraySchemaBuilder schemaBuilder)
Creates an optional exploded array parameter. Exploded parameters looks likeparameterName=item1 ¶meterName=item2- Parameters:
parameterName-schemaBuilder-- Returns:
-
explodedParam
static StyledParameterProcessorFactory explodedParam(String parameterName, TupleSchemaBuilder schemaBuilder)
Creates a required exploded tuple parameter. Exploded parameters looks likeparameterName=item1 ¶meterName=item2- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalExplodedParam
static StyledParameterProcessorFactory optionalExplodedParam(String parameterName, TupleSchemaBuilder schemaBuilder)
Creates an optional exploded tuple parameter. Exploded parameters looks likeparameterName=item1 ¶meterName=item2- Parameters:
parameterName-schemaBuilder-- Returns:
-
explodedParam
static StyledParameterProcessorFactory explodedParam(String parameterName, ObjectSchemaBuilder schemaBuilder)
Creates a required exploded object parameter. Exploded parameters looks likekey1=value1&key2=value2- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalExplodedParam
static StyledParameterProcessorFactory optionalExplodedParam(String parameterName, ObjectSchemaBuilder schemaBuilder)
Creates an optional exploded object parameter. Exploded parameters looks likekey1=value1&key2=value2- Parameters:
parameterName-schemaBuilder-- Returns:
-
deepObjectParam
static StyledParameterProcessorFactory deepObjectParam(String parameterName, ObjectSchemaBuilder schemaBuilder)
Creates a required deep object parameter. Deep object parameters looks likeparameterName[key1]=value1 ¶meterName[key2]=value2- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalDeepObjectParam
static StyledParameterProcessorFactory optionalDeepObjectParam(String parameterName, ObjectSchemaBuilder schemaBuilder)
Creates an optional deep object parameter. Deep object parameters looks likeparameterName[key1]=value1 ¶meterName[key2]=value2- Parameters:
parameterName-schemaBuilder-- Returns:
-
-