org.jboss.logging.processor.apt

Class MessageMethodBuilder.AptMessageMethod

java.lang.Object

org.jboss.logging.processor.apt.MessageMethodBuilder.AptMessageMethod

All Implemented Interfaces:

java.lang.Comparable<MessageMethod>, JavaDocComment, MessageMethod, MessageObject

Enclosing class:

MessageMethodBuilder

private static class MessageMethodBuilder.AptMessageMethod
extends java.lang.Object
implements MessageMethod

An implementation for the MessageMethod interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.logging.processor.model.MessageMethod

MessageMethod.Message

Field Summary

Fields

Modifier and Type	Field and Description
private Parameter	cause
private javax.lang.model.util.Elements	elements
private boolean	inheritsMessage
private boolean	isOverloaded
private MessageMethod.Message	message
private java.lang.String	messageMethodName
private javax.lang.model.element.ExecutableElement	method
private java.util.Map<Parameter.ParameterType,java.util.Set<Parameter>>	parameters
private ReturnType	returnType
private java.util.Set<ThrowableType>	thrownTypes
private java.lang.String	translationKey

Constructor Summary

Constructors

Constructor and Description
AptMessageMethod(javax.lang.model.util.Elements elements, javax.lang.model.element.ExecutableElement method) Private constructor for the

Method Summary

Modifier and Type	Method and Description
(package private) void	add(Parameter parameter)
Parameter	cause() Returns the cause element if MessageMethod.hasCause() returns true, otherwise null.
int	compareTo(MessageMethod o)
boolean	equals(java.lang.Object obj)
int	formatParameterCount() Returns the number of parameters minus the cause parameter count for the method.
java.lang.String	getComment() The JavaDoc comments if available or null if there are no JavaDoc's present.
boolean	hasCause() Returns true if there is a cause element, otherwise false.
int	hashCode()
boolean	inheritsMessage() Indicates whether the message was inherited from another message or not.
boolean	isLoggerMethod() Returns true if this is a logger method, otherwise false.
boolean	isOverloaded() Returns true if the method is overloaded, otherwise false .
java.lang.String	loggerMethod() Returns the LogMessage annotation associated with this method only if MessageMethod.isLoggerMethod() returns true.
java.lang.String	logLevel() Returns the log level parameter associated with the method only if MessageMethod.isLoggerMethod() returns true.
MessageMethod.Message	message() The MessageMethod.Message to be used for the method.
java.lang.String	messageMethodName() Returns the name of the method used to retrieve the message.
java.lang.String	name() Returns the method name.
java.util.Set<Parameter>	parameters(Parameter.ParameterType parameterType) Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.
java.util.Set<Parameter>	parameters(Parameter.ParameterType parameterType, Parameter.ParameterType... parameterTypes) Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.
javax.lang.model.element.ExecutableElement	reference() The object used to extract information for the message logger or message bundle, if applicable.
ReturnType	returnType() Returns the return type for the method.
java.util.Set<ThrowableType>	thrownTypes() Returns a collection of throwable types the method throws.
java.lang.String	toString()
java.lang.String	translationKey() Returns the name of the key used in the translation files for the message translation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

elements

private final javax.lang.model.util.Elements elements

parameters

private final java.util.Map<Parameter.ParameterType,java.util.Set<Parameter>> parameters

thrownTypes

private final java.util.Set<ThrowableType> thrownTypes

method

private final javax.lang.model.element.ExecutableElement method

returnType

private ReturnType returnType

cause

private Parameter cause

inheritsMessage

private boolean inheritsMessage

isOverloaded

private boolean isOverloaded

message

private MessageMethod.Message message

messageMethodName

private java.lang.String messageMethodName

translationKey

private java.lang.String translationKey

Constructor Detail

AptMessageMethod

AptMessageMethod(javax.lang.model.util.Elements elements,
                 javax.lang.model.element.ExecutableElement method)

Private constructor for the

Parameters:

elements - the elements utility.

method - the method to describe.

Method Detail

add

void add(Parameter parameter)

name

public java.lang.String name()

Description copied from interface: MessageMethod

Returns the method name.

Specified by:

name in interface MessageMethod

Specified by:

name in interface MessageObject

Returns:

the method name.

parameters

public java.util.Set<Parameter> parameters(Parameter.ParameterType parameterType)

Description copied from interface: MessageMethod

Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.

Specified by:

parameters in interface MessageMethod

Parameters:

parameterType - the parameter type to look-up the parameters for.

Returns:

