Package io.vertx.mutiny.ext.web.validation.builder

Class Parameters

java.lang.Object
io.vertx.mutiny.ext.web.validation.builder.Parameters
All Implemented Interfaces:
MutinyDelegate
public class Parameters extends Object implements MutinyDelegate
In this interface you can find all available ParameterProcessorFactory to use in ValidationHandlerBuilder.

To create new schemas using SchemaBuilder, look at the docs of vertx-json-schema

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

See Also:
  • Parameters

  • Field Details

  • Constructor Details

    • Parameters

      public Parameters(io.vertx.ext.web.validation.builder.Parameters delegate)
      Create a new instance of Parameters delegating to the given (non-null) instance of Parameters.

    • Parameters

      public Parameters(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.validation.builder.Parameters 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

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.NumberSchemaBuilder schemaBuilder)
      Creates a new required number parameter. Depending on the type provided in schemaBuilder, the parser will parse the number as Long or Double
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.NumberSchemaBuilder schemaBuilder)
      Creates a new optional number parameter. Depending on the type provided in schemaBuilder, the parser will parse the number as Long or Double
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.StringSchemaBuilder schemaBuilder)
      Creates a new required string parameter
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.StringSchemaBuilder schemaBuilder)
      Creates a new optional string parameter
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.BooleanSchemaBuilder schemaBuilder)
      Creates a new required boolean parameter
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.BooleanSchemaBuilder schemaBuilder)
      Creates a new optional boolean parameter
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.ArraySchemaBuilder schemaBuilder)
      Creates a new required array parameter serialized as comma separated
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.ArraySchemaBuilder schemaBuilder)
      Creates a new optional array parameter serialized as comma separated
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.TupleSchemaBuilder schemaBuilder)
      Creates a new required tuple parameter serialized as comma separated
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.TupleSchemaBuilder schemaBuilder)
      Creates a new optional tuple parameter serialized as comma separated
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates a required object parameter serialized as comma separated, like key1,value1,key2,value2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates an optional object parameter serialized as comma separated, like key1,value1,key2,value2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • param

      public static ParameterProcessorFactory param(String parameterName, io.vertx.json.schema.common.dsl.SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)
      Creates a required parameter providing a ValueParser
      Parameters:
      parameterName -
      schemaBuilder -
      valueParser -
      Returns:

    • optionalParam

      public static ParameterProcessorFactory optionalParam(String parameterName, io.vertx.json.schema.common.dsl.SchemaBuilder schemaBuilder, io.vertx.ext.web.validation.impl.parser.ValueParser<String> valueParser)
      Creates an optional parameter providing a ValueParser
      Parameters:
      parameterName -
      schemaBuilder -
      valueParser -
      Returns:

    • jsonParam

      public static StyledParameterProcessorFactory jsonParam(String parameterName, io.vertx.json.schema.common.dsl.SchemaBuilder builder)
      Creates a required parameter serialized as valid json
      Parameters:
      parameterName -
      builder -
      Returns:

    • optionalJsonParam

      public static StyledParameterProcessorFactory optionalJsonParam(String parameterName, io.vertx.json.schema.common.dsl.SchemaBuilder builder)
      Creates an optional parameter serialized as valid json
      Parameters:
      parameterName -
      builder -
      Returns:

    • serializedParam

      public static StyledParameterProcessorFactory serializedParam(String parameterName, ArrayParserFactory arrayParserFactory, io.vertx.json.schema.common.dsl.ArraySchemaBuilder schemaBuilder)
      Creates a required array parameter deserializable using the provided parser factory. Look at Parsers for available parser factories
      Parameters:
      parameterName -
      arrayParserFactory -
      schemaBuilder -

    • optionalSerializedParam

      public static StyledParameterProcessorFactory optionalSerializedParam(String parameterName, ArrayParserFactory arrayParserFactory, io.vertx.json.schema.common.dsl.ArraySchemaBuilder schemaBuilder)
      Creates an optional array parameter deserializable using the provided parser factory. Look at Parsers for available parser factories
      Parameters:
      parameterName -
      arrayParserFactory -
      schemaBuilder -

    • serializedParam

      public static StyledParameterProcessorFactory serializedParam(String parameterName, TupleParserFactory tupleParserFactory, io.vertx.json.schema.common.dsl.TupleSchemaBuilder schemaBuilder)
      Creates a required tuple parameter deserializable using the provided parser factory. Look at Parsers for available parser factories
      Parameters:
      parameterName -
      tupleParserFactory -
      schemaBuilder -

    • optionalSerializedParam

      public static StyledParameterProcessorFactory optionalSerializedParam(String parameterName, TupleParserFactory tupleParserFactory, io.vertx.json.schema.common.dsl.TupleSchemaBuilder schemaBuilder)
      Creates an optional tuple parameter deserializable using the provided parser factory. Look at Parsers for available parser factories
      Parameters:
      parameterName -
      tupleParserFactory -
      schemaBuilder -

    • serializedParam

      public static StyledParameterProcessorFactory serializedParam(String parameterName, ObjectParserFactory objectParserFactory, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates a required object parameter deserializable using the provided parser factory. Look at Parsers for available parser factories
      Parameters:
      parameterName -
      objectParserFactory -
      schemaBuilder -

    • optionalSerializedParam

      public static StyledParameterProcessorFactory optionalSerializedParam(String parameterName, ObjectParserFactory objectParserFactory, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates an optional object parameter deserializable using the provided parser factory. Look at Parsers for available parser factories
      Parameters:
      parameterName -
      objectParserFactory -
      schemaBuilder -

    • explodedParam

      public static StyledParameterProcessorFactory explodedParam(String parameterName, io.vertx.json.schema.common.dsl.ArraySchemaBuilder schemaBuilder)
      Creates a required exploded array parameter. Exploded parameters looks like parameterName=item1 &parameterName=item2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalExplodedParam

      public static StyledParameterProcessorFactory optionalExplodedParam(String parameterName, io.vertx.json.schema.common.dsl.ArraySchemaBuilder schemaBuilder)
      Creates an optional exploded array parameter. Exploded parameters looks like parameterName=item1 &parameterName=item2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • explodedParam

      public static StyledParameterProcessorFactory explodedParam(String parameterName, io.vertx.json.schema.common.dsl.TupleSchemaBuilder schemaBuilder)
      Creates a required exploded tuple parameter. Exploded parameters looks like parameterName=item1 &parameterName=item2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalExplodedParam

      public static StyledParameterProcessorFactory optionalExplodedParam(String parameterName, io.vertx.json.schema.common.dsl.TupleSchemaBuilder schemaBuilder)
      Creates an optional exploded tuple parameter. Exploded parameters looks like parameterName=item1 &parameterName=item2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • explodedParam

      public static StyledParameterProcessorFactory explodedParam(String parameterName, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates a required exploded object parameter. Exploded parameters looks like key1=value1&key2=value2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalExplodedParam

      public static StyledParameterProcessorFactory optionalExplodedParam(String parameterName, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates an optional exploded object parameter. Exploded parameters looks like key1=value1&key2=value2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • deepObjectParam

      public static StyledParameterProcessorFactory deepObjectParam(String parameterName, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates a required deep object parameter. Deep object parameters looks like parameterName[key1]=value1 &parameterName[key2]=value2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • optionalDeepObjectParam

      public static StyledParameterProcessorFactory optionalDeepObjectParam(String parameterName, io.vertx.json.schema.common.dsl.ObjectSchemaBuilder schemaBuilder)
      Creates an optional deep object parameter. Deep object parameters looks like parameterName[key1]=value1 &parameterName[key2]=value2
      Parameters:
      parameterName -
      schemaBuilder -
      Returns:

    • newInstance

      public static Parameters newInstance(io.vertx.ext.web.validation.builder.Parameters delegate)
      Creates a new instance of the Parameters.

    • 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