Interface MessageMethod.Message
- Enclosing interface:
- MessageMethod
public static interface MessageMethod.Message
Represents a
Message
annotation on a method.-
Method Summary
Modifier and TypeMethodDescriptionorg.jboss.logging.annotations.Message.Format
format()
The message format type for the message.boolean
hasId()
Checks if the message has an id that was provided.int
id()
The message id for the message to use.boolean
Checks if the message id was inherited.value()
A format string that can be used with theformat()
.
-
Method Details
-
id
int id()The message id for the message to use. Any id less than 0 will be ignored.- Returns:
- the message id.
-
hasId
boolean hasId()Checks if the message has an id that was provided. Returnstrue
if the message id was specified or inherited, otherwise returnsfalse
.- Returns:
true
if the message id was provided, otherwisefalse
.
-
inheritsId
boolean inheritsId()Checks if the message id was inherited. Returnstrue
only if the message id is inherited, otherwisefalse
is returned.- Returns:
true
if the message id was inherited, otherwisefalse
.
-
value
String value()A format string that can be used with theformat()
.- Returns:
- a format string.
-
format
org.jboss.logging.annotations.Message.Format format()The message format type for the message.- Returns:
- the format type.
-