Package org.jboss.logging.processor.model

Interface LoggerMessageMethod

All Superinterfaces:

AnnotatedConstruct, Comparable<MessageMethod>, DelegatingElement, DelegatingExecutableElement, Element, ExecutableElement, JavaDocComment, MessageMethod, Parameterizable

public interface LoggerMessageMethod
extends MessageMethod

Represents a method which is annotated with LogMessage.

Author:

James R. Perkins

Nested Class Summary

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

MessageMethod.Message

Method Summary

Modifier and Type	Method	Description
String	loggerMethod()	Returns the log method to use.
String	logLevel()	Returns the log level parameter associated with the method.
default boolean	wrapInEnabledCheck()	Indicates whether or not the level should be checked before any logging, or an expensive operation, is done.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.jboss.logging.processor.model.DelegatingElement

accept, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getEnclosedElements, getEnclosingElement, getKind, getModifiers, isAnnotatedWith

Methods inherited from interface org.jboss.logging.processor.model.DelegatingExecutableElement

asType, getDefaultValue, getDelegate, getParameters, getReceiverType, getReturnType, getSimpleName, getThrownTypes, getTypeParameters, isDefault, isVarArgs

Methods inherited from interface javax.lang.model.element.Element

equals, hashCode

Methods inherited from interface org.jboss.logging.processor.model.JavaDocComment

getComment

Methods inherited from interface org.jboss.logging.processor.model.MessageMethod

cause, formatParameterCount, hasCause, inheritsMessage, isOverloaded, message, messageMethodName, name, parameters, parametersAnnotatedWith, returnType, thrownTypes, translationKey

Method Details

loggerMethod

String loggerMethod()

Returns the log method to use.

Returns:

the log method to use

logLevel

String logLevel()

Returns the log level parameter associated with the method.

Returns:

the enum name of the log level

wrapInEnabledCheck

default boolean wrapInEnabledCheck()

Indicates whether or not the level should be checked before any logging, or an expensive operation, is done.

Returns:

true if the statement should be wrapped in an if (logger.isEnabled(level)) block, otherwise false