Skip navigation links
JBoss Logging Tools Parent 1.2.1.Final
A B C D E F G H I J L M N O P Q R S T U V W 

A

AbstractGenerator - Class in org.jboss.logging.processor.apt
An abstract processor used process annotations.
add(boolean) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of a boolean to the final hash code value.
add(char) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of a character to the final hash code value.
add(int) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of an integer to the final hash code value.
add(long) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of a long to the final hash code value.
add(float) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of a float to the final hash code value.
add(double) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of a double to the final hash code value.
add(Object) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Adds the hash code of an object to the final hash code value.
add(Object) - Method in class org.jboss.logging.processor.util.Objects.ToStringBuilder
 
add(String, Object) - Method in class org.jboss.logging.processor.util.Objects.ToStringBuilder
Adds the field and value to the value returned.
Annotations - Interface in org.jboss.logging.processor.apt
An interface used to extract information about the logging annotations.
annotations() - Static method in class org.jboss.logging.processor.Tools
Locates the first implementation of Annotations.
Annotations.FormatType - Enum in org.jboss.logging.processor.apt
The message format type.
Annotations.Void - Annotation Type in org.jboss.logging.processor.apt
A simple annotation to allow an annotation to be ignored.
AnnotationsImpl - Class in org.jboss.logging.processor.apt
An implementation for an annotation processor.
AnnotationsImpl() - Constructor for class org.jboss.logging.processor.apt.AnnotationsImpl
 
areEqual(boolean, boolean) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if two booleans are equal.
areEqual(char, char) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if two characters are equal.
areEqual(long, long) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if two longs are equal.
areEqual(float, float) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if two floats are equal.
areEqual(double, double) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if two doubles are equal.
areEqual(Object, Object) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if two objects are equal.
argumentCount() - Method in interface org.jboss.logging.processor.validation.FormatValidator
The number of arguments needed for the format.
argumentCount() - Method in class org.jboss.logging.processor.validation.StringFormatValidator
 
asFormat() - Method in class org.jboss.logging.processor.validation.StringFormatValidator
Recreates the format using the internal formatting descriptors.

B

begin() - Static method in class org.jboss.logging.processor.util.Comparison
Begins a new comparison.
beginAllowNull() - Static method in class org.jboss.logging.processor.util.Comparison
Begins a new comparison, but allows for null values to be passed.
builder() - Static method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Creates a new builder with 31 as the seed.
builder(int) - Static method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Creates a new builder with the seed that is passed.

C

Cause - Annotation Type in org.jboss.logging.annotations
Mark a parameter as being the "exception cause" parameter rather than a positional format parameter.
cause() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the cause element if MessageMethod.hasCause() returns true, otherwise null.
checkNonNull(T) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if an object is null, otherwise throws an IllegalArgumentException.
checkNonNull(T, String) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if an object is null, otherwise throws an IllegalArgumentException.
checkNonNull(T, String, Object...) - Static method in class org.jboss.logging.processor.util.Objects
Checks to see if an object is null, otherwise throws an IllegalArgumentException.
ClassModel - Class in org.jboss.logging.processor.generator.model
The basic java class model.
ClassModelFactory - Class in org.jboss.logging.processor.generator.model
Creates a class model for the message interface.
ClassModelHelper - Class in org.jboss.logging.processor.generator.model
Utilities for the code model.
compare(Comparable<?>, Comparable<?>) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left comparable to the right as specified by the Comparable.compareTo(Object) interface.
compare(T, T, Comparator<T>) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left object to the right object as specified by the Comparator.compare(Object, Object) interface.
compare(int, int) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left integer to the right integer.
compare(long, long) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left long to the right long.
compare(float, float) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left float to the float integer.
compare(double, double) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left double to the double integer.
compare(boolean, boolean) - Method in class org.jboss.logging.processor.util.Comparison
Compares the left boolean to the double boolean.
compare(String, String) - Method in class org.jboss.logging.processor.util.VersionComparator
 
