Class Parameters
- java.lang.Object
-
- io.vertx.rxjava3.ext.web.validation.builder.Parameters
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class Parameters extends Object implements io.vertx.lang.rx.RxDelegate
In this interface you can find all availableParameterProcessorFactoryto use inValidationHandlerBuilder.
To create new schemas using , look at the docs of vertx-json-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<Parameters>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description Parameters(Parameters delegate)Parameters(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StyledParameterProcessorFactorydeepObjectParam(String parameterName, ObjectSchemaBuilder schemaBuilder)Creates a required deep object parameter.booleanequals(Object o)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.ParametersgetDelegate()inthashCode()static StyledParameterProcessorFactoryjsonParam(String parameterName, SchemaBuilder builder)Creates a required parameter serialized as valid jsonstatic ParametersnewInstance(Parameters arg)static 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 astatic 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 astatic 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.StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<Parameters> __TYPE_ARG
-
-
Constructor Detail
-
Parameters
public Parameters(Parameters delegate)
-
Parameters
public Parameters(Object delegate)
-
-
Method Detail
-
getDelegate
public Parameters getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
param
public 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
public 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
public static ParameterProcessorFactory param(String parameterName, StringSchemaBuilder schemaBuilder)
Creates a new required string parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
public static ParameterProcessorFactory optionalParam(String parameterName, StringSchemaBuilder schemaBuilder)
Creates a new optional string parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
public static ParameterProcessorFactory param(String parameterName, BooleanSchemaBuilder schemaBuilder)
Creates a new required boolean parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
public static ParameterProcessorFactory optionalParam(String parameterName, BooleanSchemaBuilder schemaBuilder)
Creates a new optional boolean parameter- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
public static ParameterProcessorFactory param(String parameterName, ArraySchemaBuilder schemaBuilder)
Creates a new required array parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
public static ParameterProcessorFactory optionalParam(String parameterName, ArraySchemaBuilder schemaBuilder)
Creates a new optional array parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
public static ParameterProcessorFactory param(String parameterName, TupleSchemaBuilder schemaBuilder)
Creates a new required tuple parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
optionalParam
public static ParameterProcessorFactory optionalParam(String parameterName, TupleSchemaBuilder schemaBuilder)
Creates a new optional tuple parameter serialized as comma separated- Parameters:
parameterName-schemaBuilder-- Returns:
-
param
public 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
public 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
public static ParameterProcessorFactory param(String parameterName, SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)
Creates a required parameter providing a- Parameters:
parameterName-schemaBuilder-valueParser-- Returns:
-
optionalParam
public static ParameterProcessorFactory optionalParam(String parameterName, SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)
Creates an optional parameter providing a- Parameters:
parameterName-schemaBuilder-valueParser-- Returns:
-
jsonParam
public static StyledParameterProcessorFactory jsonParam(String parameterName, SchemaBuilder builder)
Creates a required parameter serialized as valid json- Parameters:
parameterName-builder-- Returns:
-
optionalJsonParam
public static StyledParameterProcessorFactory optionalJsonParam(String parameterName, SchemaBuilder builder)
Creates an optional parameter serialized as valid json- Parameters:
parameterName-builder-- Returns:
-
serializedParam
public 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-- Returns:
-
optionalSerializedParam
public 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-- Returns:
-
serializedParam
public 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-- Returns:
-
optionalSerializedParam
public 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-- Returns:
-
serializedParam
public 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-- Returns:
-
optionalSerializedParam
public 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-- Returns:
-
explodedParam
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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:
-
newInstance
public static Parameters newInstance(Parameters arg)
-
-