public interface MessageInterface extends Comparable<MessageInterface>, MessageObject, MessageObjectType, JavaDocComment
Modifier and Type | Interface and Description |
---|---|
static class |
MessageInterface.AnnotatedType |
Modifier and Type | Method and Description |
---|---|
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.
|
<A extends Annotation> |
getAnnotation(Class<A> annotation)
Returns the annotation present on this interface.
|
int |
getIdLength()
The length to pad the id with.
|
boolean |
isAnnotatedWith(Class<? extends Annotation> annotation)
Indicates whether or not an annotation is present on the message interface.
|
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 getAnnotatedType() returns MessageInterface.AnnotatedType.NONE . |
String |
simpleName()
The name of the interface without the package.
|
List<org.jboss.logging.annotations.ValidIdRange> |
validIdRanges()
Returns a list of
valid id ranges . |
compareTo
isAssignableFrom, isSameAs, isSubtypeOf, type
reference
getComment
boolean extendsLoggerInterface()
logger interface
is being extended in
this interface.true
if this interface extends the logger interface, otherwise false
.Set<MessageInterface> extendedInterfaces()
Collection<MessageMethod> methods()
String projectCode()
null
if getAnnotatedType()
returns MessageInterface.AnnotatedType.NONE
.null
if getAnnotatedType()
returns MessageInterface.AnnotatedType.NONE
String name()
name
in interface MessageObject
String packageName()
String simpleName()
String loggingFQCN()
name()
.MessageInterface.AnnotatedType getAnnotatedType()
List<org.jboss.logging.annotations.ValidIdRange> validIdRanges()
valid id ranges
.int getIdLength()
boolean isAnnotatedWith(Class<? extends Annotation> annotation)
annotation
- the annotation to check fortrue
if the annotation is present, otherwise false
<A extends Annotation> A getAnnotation(Class<A> annotation)
null
is returned.A
- the annotation typeannotation
- the annotation to check fornull
if the annotation was not present on the interfaceCopyright © 2016. All rights reserved.