Package org.jboss.logging.processor.apt

Class MessageInterfaceFactory.LoggerInterface

java.lang.Object

org.jboss.logging.processor.apt.AbstractClassType

org.jboss.logging.processor.apt.MessageInterfaceFactory.LoggerInterface

All Implemented Interfaces:

Comparable<MessageInterface>, AnnotatedConstruct, Element, Parameterizable, QualifiedNameable, TypeElement, ClassType, DelegatingElement, DelegatingTypeElement, JavaDocComment, MessageInterface

Enclosing class:

MessageInterfaceFactory

private static class MessageInterfaceFactory.LoggerInterface
extends AbstractClassType
implements MessageInterface

Field Summary

Fields

Modifier and Type	Field	Description
private final TypeElement	loggerInterface
private final Set<MessageMethod>	messageMethods

Fields inherited from class org.jboss.logging.processor.apt.AbstractClassType

elements, processingEnv, typeMirror, types

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LoggerInterface(ProcessingEnvironment processingEnv, TypeElement loggerInterface)

Method Summary

Modifier and Type	Method	Description
int	compareTo(MessageInterface o)
boolean	equals(Object obj)
Set<MessageInterface>	extendedInterfaces()	A set of qualified interface names this interface extends or an empty set.
boolean	extendsLoggerInterface()	Checks the interface to see if the logger interface is being extended in this interface.
String	getComment()	The JavaDoc comments if available or null if there are no JavaDoc's present.
TypeElement	getDelegate()	The element to delegate the default methods to.
int	getIdLength()	The length to pad the id with.
int	hashCode()
private void	init()
String	loggingFQCN()	The fully qualified class name to use for log methods.
Collection<MessageMethod>	methods()	A collection of all the methods this interface needs to implement.
String	name()	The qualified name of the message interface.
(package private) static MessageInterfaceFactory.LoggerInterface	of(ProcessingEnvironment processingEnv)
String	packageName()	The package name of the message interface.
String	projectCode()	The project code for the message interface or null if not annotated with @MessageBundle or @MessageLogger.
String	simpleName()	The name of the interface without the package.
String	toString()
List<ValidIdRange>	validIdRanges()	Returns a list of valid id ranges.

Methods inherited from class org.jboss.logging.processor.apt.AbstractClassType

isAssignableFrom, isSameAs, isSubtypeOf

Methods inherited from class java.lang.Object

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

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

isAssignableFrom, isSameAs, isSubtypeOf

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

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

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

asType, getEnclosedElements, getEnclosingElement, getInterfaces, getNestingKind, getQualifiedName, getSimpleName, getSuperclass, getTypeParameters

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

expressionProperties, generatedAnnotation

Field Details

loggerInterface

private final TypeElement loggerInterface

messageMethods

private final Set<MessageMethod> messageMethods

Constructor Details

LoggerInterface

private LoggerInterface(ProcessingEnvironment processingEnv,
 TypeElement loggerInterface)

Method Details

init

private void init()

of

static MessageInterfaceFactory.LoggerInterface of(ProcessingEnvironment processingEnv)

extendsLoggerInterface

public boolean extendsLoggerInterface()

Description copied from interface: MessageInterface

Checks the interface to see if the logger interface is being extended in this interface.

Specified by:

extendsLoggerInterface in interface MessageInterface

Returns:

true if this interface extends the logger interface, otherwise false.

extendedInterfaces

public Set<MessageInterface> extendedInterfaces()

Description copied from interface: MessageInterface

A set of qualified interface names this interface extends or an empty set.

Specified by:

extendedInterfaces in interface MessageInterface

Returns:

a set of interface names or an empty set.

methods

public Collection<MessageMethod> methods()

Description copied from interface: MessageInterface

A collection of all the methods this interface needs to implement.

Specified by:

methods in interface MessageInterface

Returns:

a collection of methods.

projectCode

public String projectCode()

Description copied from interface: MessageInterface

The project code for the message interface or null if not annotated with @MessageBundle or @MessageLogger.

Specified by:

projectCode in interface MessageInterface

Returns:

the project code or null if not annotated with @MessageBundle or @MessageLogger

name

public String name()

Description copied from interface: MessageInterface

The qualified name of the message interface.

Specified by:

name in interface MessageInterface

Returns:

the qualified name.

packageName

public String packageName()

Description copied from interface: MessageInterface

The package name of the message interface.

Specified by:

packageName in interface MessageInterface

Returns:

the package name.

simpleName

public String simpleName()

Description copied from interface: MessageInterface

The name of the interface without the package.

Specified by:

simpleName in interface MessageInterface

Returns:

the simple interface name.

loggingFQCN

public String loggingFQCN()

Description copied from interface: MessageInterface

The fully qualified class name to use for log methods. This will generally be the same result as MessageInterface.name().

Specified by:

loggingFQCN in interface MessageInterface

Returns:

the fully qualified class name to use for logging.

validIdRanges

public List<ValidIdRange> validIdRanges()

Description copied from interface: MessageInterface

Returns a list of valid id ranges.

Specified by:

validIdRanges in interface MessageInterface

Returns:

a list of valid id ranges or an empty list

getIdLength

public int getIdLength()

Description copied from interface: MessageInterface

The length to pad the id with. A value of less than 0 indicates no padding.

Specified by:

getIdLength in interface MessageInterface

Returns:

the length to pad the id with

hashCode

public int hashCode()

Specified by:

hashCode in interface Element

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Element

Overrides:

equals in class Object

compareTo

public int compareTo(MessageInterface o)

Specified by:

compareTo in interface Comparable<MessageInterface>

toString

public String toString()

Overrides:

toString in class Object

getComment

public 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.

getDelegate

public TypeElement getDelegate()

Description copied from interface: DelegatingElement

The element to delegate the default methods to.

Specified by:

getDelegate in interface DelegatingElement

Specified by:

getDelegate in interface DelegatingTypeElement

Returns:

the delegate