JBoss Logging I18n Annotation Processor 1.0.3.Final-redhat-2

org.jboss.logging.processor.intf.model
Interface MessageInterface

All Superinterfaces:
Comparable<MessageInterface>, JavaDocComment, MessageObject, MessageObjectType

public interface MessageInterface
extends Comparable<MessageInterface>, MessageObject, MessageObjectType, JavaDocComment

Date: 28.07.2011

Author:
James R. Perkins

Method Summary
 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.
 boolean isLoggerInterface()
          This is a special type of MessageInterface and will only return true if this is a logger interface.
 boolean isMessageBundle()
          Returns true if the interface is annotated as a message bundle, otherwise false.
 boolean isMessageLogger()
          Returns true if the interface is annotated as a message logger, otherwise false.
 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 isLoggerInterface() returns true.
 String simpleName()
          The name of the interface without the package.
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface org.jboss.logging.processor.intf.model.MessageObjectType
isAssignableFrom, isSameAs, isSubtypeOf, type
 
Methods inherited from interface org.jboss.logging.processor.intf.model.MessageObject
reference
 
Methods inherited from interface org.jboss.logging.processor.intf.model.JavaDocComment
getComment
 

Method Detail

extendsLoggerInterface

boolean extendsLoggerInterface()
Checks the interface to see if the logger interface is being extended in this interface.

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

extendedInterfaces

Set<MessageInterface> extendedInterfaces()
A set of qualified interface names this interface extends or an empty set.

Returns:
a set of interface names or an empty set.

methods

Collection<MessageMethod> methods()
A collection of all the methods this interface needs to implement.

Returns:
a collection of methods.

projectCode

String projectCode()
The project code for the message interface or null if isLoggerInterface() returns true.

Returns:
the project code or null if isLoggerInterface() returns true.

name

String name()
The qualified name of the message interface.

Specified by:
name in interface MessageObject
Returns:
the qualified name.

packageName

String packageName()
The package name of the message interface.

Returns:
the package name.

simpleName

String simpleName()
The name of the interface without the package.

Returns:
the simple interface name.

loggingFQCN

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

Returns:
the fully qualified class name to use for logging.

isMessageLogger

boolean isMessageLogger()
Returns true if the interface is annotated as a message logger, otherwise false.

Returns:
true if a message logger, otherwise false.

isMessageBundle

boolean isMessageBundle()
Returns true if the interface is annotated as a message bundle, otherwise false.

Returns:
true if a message bundle, otherwise false.

isLoggerInterface

boolean isLoggerInterface()
This is a special type of MessageInterface and will only return true if this is a logger interface. Otherwise false is returned.

Note: isMessageBundle() and isMessageLogger() will return false if this is true.

Returns:
true if this is a logger interface, otherwise false.

JBoss Logging I18n Annotation Processor 1.0.3.Final-redhat-2

Copyright © 2012 JBoss by Red Hat. All Rights Reserved.