Interface MessageMethod
- All Superinterfaces:
AnnotatedConstruct
,Comparable<MessageMethod>
,DelegatingElement
,DelegatingExecutableElement
,Element
,ExecutableElement
,JavaDocComment
,Parameterizable
- All Known Implementing Classes:
MessageMethodBuilder.AptMessageMethod
public interface MessageMethod
extends Comparable<MessageMethod>, JavaDocComment, DelegatingExecutableElement
Date: 29.07.2011
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Represents aMessage
annotation on a method. -
Method Summary
Modifier and TypeMethodDescriptioncause()
int
Returns the number of parameters minus the cause parameter count for the method.boolean
hasCause()
Returnstrue
if there is a cause element, otherwisefalse
.boolean
Indicates whether the message was inherited from another message or not.boolean
Returnstrue
if this is a logger method, otherwisefalse
.boolean
Returnstrue
if the method is overloaded, otherwisefalse
.Returns the LogMessage annotation associated with this method only ifisLoggerMethod()
returnstrue
.logLevel()
Returns the log level parameter associated with the method only ifisLoggerMethod()
returnstrue
.message()
TheMessageMethod.Message
to be used for the method.Returns the name of the method used to retrieve the message.name()
Returns the method name.Returns the parameters for the method.parametersAnnotatedWith
(Class<? extends Annotation> annotation) Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.Returns the return type for the method.Returns a collection of throwable types the method throws.Returns the name of the key used in the translation files for the message translation.Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.jboss.logging.processor.model.DelegatingElement
accept, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getEnclosedElements, getKind, getModifiers, isAnnotatedWith
Methods inherited from interface org.jboss.logging.processor.model.DelegatingExecutableElement
asType, getDefaultValue, getDelegate, getEnclosingElement, getParameters, getReceiverType, getReturnType, getSimpleName, getThrownTypes, getTypeParameters, isDefault, isVarArgs
Methods inherited from interface org.jboss.logging.processor.model.JavaDocComment
getComment
-
Method Details
-
name
String name()Returns the method name.- Returns:
- the method name.
-
parameters
Returns the parameters for the method.- Returns:
- the parameters for the method
-
parametersAnnotatedWith
Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.- Parameters:
annotation
- the annotation to get the parameters for- Returns:
- a collection of the parameters or an empty set.
-
returnType
ReturnType returnType()Returns the return type for the method.- Returns:
- the return type for the method.
-
thrownTypes
Set<ThrowableType> thrownTypes()Returns a collection of throwable types the method throws. If the method throws no exceptions an empty collection is returned.- Returns:
- a collection of throwable types or an empty collection.
-
message
MessageMethod.Message message()TheMessageMethod.Message
to be used for the method.- Returns:
- the message.
-
inheritsMessage
boolean inheritsMessage()Indicates whether the message was inherited from another message or not. Iftrue
is returned theMessageMethod.Message
was inherited from a different method, otherwisefalse
. Note:false
does not indicate the method has aMessage
annotation.- Returns:
true
if the message was inherited from a different method, otherwisefalse
.
-
messageMethodName
String messageMethodName()Returns the name of the method used to retrieve the message.- Returns:
- the name of the message method.
-
translationKey
String translationKey()Returns the name of the key used in the translation files for the message translation.- Returns:
- the name of the key in the translation files.
-
hasCause
boolean hasCause()Returnstrue
if there is a cause element, otherwisefalse
.- Returns:
true
if there is a cause element, otherwisefalse
-
isOverloaded
boolean isOverloaded()Returnstrue
if the method is overloaded, otherwisefalse
.- Returns:
true
if the method is overloaded, otherwisefalse
-
cause
Parameter cause()- Returns:
- the cause element, otherwise
null
.
-
loggerMethod
String loggerMethod()Returns the LogMessage annotation associated with this method only ifisLoggerMethod()
returnstrue
.- Returns:
- the log message annotation
-
logLevel
String logLevel()Returns the log level parameter associated with the method only ifisLoggerMethod()
returnstrue
.- Returns:
- the enum name of the log level
-
formatParameterCount
int formatParameterCount()Returns the number of parameters minus the cause parameter count for the method.- Returns:
- the number of parameters minus the cause parameter count for the method.
-
isLoggerMethod
boolean isLoggerMethod()Returnstrue
if this is a logger method, otherwisefalse
.- Returns:
true
if this is a logger method, otherwisefalse
.
-