io.quarkus.qute.i18n.Message Maven / Gradle / Ivy
Show all versions of quarkus-qute Show documentation
package io.quarkus.qute.i18n;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* Identifies a message bundle method.
*
* Each method of a message bundle interface annotated with {@link MessageBundle} must be annotated with this annotation.
*
* @see MessageBundle
*/
@Retention(RUNTIME)
@Target(METHOD)
public @interface Message {
/**
* Constant value for {@link #key()} indicating that the default strategy specified by {@link MessageBundle#defaultKey()}
* should be used.
*/
String DEFAULT_NAME = "<>";
/**
* Constant value for {@link #key()} indicating that the annotated element's name should be used as-is.
*/
String ELEMENT_NAME = "<>";
/**
* Constant value for {@link #value()} indicating that message template value specified in a localized file
* should be used. If localized file fails to provide value, an exception is thrown and the build fails.
*/
String DEFAULT_VALUE = "<>";
/**
* Constant value for {@link #key()} indicating that the annotated element's name should be de-camel-cased and
* hyphenated, and then used.
*/
String HYPHENATED_ELEMENT_NAME = "<>";
/**
* Constant value for{@link #key()} indicating that the annotated element's name should be de-camel-cased and parts
* separated by underscores, and then used.
*/
String UNDERSCORED_ELEMENT_NAME = "<>";
/**
*
* @return the key
*/
String key() default DEFAULT_NAME;
/**
* This value has higher priority over a message template specified in a localized file, and it's
* considered a good practice to specify it. In case the value is not provided and there is no
* match in the localized file too, the build fails.
*
* @return the message template
*/
String value() default DEFAULT_VALUE;
}