Package org.jboss.logging.processor.apt

Class MessageInterfaceFactory.AptMessageInterface

java.lang.Object

org.jboss.logging.processor.apt.AbstractClassType

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

All Implemented Interfaces:

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

Enclosing class:

MessageInterfaceFactory

private static class MessageInterfaceFactory.AptMessageInterface
extends AbstractClassType
implements MessageInterface

Message interface implementation.

Field Summary

Fields

Modifier and Type	Field	Description
private final Properties	expressionProperties
private final Set<MessageInterface>	extendedInterfaces
private String	fqcn
private final TypeElement	generatedAnnotation
private int	idLen
private final TypeElement	interfaceElement
private final List<MessageMethod>	messageMethods
private String	packageName
private String	projectCode
private String	qualifiedName
private String	simpleName
private final List<ValidIdRange>	validIdRanges

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

elements, processingEnv, typeMirror, types

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AptMessageInterface(TypeElement interfaceElement, ProcessingEnvironment processingEnv, Properties expressionProperties, boolean addGeneratedAnnotation)

Method Summary

Modifier and Type	Method	Description
int	compareTo(MessageInterface o)
boolean	equals(Object obj)
Properties	expressionProperties()	The properties used to resolve expressions.
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.
TypeElement	generatedAnnotation()	Returns the type to use for the @Generated annotation.
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.
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

Field Details

interfaceElement

private final TypeElement interfaceElement

extendedInterfaces

private final Set<MessageInterface> extendedInterfaces

messageMethods

private final List<MessageMethod> messageMethods

validIdRanges

private final List<ValidIdRange> validIdRanges

expressionProperties

private final Properties expressionProperties

generatedAnnotation

private final TypeElement generatedAnnotation

projectCode

private String projectCode

packageName

private String packageName

simpleName

private String simpleName

qualifiedName

private String qualifiedName

fqcn

private String fqcn

idLen

private int idLen

Constructor Details

AptMessageInterface

private AptMessageInterface(TypeElement interfaceElement,
 ProcessingEnvironment processingEnv,
 Properties expressionProperties,
 boolean addGeneratedAnnotation)

Method Details

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 String name()

Description copied from interface: MessageInterface

The qualified name of the message interface.

Specified by:

name in interface MessageInterface

Returns:

the qualified name.

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.

hashCode

public int hashCode()

Specified by:

hashCode in interface Element

Overrides:

hashCode in class Object

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.

compareTo

public int compareTo(MessageInterface o)

Specified by:

compareTo in interface Comparable<MessageInterface>

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

init

private void init()

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.

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.

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

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

generatedAnnotation

public TypeElement generatedAnnotation()

Description copied from interface: MessageInterface

Returns the type to use for the @Generated annotation. This may return null of the implementation should not be annotated.

Specified by:

generatedAnnotation in interface MessageInterface

Returns:

the type for the generated annotation or null if no annotation is wanted

expressionProperties

public Properties expressionProperties()

Description copied from interface: MessageInterface

The properties used to resolve expressions.

Specified by:

expressionProperties in interface MessageInterface

Returns:

the properties used to resolve expressions

equals

public boolean equals(Object obj)

Specified by:

equals in interface Element

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object