|
JBoss Logging I18n Annotation Processor 1.1.0.Final | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jboss.logging.processor.apt.AnnotationsImpl
public class AnnotationsImpl
An implementation for an annotation processor.
This implementation handles bothlocal annotations and deprecated annotations
that were part of the jboss-logging project.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.jboss.logging.processor.apt.Annotations |
|---|
Annotations.FormatType, Annotations.Void |
| Constructor Summary | |
|---|---|
AnnotationsImpl()
|
|
| Method Summary | |
|---|---|
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. |
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. |
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AnnotationsImpl()
| Method Detail |
|---|
public Set<String> getSupportedAnnotations()
Annotations
getSupportedAnnotations in interface Annotationspublic Annotations.FormatType messageFormat(ExecutableElement method)
Annotations
messageFormat in interface Annotationsmethod - the method with the Message annotation.
null if the format type
was not found.public String projectCode(TypeElement intf)
Annotations
projectCode in interface Annotationsintf - the interface to find the project code on.
null if one was not found.public boolean hasCauseAnnotation(VariableElement param)
Annotations
hasCauseAnnotation in interface Annotationsparam - the parameter to check
true if the method has a cause annotation, otherwise falsepublic boolean hasFieldAnnotation(VariableElement param)
Annotations
hasFieldAnnotation in interface Annotationsparam - the parameter to check
true if the method has a field annotation, otherwise falsepublic boolean hasLoggingClassAnnotation(VariableElement param)
Annotations
hasLoggingClassAnnotation in interface Annotationsparam - the parameter to check
true if the method has a logging class annotation, otherwise falsepublic boolean hasMessageAnnotation(ExecutableElement method)
Annotations
hasMessageAnnotation in interface Annotationsmethod - the method to check
true if the annotation was found, otherwise falsepublic boolean hasMessageId(ExecutableElement method)
Annotations
hasMessageId in interface Annotationsmethod - the method to check.
true if the message id was found, otherwise false.public boolean hasParamAnnotation(VariableElement param)
Annotations
hasParamAnnotation in interface Annotationsparam - the parameter to check
true if the method has a parameter annotation, otherwise falsepublic boolean hasPropertyAnnotation(VariableElement param)
Annotations
hasPropertyAnnotation in interface Annotationsparam - the parameter to check
true if the method has a property annotation, otherwise falsepublic boolean inheritsMessageId(ExecutableElement method)
Annotations
inheritsMessageId in interface Annotationsmethod - the method to check.
true if the message id should be inherited, otherwise false.public boolean isLoggerMethod(ExecutableElement method)
Annotations
isLoggerMethod in interface Annotationsmethod - the method to check
true if the method is a logger method, otherwise falsepublic boolean isMessageBundle(TypeElement element)
Annotationselement to see it's a message bundle.
isMessageBundle in interface Annotationselement - the interface element
true if the interface is a message bundlepublic boolean isMessageLogger(TypeElement element)
Annotationselement to see it's a message logger.
isMessageLogger in interface Annotationselement - the interface element
true if the interface is a message loggerpublic String getFormatWithAnnotationName(VariableElement param)
Annotations@FormatWith class.
getFormatWithAnnotationName in interface Annotationsparam - the parameter element
public String getMessageLoggerAnnotationName(TypeElement element)
Annotations@MessageLogger class.
getMessageLoggerAnnotationName in interface Annotationselement - the interface element
public int messageId(ExecutableElement method)
Annotations
messageId in interface Annotationsmethod - the method to check.
public String messageValue(ExecutableElement method)
Annotations
messageValue in interface Annotationsmethod - the method to check.
null is
returned.public String loggerMethod(Annotations.FormatType formatType)
Annotations
loggerMethod in interface AnnotationsformatType - the format type for the method.
public String logLevel(ExecutableElement method)
Annotations
logLevel in interface Annotationsmethod - the method used to determine the log method.
public String targetName(VariableElement param)
AnnotationsField 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.
targetName in interface Annotationsparam - the parameter to check for the annotation.
|
JBoss Logging I18n Annotation Processor 1.1.0.Final | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||