compareVersion(String, String) - Static method in class org.jboss.logging.processor.util.VersionComparator
Compares the first version to the second version and returns, 0 if they are equal, a value less than 0 if the first version is less than the second version or a value greater than 0 if the first version is greater than the second version.
Comparison - Class in org.jboss.logging.processor.util
Date: 30.08.2011
constructionParameters() - Method in interface org.jboss.logging.processor.model.ThrowableType
The parameters needed to construct the throwable, if not using the default constructor.
create(JavaFileObject) - Method in class org.jboss.logging.processor.generator.model.ClassModel
Creates the source file.
create(MessageMethod) - Static method in class org.jboss.logging.processor.validation.FormatValidatorFactory
 
create(Annotations.FormatType, String) - Static method in class org.jboss.logging.processor.validation.FormatValidatorFactory
 
createError(MessageObject, String) - Static method in class org.jboss.logging.processor.validation.ValidationMessageFactory
 
createError(MessageObject, String, Object...) - Static method in class org.jboss.logging.processor.validation.ValidationMessageFactory
 
createReadResolveMethod() - Method in class org.jboss.logging.processor.generator.model.ClassModel
Creates the read resolve method and instance field.
createWarning(MessageObject, String) - Static method in class org.jboss.logging.processor.validation.ValidationMessageFactory
 
createWarning(MessageObject, String, Object...) - Static method in class org.jboss.logging.processor.validation.ValidationMessageFactory
 

D

