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

Class RequestParameters

java.lang.Object
io.vertx.mutiny.ext.web.validation.RequestParameters
All Implemented Interfaces:
MutinyDelegate
public class RequestParameters extends Object implements MutinyDelegate
Container for request parameters

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

Author:
Francesco Guardiani @slinkydeveloper
See Also:
  • RequestParameters

  • Field Details

  • Constructor Details

    • RequestParameters

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

    • RequestParameters

      public RequestParameters(Object delegate)

  • Method Details

    • getDelegate

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

    • pathParametersNames

      public List<String> pathParametersNames()
      Get list of all parameter names inside path
      Returns:

    • pathParameter

      public RequestParameter pathParameter(String name)
      Get path parameter by name
      Parameters:
      name - Parameter name
      Returns:
      . Can be null.

    • queryParametersNames

      public List<String> queryParametersNames()
      Get list of all parameter names inside query
      Returns:

    • queryParameter

      public RequestParameter queryParameter(String name)
      Get query parameter by name
      Parameters:
      name - Parameter name
      Returns:
      . Can be null.

    • headerParametersNames

      public List<String> headerParametersNames()
      Get list of all parameter names inside header
      Returns:

    • headerParameter

      public RequestParameter headerParameter(String name)
      Get header parameter by name. This getter is case insensitive.
      Parameters:
      name - Parameter name
      Returns:
      . Can be null.

    • cookieParametersNames

      public List<String> cookieParametersNames()
      Get list of all parameter names inside cookie
      Returns:

    • cookieParameter

      public RequestParameter cookieParameter(String name)
      Get cookie parameter by name
      Parameters:
      name - Parameter name
      Returns:
      . Can be null.

    • body

      public RequestParameter body()
      Return request body when parsed. Forms are managed as JsonObject
      Returns:
      . Can be null.

    • toJson

      public io.vertx.core.json.JsonObject toJson()
      This method converts RequestParameters in an unique JsonObject with 6 fields: cookie, path, query, header, form, body
      cookie, path, query, header, form are JsonObject where keys are param names and values are param values, while body depends on body's shape and may not exist
      Returns:

    • newInstance

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

    • 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