org.jboss.logging.processor.apt

Interface AptHelper

All Known Implementing Classes:

AptHelperImpl

public interface AptHelper

Date: 24.08.2011

Author:

James R. Perkins

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasMessageId(ExecutableElement method) Checks to see if the method has a message id.
boolean	inheritsMessageId(ExecutableElement method) Checks to see if the method should inherit the message id from a different method if applicable.
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

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.

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.

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.

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 Annotations.field() or Annotations.property() an empty string should be returned.

If the parameter is annotated with Annotations.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.