Package io.quarkus.websockets.next

Annotation Interface PathParam

@Retention(RUNTIME) @Target(PARAMETER) public @interface PathParam
Identifies an endpoint callback method parameter that should be injected with a value returned from WebSocketConnection.pathParam(String).

The parameter type must be String and the name must be defined in the relevant endpoint path, otherwise the build fails.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    The name of the parameter.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT_NAME
    Constant value for value() indicating that the annotated element's name should be used as-is.

  • Field Details

    • ELEMENT_NAME

      static final String ELEMENT_NAME
      Constant value for value() indicating that the annotated element's name should be used as-is.
      See Also:

  • Element Details

    • value

      String value
      The name of the parameter. By default, the element's name is used as-is.
      Returns:
      the name of the parameter
      Default:
      "<<element name>>"