debug(String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted debug message if debugging is enabled.
debug(Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a debug message.
debug(Element, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted debug message if debugging is enabled.
DEBUG_OPTION - Static variable in class org.jboss.logging.processor.apt.LoggingToolsProcessor
 
delegatingLogger() - Method in class org.jboss.logging.processor.JBossLoggers
 
delegatingLogger() - Method in interface org.jboss.logging.processor.Loggers
Returns the logger to delegate log methods to if the message interface implements the Loggers.loggerInterface().
detailMessage() - Method in interface org.jboss.logging.processor.validation.FormatValidator
A detail message if FormatValidator.isValid() returns false, otherwise an empty string.

E

ElementHelper - Class in org.jboss.logging.processor.util
An utility class to work with element.
EQUAL - Static variable in class org.jboss.logging.processor.util.Comparison
 
equals(Object) - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
equals(Object) - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Should never be invoked on this object.
error(String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted error message.
error(Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a error message.
error(Element, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted error message.
error(Throwable) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints an error message.
error(Throwable, Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a error message.
error(Throwable, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints an error message.
error(Element, Throwable) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints an error message.
error(Element, Throwable, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints an error message.
extendedInterfaces() - Method in interface org.jboss.logging.processor.model.MessageInterface
A set of qualified interface names this interface extends or an empty set.
extendsLoggerInterface() - Method in interface org.jboss.logging.processor.model.MessageInterface
Checks the interface to see if the logger interface is being extended in this interface.

F

Field - Annotation Type in org.jboss.logging.annotations
Indicate that a method parameter value should be applied to a field on the resultant exception object.
fill(char, int) - Static method in class org.jboss.logging.processor.util.Strings
Creates a string filled with the with the value of the filler parameter with a length defined by the len parameter.
fill(CharSequence, int) - Static method in class org.jboss.logging.processor.util.Strings
Creates a string filled with the with the value of the filler parameter with a length defined by the len parameter.
findByName(Collection<ExecutableElement>, Name) - Static method in class org.jboss.logging.processor.util.ElementHelper
Returns a collection of methods with the same name.
findByName(Collection<ExecutableElement>, Name, int) - Static method in class org.jboss.logging.processor.util.ElementHelper
Returns a collection of methods with the same name.
format() - Method in interface org.jboss.logging.processor.model.MessageMethod.Message
The message format type for the message.
format() - Method in interface org.jboss.logging.processor.validation.FormatValidator
Returns the format string used for validation.
format() - Method in class org.jboss.logging.processor.validation.StringFormatValidator
 
formatClass() - Method in enum org.jboss.logging.processor.apt.Annotations.FormatType
 
formatMessageId(String, int, int) - Static method in class org.jboss.logging.processor.generator.model.ClassModelHelper
Formats message id.
formatParameterCount() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the number of parameters minus the cause parameter count for the method.
formatterClass() - Method in interface org.jboss.logging.processor.model.Parameter
The formatter class, or null if there is none.
FormatValidator - Interface in org.jboss.logging.processor.validation
Date: 14.06.2011
FormatValidatorFactory - Class in org.jboss.logging.processor.validation
Date: 12.08.2011
FormatWith - Annotation Type in org.jboss.logging.annotations
Indicate that the given parameter should be wrapped with a formatting object of the given class.
fromMessageObject(MessageObject) - Static method in class org.jboss.logging.processor.util.ElementHelper
If the MessageObject.reference() is an instance of Element, then the value is returned, otherwise null is returned.

G

getAnnotatedType() - Method in interface org.jboss.logging.processor.model.MessageInterface
Returns the annotation type on the interface.
getAnnotationValue(Element, String, String) - Static method in class org.jboss.logging.processor.util.ElementHelper
Returns the annotation value for the annotation.
getComment() - Method in interface org.jboss.logging.processor.model.JavaDocComment
The JavaDoc comments if available or null if there are no JavaDoc's present.
getEnclosingTranslationClassName(String) - Static method in class org.jboss.logging.processor.util.TranslationHelper
Returns the enclosing translation class name for the given translation class name.
getEnclosingTranslationFileName(File) - Static method in class org.jboss.logging.processor.util.TranslationHelper
Returns the enclosing translation file name for the given translation file name.
getFormatWithAnnotationName(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the name of the @FormatWith class.
getFormatWithAnnotationName(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
getIdLength() - Method in interface org.jboss.logging.processor.model.MessageInterface
The length to pad the id with.
getInstance() - Method in class org.jboss.logging.processor.util.Comparison
Returns the comparison instance being used.
getLogger(ProcessingEnvironment) - Static method in class org.jboss.logging.processor.apt.ToolLogger
Creates a new tool logger.
getMessage() - Method in interface org.jboss.logging.processor.validation.ValidationMessage
Returns the error message.
getMessageLoggerAnnotationName(TypeElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the name of the @MessageLogger class.
getMessageLoggerAnnotationName(TypeElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
getMessageObject() - Method in interface org.jboss.logging.processor.validation.ValidationMessage
Returns the message object that caused the error.
getName() - Method in class org.jboss.logging.processor.apt.AbstractGenerator
Returns the name of the processor.
getPrimaryClassNamePrefix(TypeElement) - Static method in class org.jboss.logging.processor.util.ElementHelper
Returns the primary class simple name prefix for an element who represents a MessageBundle or MessageLogger interface.
getSupportedAnnotations() - Method in interface org.jboss.logging.processor.apt.Annotations
Returns a set of the supported annotations.
getSupportedAnnotations() - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
getSupportedAnnotationTypes() - Method in class org.jboss.logging.processor.apt.LoggingToolsProcessor
 
getSupportedOptions() - Method in class org.jboss.logging.processor.apt.AbstractGenerator
Returns the supported options set.
getSupportedOptions() - Method in class org.jboss.logging.processor.apt.LoggingToolsProcessor
 
getSupportedSourceVersion() - Method in class org.jboss.logging.processor.apt.LoggingToolsProcessor
 
getTranslationClassNameSuffix(String) - Static method in class org.jboss.logging.processor.util.TranslationHelper
Get the class name suffix to be added to the generated class for the given translation file name.
GREATER - Static variable in class org.jboss.logging.processor.util.Comparison
 

H

hasCause() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns true if there is a cause element, otherwise false.
hasCause(Collection<? extends VariableElement>) - Static method in class org.jboss.logging.processor.util.ElementHelper
Checks to see if there is a cause parameter.
hasCauseAnnotation(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the parameter has a cause annotation.
hasCauseAnnotation(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasDefaultConstructor() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks to see the throwable has a default constructor.
hasFieldAnnotation(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the parameter has a field annotation.
hasFieldAnnotation(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasFieldFor(Parameter) - Method in interface org.jboss.logging.processor.model.ReturnType
Checks to see if the return type has a field with the name with the same name and type as the parameter.
hasFieldFor(Parameter) - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
hashCode() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
hashCode() - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
This method overrides the default Object#hashCode(), but does not return a proper hash of this builder.
hasId() - Method in interface org.jboss.logging.processor.model.MessageMethod.Message
Checks if the message has an id that was provided.
hasLoggingClassAnnotation(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the parameter has a logging class annotation.
hasLoggingClassAnnotation(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasMessageAnnotation(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the method is annotated with the message annotation.
hasMessageAnnotation(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasMessageId(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the method has a message id.
hasMessageId(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasMethodFor(Parameter) - Method in interface org.jboss.logging.processor.model.ReturnType
Checks to see if the return type has a method with the name with the same name and parameter type as the parameter.
hasMethodFor(Parameter) - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
hasParamAnnotation(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the parameter has a parameter annotation.
hasParamAnnotation(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasPropertyAnnotation(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the parameter has a property annotation.
hasPropertyAnnotation(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
hasStringAndThrowableConstructor() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks to see if the throwable has a string and throwable (Throwable(String, Throwable)) constructor.
hasStringConstructor() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks to see if the throwable has a string (Throwable(String)) constructor.
hasThrowableAndStringConstructor() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks to see if the throwable has a throwable and string (Throwable(Throwable, String)) constructor.
hasThrowableConstructor() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks to see if the throwable has a string and throwable (Throwable(String, Throwable)) constructor.

I

id() - Method in interface org.jboss.logging.processor.model.MessageMethod.Message
The message id for the message to use.
idLength(TypeElement) - Method in interface org.jboss.logging.processor.apt.Annotations
The length the id should be padded.
idLength(TypeElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
IdLengthValidator - Class in org.jboss.logging.processor.validation
 
IdLengthValidator() - Constructor for class org.jboss.logging.processor.validation.IdLengthValidator
 
IdRangeValidator - Class in org.jboss.logging.processor.validation
 
IdRangeValidator() - Constructor for class org.jboss.logging.processor.validation.IdRangeValidator
 
implementation(MessageInterface, boolean) - Static method in class org.jboss.logging.processor.generator.model.ClassModelFactory
Creates an implementation code model from the message interface.
implementationClassName(MessageInterface) - Static method in class org.jboss.logging.processor.generator.model.ClassModelHelper
Creates the implementation class name for the message interface.
implementationClassName(MessageInterface, String) - Static method in class org.jboss.logging.processor.generator.model.ClassModelHelper
Creates the implementation class name for the message interface.
INHERIT - Static variable in annotation type org.jboss.logging.annotations.Message
Indicates that this message should inherit the ID from another message with the same name.
inheritsId() - Method in interface org.jboss.logging.processor.model.MessageMethod.Message
Checks if the message id was inherited.
inheritsMessage() - Method in interface org.jboss.logging.processor.model.MessageMethod
Indicates whether the message was inherited from another message or not.
inheritsMessage(Collection<ExecutableElement>, ExecutableElement) - Static method in class org.jboss.logging.processor.util.ElementHelper
Checks to see if the method has or inherits a Message annotation.
inheritsMessageId(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the method should inherit the message id from a different method if applicable.
inheritsMessageId(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
init(ProcessingEnvironment) - Method in class org.jboss.logging.processor.apt.LoggingToolsProcessor
 
INSTANCE - Static variable in class org.jboss.logging.processor.util.VersionComparator
 
isAnnotatedWith(Element, Class<? extends Annotation>) - Static method in class org.jboss.logging.processor.util.ElementHelper
Check if an element is annotated with the given annotation.
isAnnotatedWith(Element, String) - Static method in class org.jboss.logging.processor.util.ElementHelper
Check if an element is annotated with the given annotation.
isArray() - Method in interface org.jboss.logging.processor.model.Parameter
Returns true if the type is an array, otherwise false.
isAssignableFrom(Class<?>) - Method in interface org.jboss.logging.processor.model.MessageObjectType
Determines if this type is either the same as, or is a supertype of, the class represented by the type parameter.
isAssignableFrom(Class<?>) - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
isChecked() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks if the throwable is a checked exception.
isDebugEnabled() - Method in class org.jboss.logging.processor.apt.ToolLogger
Returns true if debugging is enabled, otherwise false.
isLoggerMethod(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks to see if the method is a logger method.
isLoggerMethod(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
isLoggerMethod() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns true if this is a logger method, otherwise false.
isMessageBundle(TypeElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks the element to see it's a message bundle.
isMessageBundle(TypeElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
isMessageLogger(TypeElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks the element to see it's a message logger.
isMessageLogger(TypeElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
isOverloaded() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns true if the method is overloaded, otherwise false .
isOverloaded(Collection<ExecutableElement>, ExecutableElement) - Static method in class org.jboss.logging.processor.util.ElementHelper
Checks to see if the method is overloaded.
isPrimitive() - Method in interface org.jboss.logging.processor.model.Parameter
Returns true if the type is a primitive type, otherwise false.
isPrimitive() - Method in interface org.jboss.logging.processor.model.ReturnType
Indicates whether or not the return type is a primitive.
isPrimitive() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
isSameAs(Class<?>) - Method in interface org.jboss.logging.processor.model.MessageObjectType
Determines if this type is the same type as the class represented by the type parameter.
isSameAs(Class<?>) - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
isSubtypeOf(Class<?>) - Method in interface org.jboss.logging.processor.model.MessageObjectType
Determines if this type is a subtype of the class represented by the type parameter.
isSubtypeOf(Class<?>) - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
isSupportedInterfaceAnnotation(TypeElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Checks that the annotation is a supported interface annotation.
isSupportedInterfaceAnnotation(TypeElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
isThrowable() - Method in interface org.jboss.logging.processor.model.ReturnType
Checks to see if the return type is an exception, extends Throwable.
isThrowable() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
isValid() - Method in interface org.jboss.logging.processor.validation.FormatValidator
Returns true of the format is valid, otherwise false.
isValid() - Method in class org.jboss.logging.processor.validation.StringFormatValidator
 
isVarArgs() - Method in interface org.jboss.logging.processor.model.Parameter
Returns true if the parameter is a var args parameter, otherwise false.

J

JavaDocComment - Interface in org.jboss.logging.processor.model
Represents the JavaDoc's documentation.
JBossLoggers - Class in org.jboss.logging.processor
Defines information about the Logger and BasicLogger.
JBossLoggers() - Constructor for class org.jboss.logging.processor.JBossLoggers
 

L

LESS - Static variable in class org.jboss.logging.processor.util.Comparison
 
loggerClass() - Method in class org.jboss.logging.processor.JBossLoggers
 
loggerClass() - Method in interface org.jboss.logging.processor.Loggers
The class of main logger.
loggerInterface() - Method in class org.jboss.logging.processor.JBossLoggers
 
loggerInterface() - Method in interface org.jboss.logging.processor.Loggers
Returns the logger interface to implement.
loggerMethod(Annotations.FormatType) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the logger method name to use or an empty string if the method is not a logger method.
loggerMethod(Annotations.FormatType) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
loggerMethod() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the LogMessage annotation associated with this method only if MessageMethod.isLoggerMethod() returns true.
Loggers - Interface in org.jboss.logging.processor
 
loggers() - Static method in class org.jboss.logging.processor.Tools
Locates the first implementation of Loggers.
LoggingClass - Annotation Type in org.jboss.logging.annotations
Mark a parameter as specifying the name of the logging class to use.
loggingFQCN() - Method in interface org.jboss.logging.processor.model.MessageInterface
The fully qualified class name to use for log methods.
LoggingToolsProcessor - Class in org.jboss.logging.processor.apt
The main annotation processor for JBoss Logging Tooling.
LoggingToolsProcessor() - Constructor for class org.jboss.logging.processor.apt.LoggingToolsProcessor
Default constructor.
logLevel(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the log level enum.
logLevel(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
logLevel() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the log level parameter associated with the method only if MessageMethod.isLoggerMethod() returns true.
logLevelClass() - Method in class org.jboss.logging.processor.JBossLoggers
 
logLevelClass() - Method in interface org.jboss.logging.processor.Loggers
The log level class.
LogMessage - Annotation Type in org.jboss.logging.annotations
A typed logger method.
logType() - Method in enum org.jboss.logging.processor.apt.Annotations.FormatType
 

M

mandatoryWarning(Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a warning message.
mandatoryWarning(Element, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted warning message.
Message - Annotation Type in org.jboss.logging.annotations
Assigns a message string to a resource method.
message() - Method in interface org.jboss.logging.processor.model.MessageMethod
The MessageMethod.Message to be used for the method.
Message.Format - Enum in org.jboss.logging.annotations
The possible format types.
MessageBundle - Annotation Type in org.jboss.logging.annotations
Signify that an interface is a message bundle interface.
messageFormat(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the method format type.
messageFormat(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
messageId(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the message id.
messageId(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
MessageIdValidator - Class in org.jboss.logging.processor.validation
Date: 16.08.2011
messageInterface() - Method in class org.jboss.logging.processor.generator.model.ClassModel
Returns the message interface being used.
MessageInterface - Interface in org.jboss.logging.processor.model
Date: 28.07.2011
MessageInterface.AnnotatedType - Enum in org.jboss.logging.processor.model
 
MessageInterfaceFactory - Class in org.jboss.logging.processor.apt
A factory to create a MessageInterface for annotation processors.
MessageLogger - Annotation Type in org.jboss.logging.annotations
Signify that an interface is a typed logger interface.
MessageMethod - Interface in org.jboss.logging.processor.model
Date: 29.07.2011
MessageMethod.Message - Interface in org.jboss.logging.processor.model
Represents a Message annotation on a method.
messageMethodName() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the name of the method used to retrieve the message.
MessageObject - Interface in org.jboss.logging.processor.model
A generic interface for returning basic information about parts of a message bundle or message logger interface.
MessageObjectType - Interface in org.jboss.logging.processor.model
Date: 23.08.2011
messageValue(ExecutableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the message value for the method.
messageValue(ExecutableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
methods() - Method in interface org.jboss.logging.processor.model.MessageInterface
A collection of all the methods this interface needs to implement.

N

name() - Method in interface org.jboss.logging.processor.model.MessageInterface
The qualified name of the message interface.
name() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the method name.
name() - Method in interface org.jboss.logging.processor.model.MessageObject
Returns a name for the object.
name() - Method in interface org.jboss.logging.processor.model.Parameter
The variable name of the parameter.
name() - Method in interface org.jboss.logging.processor.model.ReturnType
Returns the qualified class name of the return type.
name() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
name() - Method in interface org.jboss.logging.processor.model.ThrowableType
Returns the qualified class name of the return type.
NONE - Static variable in annotation type org.jboss.logging.annotations.Message
Indicates that this message has no ID.
note(Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a note message.
note(Element, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted note message.

O

Objects - Class in org.jboss.logging.processor.util
Date: 30.08.2011
Objects.HashCodeBuilder - Class in org.jboss.logging.processor.util
A builder to simplify the building of hash codes.
Objects.ToStringBuilder - Class in org.jboss.logging.processor.util
A builder to build a default Object#toString() value.
of(ProcessingEnvironment, TypeElement) - Static method in class org.jboss.logging.processor.apt.MessageInterfaceFactory
Creates a message interface from the TypeElement specified by the interfaceElement parameter.
of(Class<?>) - Static method in class org.jboss.logging.processor.util.Objects.ToStringBuilder
Creates a new string builder for the clazz.
of(String) - Static method in class org.jboss.logging.processor.util.Objects.ToStringBuilder
Creates a new string builder for the className.
of(Object) - Static method in class org.jboss.logging.processor.util.Objects.ToStringBuilder
Creates a new string builder for the self.
of(String) - Static method in class org.jboss.logging.processor.validation.StringFormatValidator
Creates a string format.
of(String, Object...) - Static method in class org.jboss.logging.processor.validation.StringFormatValidator
Creates a string format.
org.jboss.logging.annotations - package org.jboss.logging.annotations
 
org.jboss.logging.processor - package org.jboss.logging.processor
 
org.jboss.logging.processor.apt - package org.jboss.logging.processor.apt
 
org.jboss.logging.processor.generator.model - package org.jboss.logging.processor.generator.model
 
org.jboss.logging.processor.model - package org.jboss.logging.processor.model
 
org.jboss.logging.processor.util - package org.jboss.logging.processor.util
 
org.jboss.logging.processor.validation - package org.jboss.logging.processor.validation
 
other(Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a message that does not fit the other types.
other(Element, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted message that does not fit the other types.

P

packageName() - Method in interface org.jboss.logging.processor.model.MessageInterface
The package name of the message interface.
Param - Annotation Type in org.jboss.logging.annotations
Identifies a parameter is to be used for constructing an exception and excluded from the formatting of the message.
paramClass() - Method in interface org.jboss.logging.processor.model.Parameter
Returns the class if the parameter is annotated with Param.
Parameter - Interface in org.jboss.logging.processor.model
 
Parameter.ParameterType - Enum in org.jboss.logging.processor.model
The types of parameters.
parameterCount(Collection<? extends VariableElement>) - Static method in class org.jboss.logging.processor.util.ElementHelper
Returns the number of parameters excluding the Cause parameter and any Param parameters if found.
parameters(Parameter.ParameterType) - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.
parameters(Parameter.ParameterType, Parameter.ParameterType...) - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns an unmodifiable collection of the parameters specified by the parameter type or an empty set.
parameterType() - Method in interface org.jboss.logging.processor.model.Parameter
Returns the parameter type of the parameter.
PATTERN - Static variable in class org.jboss.logging.processor.validation.StringFormatValidator
The Regex pattern.
Pos - Annotation Type in org.jboss.logging.annotations
 
pos() - Method in interface org.jboss.logging.processor.model.Parameter
The position annotation if this the Parameter.parameterType() is Parameter.ParameterType.POS.
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.jboss.logging.processor.apt.LoggingToolsProcessor
 
processingEnv() - Method in class org.jboss.logging.processor.apt.AbstractGenerator
Returns the processing environment.
processTypeElement(TypeElement, TypeElement, MessageInterface) - Method in class org.jboss.logging.processor.apt.AbstractGenerator
Processes a type element.
projectCode(TypeElement) - Method in interface org.jboss.logging.processor.apt.Annotations
The project code from the interface.
projectCode(TypeElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
projectCode() - Method in interface org.jboss.logging.processor.model.MessageInterface
The project code for the message interface or null if MessageInterface.getAnnotatedType() returns MessageInterface.AnnotatedType.NONE.
Property - Annotation Type in org.jboss.logging.annotations
Indicate that a method parameter value should be applied to a property (with a setter method) on the resultant exception object.

Q

qualifiedClassName() - Method in class org.jboss.logging.processor.generator.model.ClassModel
Get the class name.

R

reference() - Method in interface org.jboss.logging.processor.model.MessageObject
The object used to extract information for the message logger or message bundle, if applicable.
reference() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
result() - Method in class org.jboss.logging.processor.util.Comparison
Ends the comparison and returns 0 if all comparisons were equal, -1 if the any of the left comparisons were less than the right comparisons or 1 if any of the right comparisons were less than the left.
returnType() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the return type for the method.
ReturnType - Interface in org.jboss.logging.processor.model
Date: 29.07.2011
ReturnType.VoidReturnType - Class in org.jboss.logging.processor.model
Default type if the return type is void.

S

simpleName() - Method in interface org.jboss.logging.processor.model.MessageInterface
The name of the interface without the package.
stackTraceToString(Throwable) - Static method in class org.jboss.logging.processor.apt.ToolLogger
Converts a stack trace to string output.
staticMethod() - Method in enum org.jboss.logging.processor.apt.Annotations.FormatType
 
StringFormatValidator - Class in org.jboss.logging.processor.validation
A string format representation.
Strings - Class in org.jboss.logging.processor.util
Date: 19.09.2011
summaryMessage() - Method in interface org.jboss.logging.processor.validation.FormatValidator
A summary message if FormatValidator.isValid() returns false, otherwise an empty string.

T

targetName(VariableElement) - Method in interface org.jboss.logging.processor.apt.Annotations
Returns the target field or method name for the annotated parameter.
targetName(VariableElement) - Method in class org.jboss.logging.processor.apt.AnnotationsImpl
 
targetName() - Method in interface org.jboss.logging.processor.model.Parameter
Returns the name of the target field or method.
throwableReturnType() - Method in interface org.jboss.logging.processor.model.ReturnType
Returns the exception return type if ReturnType.isThrowable() returns true.
throwableReturnType() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
ThrowableType - Interface in org.jboss.logging.processor.model
Date: 27.09.2011
thrownTypes() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns a collection of throwable types the method throws.
toHashCode() - Method in class org.jboss.logging.processor.util.Objects.HashCodeBuilder
Returns the calculated hash code.
ToolLogger - Class in org.jboss.logging.processor.apt
A logger for logging messages for annotation processors.
Tools - Class in org.jboss.logging.processor
A helper class that uses services loaders to load implementations for the Annotations and the Loggers interfaces.
toString() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
toString() - Method in class org.jboss.logging.processor.util.Objects.ToStringBuilder
 
toString() - Method in class org.jboss.logging.processor.validation.StringFormatValidator
 
Transform - Annotation Type in org.jboss.logging.annotations
Indicate the given parameter should be transformed in each of the transform types provided.
transform() - Method in interface org.jboss.logging.processor.model.Parameter
Transform.TransformType - Enum in org.jboss.logging.annotations
The transform type
translation(MessageInterface, String, Map<MessageMethod, String>) - Static method in class org.jboss.logging.processor.generator.model.ClassModelFactory
Creates a class model for created translation implementations of the message interface.
TranslationHelper - Class in org.jboss.logging.processor.util
Utility class to work with translation filename.
translationKey() - Method in interface org.jboss.logging.processor.model.MessageMethod
Returns the name of the key used in the translation files for the message translation.
type() - Method in interface org.jboss.logging.processor.model.MessageObjectType
Returns the qualified type name of the object.
type() - Method in interface org.jboss.logging.processor.model.Parameter
The full type name of the parameter.
type() - Method in class org.jboss.logging.processor.model.ReturnType.VoidReturnType
 
type() - Method in interface org.jboss.logging.processor.validation.ValidationMessage
The type of the message.
typeToString(Class<?>) - Static method in class org.jboss.logging.processor.util.ElementHelper
Converts a class type to a string recognizable by the Elements.getTypeElement(CharSequence).
typeToString(String) - Static method in class org.jboss.logging.processor.util.ElementHelper
Converts a qualified type name to a string recognizable by the Elements.getTypeElement(CharSequence).
typeUtils() - Method in class org.jboss.logging.processor.apt.AbstractGenerator
Returns the type utils.

U

useConstructionParameters() - Method in interface org.jboss.logging.processor.model.ThrowableType
Checks to see if the throwable has and can use a custom constructor.

V

validate(MessageInterface) - Method in class org.jboss.logging.processor.validation.IdLengthValidator
 
validate(MessageInterface) - Method in class org.jboss.logging.processor.validation.IdRangeValidator
 
validate(MessageInterface, MessageMethod) - Method in class org.jboss.logging.processor.validation.MessageIdValidator
 
validate(MessageInterface) - Method in class org.jboss.logging.processor.validation.Validator
Validates the message interface and returns a collection of validation messages or an empty collection.
ValidationMessage - Interface in org.jboss.logging.processor.validation
Date: 12.08.2011
ValidationMessage.Type - Enum in org.jboss.logging.processor.validation
Validation message type enum.
ValidationMessageFactory - Class in org.jboss.logging.processor.validation
Date: 12.08.2011
Validator - Class in org.jboss.logging.processor.validation
Date: 12.08.2011
Validator() - Constructor for class org.jboss.logging.processor.validation.Validator
 
ValidIdRange - Annotation Type in org.jboss.logging.annotations
Sets a range of valid id's allowed on the message id.
ValidIdRanges - Annotation Type in org.jboss.logging.annotations
 
validIdRanges() - Method in interface org.jboss.logging.processor.model.MessageInterface
Returns a list of valid id ranges.
value() - Method in interface org.jboss.logging.processor.model.MessageMethod.Message
A format string that can be used with the MessageMethod.Message.format().
valueOf(String) - Static method in enum org.jboss.logging.annotations.Message.Format
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.logging.annotations.Transform.TransformType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.logging.processor.apt.Annotations.FormatType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.logging.processor.model.MessageInterface.AnnotatedType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.logging.processor.model.Parameter.ParameterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jboss.logging.processor.validation.ValidationMessage.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jboss.logging.annotations.Message.Format
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.logging.annotations.Transform.TransformType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.logging.processor.apt.Annotations.FormatType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.logging.processor.model.MessageInterface.AnnotatedType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.logging.processor.model.Parameter.ParameterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jboss.logging.processor.validation.ValidationMessage.Type
Returns an array containing the constants of this enum type, in the order they are declared.
VersionComparator - Class in org.jboss.logging.processor.util
Compares 2 different version strings.
VOID - Static variable in interface org.jboss.logging.processor.model.ReturnType
 

W

warn(Element, String) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a warning message.
warn(Element, String, Object...) - Method in class org.jboss.logging.processor.apt.ToolLogger
Prints a formatted warning message.
withTranslation(String, String) - Static method in class org.jboss.logging.processor.validation.StringFormatValidator
Creates a string format.
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links
JBoss Logging Tools Parent 1.2.1.Final

Copyright © 2023 JBoss by Red Hat. All rights reserved.