org.jboss.logging.processor.apt

Class MessageInterfaceFactory.AptMessageInterface

java.lang.Object

org.jboss.logging.processor.apt.AbstractMessageObjectType

org.jboss.logging.processor.apt.MessageInterfaceFactory.AptMessageInterface

All Implemented Interfaces:

java.lang.Comparable<MessageInterface>, JavaDocComment, MessageInterface, MessageObject, MessageObjectType

Enclosing class:

MessageInterfaceFactory

private static class MessageInterfaceFactory.AptMessageInterface
extends AbstractMessageObjectType
implements MessageInterface

Message interface implementation.

Nested Class Summary

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

MessageInterface.AnnotatedType

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<MessageInterface>	extendedInterfaces
private java.lang.String	fqcn
private int	idLen
private javax.lang.model.element.TypeElement	interfaceElement
private java.util.List<MessageMethod>	messageMethods
private java.lang.String	packageName
private java.lang.String	projectCode
private java.lang.String	qualifiedName
private java.lang.String	simpleName
private java.util.List<ValidIdRange>	validIdRanges

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

elements, typeMirror, types

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AptMessageInterface(javax.lang.model.element.TypeElement interfaceElement, javax.lang.model.util.Types types, javax.lang.model.util.Elements elements)

Method Summary

Modifier and Type	Method and Description
int	compareTo(MessageInterface o)
boolean	equals(java.lang.Object obj)
java.util.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.
MessageInterface.AnnotatedType	getAnnotatedType() Returns the annotation type on the interface.
java.lang.String	getComment() The JavaDoc comments if available or null if there are no JavaDoc's present.
int	getIdLength() The length to pad the id with.
int	hashCode()
private void	init()
java.lang.String	loggingFQCN() The fully qualified class name to use for log methods.
java.util.Collection<MessageMethod>	methods() A collection of all the methods this interface needs to implement.
java.lang.String	name() The qualified name of the message interface.
java.lang.String	packageName() The package name of the message interface.
java.lang.String	projectCode() The project code for the message interface or null if MessageInterface.getAnnotatedType() returns MessageInterface.AnnotatedType.NONE.
javax.lang.model.element.TypeElement	reference() The object used to extract information for the message logger or message bundle, if applicable.
java.lang.String	simpleName() The name of the interface without the package.
java.lang.String	toString()
java.lang.String	type() Returns the qualified type name of the object.
java.util.List<ValidIdRange>	validIdRanges() Returns a list of valid id ranges.

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

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

isAssignableFrom, isSameAs, isSubtypeOf

Field Detail

interfaceElement

private final javax.lang.model.element.TypeElement interfaceElement

extendedInterfaces

private final java.util.Set<MessageInterface> extendedInterfaces

messageMethods

private final java.util.List<MessageMethod> messageMethods

validIdRanges

private final java.util.List<ValidIdRange> validIdRanges

projectCode

private java.lang.String projectCode

packageName

private java.lang.String packageName

simpleName

private java.lang.String simpleName

qualifiedName

private java.lang.String qualifiedName

fqcn

private java.lang.String fqcn

idLen

private int idLen

Constructor Detail

AptMessageInterface

private AptMessageInterface(javax.lang.model.element.TypeElement interfaceElement,
                            javax.lang.model.util.Types types,
                            javax.lang.model.util.Elements elements)

Method Detail

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.

name

public java.lang.String name()

Description copied from interface: MessageInterface

The qualified name of the message interface.

Specified by:

name in interface MessageInterface

Specified by:

name in interface MessageObject

Returns:

the qualified name.

extendedInterfaces

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

methods

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

compareTo

public int compareTo(MessageInterface o)

Specified by:

compareTo in interface java.lang.Comparable<MessageInterface>

projectCode

public java.lang.String projectCode()

Description copied from interface: MessageInterface

The project code for the message interface or null if MessageInterface.getAnnotatedType() returns MessageInterface.AnnotatedType.NONE.

Specified by:

projectCode in interface MessageInterface

Returns:

the project code or null if MessageInterface.getAnnotatedType() returns MessageInterface.AnnotatedType.NONE

init

private void init()

type

public java.lang.String type()

Description copied from interface: MessageObjectType

Returns the qualified type name of the object.

Equivalent to Object.class.getName()

Specified by:

type in interface MessageObjectType

Overrides:

type in class AbstractMessageObjectType

Returns:

the qualified class name.

packageName

public java.lang.String packageName()

Description copied from interface: MessageInterface

The package name of the message interface.

Specified by:

packageName in interface MessageInterface

Returns:

the package name.

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.

simpleName

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

getAnnotatedType

public MessageInterface.AnnotatedType getAnnotatedType()

Description copied from interface: MessageInterface

Returns the annotation type on the interface.

Specified by:

getAnnotatedType in interface MessageInterface

Returns:

the annotated type

validIdRanges

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

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.TypeElement 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 MessageObject

Returns:

the reference object used to extract information.