org.jboss.logging.processor.apt
Interface Annotations

All Known Implementing Classes:

AnnotationsImpl

public interface Annotations

An interface used to extract information about the logging annotations.

Author:

James R. Perkins

Nested Class Summary

static class	Annotations.FormatType The message format type.
static interface	Annotations.Void A simple annotation to allow an annotation to be ignored.

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.

Method Detail

getSupportedAnnotations

Set<String> getSupportedAnnotations()

Returns a set of the supported annotations.

Returns:

messageFormat

Annotations.FormatType messageFormat(ExecutableElement method)

Returns the method format type.

Parameters:

method - the method with the Message annotation.

Returns:

the format type of the message or null if the format type was not found.

projectCode

String projectCode(TypeElement intf)

The project code from the interface.

Parameters:

intf - the interface to find the project code on.

Returns:

the project code or null if one was not found.

hasCauseAnnotation

boolean hasCauseAnnotation(VariableElement param)

Checks to see if the parameter has a cause annotation.

Parameters:

param - the parameter to check

Returns:

true if the method has a cause annotation, otherwise false

hasFieldAnnotation

boolean hasFieldAnnotation(VariableElement param)

Checks to see if the parameter has a field annotation.

Parameters:

param - the parameter to check

Returns:

true if the method has a field annotation, otherwise false

hasLoggingClassAnnotation

boolean hasLoggingClassAnnotation(VariableElement param)

Checks to see if the parameter has a logging class annotation.

Parameters:

param - the parameter to check

Returns:

true if the method has a logging class annotation, otherwise false

hasMessageAnnotation

boolean hasMessageAnnotation(ExecutableElement method)

Checks to see if the method is annotated with the message annotation.

Parameters:

method - the method to check

Returns:

true if the annotation was found, otherwise false

hasMessageId

boolean hasMessageId(ExecutableElement method)

Checks to see if the method has a message id.

Parameters:

method - the method to check.

Returns:

true if the message id was found, otherwise false.

hasParamAnnotation

boolean hasParamAnnotation(VariableElement param)

Checks to see if the parameter has a parameter annotation.

Parameters:

param - the parameter to check

Returns:

true if the method has a parameter annotation, otherwise false

hasPropertyAnnotation

boolean hasPropertyAnnotation(VariableElement param)

Checks to see if the parameter has a property annotation.

Parameters:

param - the parameter to check

Returns:

true if the method has a property annotation, otherwise false

inheritsMessageId

boolean inheritsMessageId(ExecutableElement method)

Checks to see if the method should inherit the message id from a different method if applicable.

Parameters:

method - the method to check.

Returns:

true if the message id should be inherited, otherwise false.

isLoggerMethod

boolean isLoggerMethod(ExecutableElement method)

Checks to see if the method is a logger method.

Parameters:

method - the method to check

Returns:

true if the method is a logger method, otherwise false

isMessageBundle

boolean isMessageBundle(TypeElement element)

Checks the element to see it's a message bundle.

Parameters:

element - the interface element

Returns:

true if the interface is a message bundle

isMessageLogger

boolean isMessageLogger(TypeElement element)

Checks the element to see it's a message logger.

Parameters:

element - the interface element

Returns:

true if the interface is a message logger

getFormatWithAnnotationName

String getFormatWithAnnotationName(VariableElement param)

Returns the name of the @FormatWith class.

Parameters:

param - the parameter element

Returns:

the name of the class

getMessageLoggerAnnotationName

String getMessageLoggerAnnotationName(TypeElement element)

Returns the name of the @MessageLogger class.

Parameters:

element - the interface element

Returns:

the name of the class

messageId

int messageId(ExecutableElement method)

Returns the message id.

Parameters:

method - the method to check.

Returns:

the message id or 0 if one was not found.

messageValue

String messageValue(ExecutableElement method)

Returns the message value for the method.

Parameters:

method - the method to check.

Returns:

the message for the method, if no method found null is returned.

loggerMethod

String loggerMethod(Annotations.FormatType formatType)

Returns the logger method name to use or an empty string if the method is not a logger method.

Parameters:

formatType - the format type for the method.

Returns:

the name of the logger method or an empty string.

logLevel

String logLevel(ExecutableElement method)

Returns the log level enum. For example Logger.Level.INFO.

Parameters:

method - the method used to determine the log method.

Returns:

the log level.

targetName

String targetName(VariableElement param)

Returns the target field or method name for the annotated parameter. If the parameter is not annotated with either 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.

Parameters:

param - the parameter to check for the annotation.

Returns:

the field, method name or an empty string.