public interface Annotations
Modifier and Type | Interface and Description |
---|---|
static class |
Annotations.FormatType
The message format type.
|
static interface |
Annotations.Void
A simple annotation to allow an annotation to be ignored.
|
Modifier and Type | Method and Description |
---|---|
String |
getFormatWithAnnotationName(VariableElement param)
Returns the name of the
@FormatWith class. |
String |
getMessageLoggerAnnotationName(TypeElement element)
Returns the name of the
@MessageLogger class. |
Set<String> |
getSupportedAnnotations()
Returns a set of the supported annotations.
|
boolean |
hasCauseAnnotation(VariableElement param)
Checks to see if the parameter has a cause annotation.
|
boolean |
hasFieldAnnotation(VariableElement param)
Checks to see if the parameter has a field annotation.
|
boolean |
hasLoggingClassAnnotation(VariableElement param)
Checks to see if the parameter has a logging class annotation.
|
boolean |
hasMessageAnnotation(ExecutableElement method)
Checks to see if the method is annotated with the message annotation.
|
boolean |
hasMessageId(ExecutableElement method)
Checks to see if the method has a message id.
|
boolean |
hasParamAnnotation(VariableElement param)
Checks to see if the parameter has a parameter annotation.
|
boolean |
hasPropertyAnnotation(VariableElement param)
Checks to see if the parameter has a property annotation.
|
int |
idLength(TypeElement intf)
The length the id should be padded.
|
boolean |
inheritsMessageId(ExecutableElement method)
Checks to see if the method should inherit the message id from a different method if applicable.
|
boolean |
isLoggerMethod(ExecutableElement method)
Checks to see if the method is a logger method.
|
boolean |
isMessageBundle(TypeElement element)
Checks the
element to see it's a message bundle. |
boolean |
isMessageLogger(TypeElement element)
Checks the
element to see it's a message logger. |
boolean |
isSupportedInterfaceAnnotation(TypeElement annotation)
Checks that the annotation is a supported interface annotation.
|
String |
loggerMethod(Annotations.FormatType formatType)
Returns the logger method name to use or an empty string if the method is not a logger method.
|
String |
logLevel(ExecutableElement method)
Returns the log level enum.
|
Annotations.FormatType |
messageFormat(ExecutableElement method)
Returns the method format type.
|
int |
messageId(ExecutableElement method)
Returns the message id.
|
String |
messageValue(ExecutableElement method)
Returns the message value for the method.
|
String |
projectCode(TypeElement intf)
The project code from the interface.
|
String |
targetName(VariableElement param)
Returns the target field or method name for the annotated parameter.
|
Set<String> getSupportedAnnotations()
boolean isSupportedInterfaceAnnotation(TypeElement annotation)
false
is returned. The annotations should just be skipped.annotation
- the annotation to checktrue
if this is a supported interface annotation, false
if the annotation should be
skippedAnnotations.FormatType messageFormat(ExecutableElement method)
method
- the method with the Message annotation.null
if the format type
was not found.String projectCode(TypeElement intf)
intf
- the interface to find the project code on.null
if one was not found.int idLength(TypeElement intf)
intf
- the interface to find the project code on.boolean hasCauseAnnotation(VariableElement param)
param
- the parameter to checktrue
if the method has a cause annotation, otherwise false
boolean hasFieldAnnotation(VariableElement param)
param
- the parameter to checktrue
if the method has a field annotation, otherwise false
boolean hasLoggingClassAnnotation(VariableElement param)
param
- the parameter to checktrue
if the method has a logging class annotation, otherwise false
boolean hasMessageAnnotation(ExecutableElement method)
method
- the method to checktrue
if the annotation was found, otherwise false
boolean hasMessageId(ExecutableElement method)
method
- the method to check.true
if the message id was found, otherwise false
.boolean hasParamAnnotation(VariableElement param)
param
- the parameter to checktrue
if the method has a parameter annotation, otherwise false
boolean hasPropertyAnnotation(VariableElement param)
param
- the parameter to checktrue
if the method has a property annotation, otherwise false
boolean inheritsMessageId(ExecutableElement method)
method
- the method to check.true
if the message id should be inherited, otherwise false
.boolean isLoggerMethod(ExecutableElement method)
method
- the method to checktrue
if the method is a logger method, otherwise false
boolean isMessageBundle(TypeElement element)
element
to see it's a message bundle.element
- the interface elementtrue
if the interface is a message bundleboolean isMessageLogger(TypeElement element)
element
to see it's a message logger.element
- the interface elementtrue
if the interface is a message loggerString getFormatWithAnnotationName(VariableElement param)
@FormatWith
class.param
- the parameter elementString getMessageLoggerAnnotationName(TypeElement element)
@MessageLogger
class.element
- the interface elementint messageId(ExecutableElement method)
method
- the method to check.String messageValue(ExecutableElement method)
method
- the method to check.null
is
returned.String loggerMethod(Annotations.FormatType formatType)
formatType
- the format type for the method.String logLevel(ExecutableElement method)
method
- the method used to determine the log method.String targetName(VariableElement param)
Field
or
Property
an empty string should be returned.
If the parameter is annotated with Property
, the name should
be prepended with set
. For example a property name of value
should return setValue
.
If the annotation does not have a defined value, the parameter name should be returned.param
- the parameter to check for the annotation.Copyright © 2023 JBoss by Red Hat. All rights reserved.