public interface JavaAnnotatedElement extends JavaModel
Equivalent of AnnotatedElement
, providing the most important methods.
Where the original AnnotatedElement uses an Array, the JavaAnnotatedElement is using a List
.
Where you can use Annotations, you can also use JavaDoc. For that reason all JavaDoc methods have been added to this interface.
Modifier and Type | Method and Description |
---|---|
List<JavaAnnotation> |
getAnnotations()
Equivalent of
AnnotatedElement.getAnnotations() |
String |
getComment()
Retrieve the javadoc comment of this annotated element.
|
String |
getNamedParameter(String tagName,
String parameterName)
Convenience method for
getTagByName(String).getNamedParameter(String)
that also checks for null tag. |
DocletTag |
getTagByName(String name)
Retrieve the doclettag by the specified name.
|
List<DocletTag> |
getTags()
Retrieve all defined doclet tags.
|
List<DocletTag> |
getTagsByName(String name)
Retrieve all doclettags with a specific name.
|
getCodeBlock, getLineNumber
List<JavaAnnotation> getAnnotations()
AnnotatedElement.getAnnotations()
null
String getComment()
null
List<DocletTag> getTags()
null
List<DocletTag> getTagsByName(String name)
name
- the name of the doclet tagnull
DocletTag getTagByName(String name)
name
- the name of the doclettag trying to retrievenull
String getNamedParameter(String tagName, String parameterName)
getTagByName(String).getNamedParameter(String)
that also checks for null tag.tagName
- the tag nameparameterName
- the parameter namenull
Copyright © 2002–2023. All rights reserved.