com.github.kshashov.telegram.api.bind.annotation.BotPathVariable Maven / Gradle / Ivy

Go to download

package com.github.kshashov.telegram.api.bind.annotation;

import com.github.kshashov.telegram.handler.processor.arguments.BotRequestMethodPathArgumentResolver;

import java.lang.annotation.*;

/**
 * Annotation which indicates that a method parameter should be bound to a request template variable. Supported for
 * {@link BotRequest} annotated handler methods.
 *
 * Note: Works only if and when the method parameter is {@link String}.
 *
 * @see BotRequest
 * @see BotRequestMethodPathArgumentResolver
 */
@Target({ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BotPathVariable {

    /**
     * @return Name of the template variable that should be bound to a method parameter.
     */
    String value() default "";
}