Package org.jboss.logging.annotations
Annotation Type Message
-
@Target(METHOD) @Retention(CLASS) @Documented public @interface Message
Assigns a message string to a resource method. The method arguments are used to supply the positional parameter values for the method.- Author:
- David M. Lloyd
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Message.Format
format
The format type of this method (defaults toMessage.Format.PRINTF
).int
id
The message ID number.
-
-
-
Element Detail
-
value
String value
The default format string of this message.Expressions in the form of
${property.key:default-value}
can be used for the value. If the property key is prefixed withsys.
a system property will be used. If the key is prefixed withenv.
an environment variable will be used. In all other cases theorg.jboss.logging.tools.expressionProperties
processor argument is used to specify the path the properties file which contains the values for the expressions.- Returns:
- the format string
-
-
-
id
int id
The message ID number. Only one message with a given name may specify an ID other thanINHERIT
.- Returns:
- the message ID number
- Default:
- -1
-
-
-
format
Message.Format format
The format type of this method (defaults toMessage.Format.PRINTF
).- Returns:
- the format type
- Default:
- org.jboss.logging.annotations.Message.Format.PRINTF
-
-