Module io.helidon.common.http
Package io.helidon.common.http

Annotation Interface QueryParam

@Target(PARAMETER) @Retention(CLASS) @Documented public @interface QueryParam
Inject query parameter into a method parameter.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Name of the parameter.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    Default value to use if the query parameter is not available.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NO_DEFAULT_VALUE
    Configured value meaning the annotation has a default value.

  • Field Details

    • NO_DEFAULT_VALUE

      static final String NO_DEFAULT_VALUE
      Configured value meaning the annotation has a default value.
      See Also:

  • Element Details

    • value

      String value
      Name of the parameter.
      Returns:
      name of the query parameter

    • defaultValue

      String defaultValue
      Default value to use if the query parameter is not available.
      Returns:
      default value, if none specified, the query parameter is considered required
      Default:
      "io.helidon.nima.htp.api.QueryParam_NO_DEFAULT_VALUE"