io.quarkus.websockets.next.PathParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-websockets-next Show documentation

Implementation of the WebSocket API with enhanced efficiency and usability

There is a newer version: 3.17.2

Show newest version

package io.quarkus.websockets.next;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Identifies an endpoint callback method parameter that should be injected with a value returned from
 * {@link WebSocketConnection#pathParam(String)}.
 * 
 * The parameter type must be {@link String} and the name must be defined in the relevant endpoint path, otherwise
 * the build fails.
 *
 * @see WebSocketConnection#pathParam(String)
 * @see WebSocket
 * @see WebSocketClientConnection#pathParam(String)
 * @see WebSocketClient
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface PathParam {

    /**
     * Constant value for {@link #value()} indicating that the annotated element's name should be used as-is.
     */
    String ELEMENT_NAME = "<>";

    /**
     * The name of the parameter. By default, the element's name is used as-is.
     *
     * @return the name of the parameter
     */
    String value() default ELEMENT_NAME;

}