io.quarkus.qute.i18n.MessageParam Maven / Gradle / Ivy

Go to download

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

Offer templating support for web, email, etc in a build time, type-safe way

There is a newer version: 3.17.0.CR1

package io.quarkus.qute.i18n;

import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

/**
 * This annotation can be used to bind a message bundle method parameter with a template parameter declaration.
 * 
 * By default, the parameter element's name is used as-is.
 * 
 * 
 * 
 * @MessageBundle
 * interface MyBundle {
 * 
 *     @Message("Hello {name}!")
 *     String hello_world(@MessageParam("name") String foo);
 * }
 * 
 * 
 * 
 * @see Message
 */
@Retention(RUNTIME)
@Target(PARAMETER)
public @interface MessageParam {

    /**
     * 
     * @return the name of the parameter declaration
     */
    String value() default Message.ELEMENT_NAME;

}