a collection of the parameters or an empty set.

parameters

public java.util.Set<Parameter> parameters(Parameter.ParameterType parameterType,
                                           Parameter.ParameterType... parameterTypes)

Description copied from interface: MessageMethod

Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.

Specified by:

parameters in interface MessageMethod

Parameters:

parameterType - the parameter type to look-up the parameters for.

parameterTypes - an array of types to look-up parameters for.

Returns:

a collection of the parameters or an empty set.

returnType

public ReturnType returnType()

Description copied from interface: MessageMethod

Returns the return type for the method.

Specified by:

returnType in interface MessageMethod

Returns:

the return type for the method.

thrownTypes

public java.util.Set<ThrowableType> thrownTypes()

Description copied from interface: MessageMethod

Returns a collection of throwable types the method throws. If the method throws no exceptions an empty collection is returned.

Specified by:

thrownTypes in interface MessageMethod

Returns:

a collection of throwable types or an empty collection.

message

public MessageMethod.Message message()

Description copied from interface: MessageMethod

The MessageMethod.Message to be used for the method.

Specified by:

message in interface MessageMethod

Returns:

the message.

inheritsMessage

public boolean inheritsMessage()

Description copied from interface: MessageMethod

Indicates whether the message was inherited from another message or not. If true is returned the MessageMethod.Message was inherited from a different method, otherwise false.

Note: false does not indicate the method has a Message annotation.

Specified by:

inheritsMessage in interface MessageMethod

Returns:

true if the message was inherited from a different method, otherwise false.

messageMethodName

public java.lang.String messageMethodName()

Description copied from interface: MessageMethod

Returns the name of the method used to retrieve the message.

Specified by:

messageMethodName in interface MessageMethod

Returns:

the name of the message method.

translationKey

public java.lang.String translationKey()

Description copied from interface: MessageMethod

Returns the name of the key used in the translation files for the message translation.

Specified by:

translationKey in interface MessageMethod

Returns:

the name of the key in the translation files.

hasCause

public boolean hasCause()

Description copied from interface: MessageMethod

Returns true if there is a cause element, otherwise false.

Specified by:

hasCause in interface MessageMethod

Returns:

true if there is a cause element, otherwise false

isOverloaded

public boolean isOverloaded()

Description copied from interface: MessageMethod

Returns true if the method is overloaded, otherwise false .

Specified by:

isOverloaded in interface MessageMethod

Returns:

true if the method is overloaded, otherwise false

cause

public Parameter cause()

Description copied from interface: MessageMethod

Returns the cause element if MessageMethod.hasCause() returns true, otherwise null.

Specified by:

cause in interface MessageMethod

Returns:

the cause element, otherwise null.

loggerMethod

public java.lang.String loggerMethod()

Description copied from interface: MessageMethod

Returns the LogMessage annotation associated with this method only if MessageMethod.isLoggerMethod() returns true.

Specified by:

loggerMethod in interface MessageMethod

Returns:

the log message annotation

logLevel

public java.lang.String logLevel()

Description copied from interface: MessageMethod

Returns the log level parameter associated with the method only if MessageMethod.isLoggerMethod() returns true.

Specified by:

logLevel in interface MessageMethod

Returns:

the log level annotation

formatParameterCount

public int formatParameterCount()

Description copied from interface: MessageMethod

Returns the number of parameters minus the cause parameter count for the method.

Specified by:

formatParameterCount in interface MessageMethod

Returns:

the number of parameters minus the cause parameter count for the method.

isLoggerMethod

public boolean isLoggerMethod()

Description copied from interface: MessageMethod

Returns true if this is a logger method, otherwise false.

Specified by:

isLoggerMethod in interface MessageMethod

Returns:

true if this is a logger method, otherwise false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

reference

public javax.lang.model.element.ExecutableElement reference()

Description copied from interface: MessageObject

The object used to extract information for the message logger or message bundle, if applicable. The reference is not used for the implementation and is provided for convenience.

For example, in an annotation processor implementation a ExecutableElement might be returned.

Specified by:

reference in interface MessageMethod

Specified by:

reference in interface MessageObject

Returns:

the reference object used to extract information.

compareTo

public int compareTo(MessageMethod o)

Specified by:

compareTo in interface java.lang.Comparable<MessageMethod>

getComment

public java.lang.String getComment()

Description copied from interface: JavaDocComment

The JavaDoc comments if available or null if there are no JavaDoc's present.

Specified by:

getComment in interface JavaDocComment

Returns:

the JavaDoc comments or null.