Interface AnnotatedDescriptor
-
- All Known Subinterfaces:
GenericDescriptor
- All Known Implementing Classes:
AnnotatedDescriptorImpl,Descriptor,EnumDescriptor,FieldDescriptor
public interface AnnotatedDescriptorBase class for all descriptors. Provides common methods for naming, accessing the attached documentation and annotations.- Since:
- 2.0
- Author:
- anistor@redhat.com
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,AnnotationElement.Annotation>getAnnotations()Get the documentation annotations in the form of a map of abstract syntax trees ofAnnotationElementnodes.StringgetDocumentation()Return the documentation text associated with this descriptor.FileDescriptorgetFileDescriptor()Return the containing files's descriptorStringgetFullName()Return the full name of the descriptor.StringgetName()Return the name of the descriptor.<T> TgetProcessedAnnotation(String annotationName)Get the 'processed' annotation object created by the registeredAnnotationMetadataCreatorornullif the annotation is missing or noAnnotationMetadataCreatorwas registered.
-
-
-
Method Detail
-
getName
String getName()
Return the name of the descriptor.- Returns:
- the name of the descriptor (never
null)
-
getFullName
String getFullName()
Return the full name of the descriptor.- Returns:
- the name of the descriptor (never
null)
-
getFileDescriptor
FileDescriptor getFileDescriptor()
Return the containing files's descriptor- Returns:
- the containing files's descriptor (never
null)
-
getDocumentation
String getDocumentation()
Return the documentation text associated with this descriptor.- Returns:
- the documentation text or
nullif not present
-
getAnnotations
Map<String,AnnotationElement.Annotation> getAnnotations() throws AnnotationParserException
Get the documentation annotations in the form of a map of abstract syntax trees ofAnnotationElementnodes. Only the configured annotations are returned. The unconfigured ones are discarded immediately after parsing.The parsing of annotations is performed lazily on first invocation.
- Returns:
- the map of annotations
- Throws:
AnnotationParserException- if parsing of annotations fails
-
getProcessedAnnotation
<T> T getProcessedAnnotation(String annotationName) throws AnnotationParserException
Get the 'processed' annotation object created by the registeredAnnotationMetadataCreatorornullif the annotation is missing or noAnnotationMetadataCreatorwas registered.- Type Parameters:
T- the expected type of the object created by theAnnotationMetadataCreator- Parameters:
annotationName- the name of the annotation- Returns:
- the 'processed' annotation object or
nullif not found - Throws:
AnnotationParserException- if parsing of annotations fails
-
-