Package com.thoughtworks.qdox.model
Interface JavaAnnotatedElement
- All Superinterfaces:
JavaModel
,Serializable
- All Known Subinterfaces:
JavaClass
,JavaConstructor
,JavaExecutable
,JavaField
,JavaMethod
,JavaPackage
,JavaParameter
- All Known Implementing Classes:
DefaultJavaClass
,DefaultJavaConstructor
,DefaultJavaExecutable
,DefaultJavaField
,DefaultJavaMethod
,DefaultJavaPackage
,DefaultJavaParameter
,DefaultJavaParameterizedType
,DefaultJavaType
,DefaultJavaTypeVariable
,DefaultJavaWildcardType
,JavaMethodDelegate
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.
- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptionEquivalent ofAnnotatedElement.getAnnotations()
Retrieve the javadoc comment of this annotated element.getNamedParameter
(String tagName, String parameterName) Convenience method forgetTagByName(String).getNamedParameter(String)
that also checks for null tag.getTagByName
(String name) Retrieve the doclettag by the specified name.getTags()
Retrieve all defined doclet tags.getTagsByName
(String name) Retrieve all doclettags with a specific name.Methods inherited from interface com.thoughtworks.qdox.model.JavaModel
getCodeBlock, getLineNumber
-
Method Details
-
getAnnotations
List<JavaAnnotation> getAnnotations()Equivalent ofAnnotatedElement.getAnnotations()
- Returns:
- a list of Annotations, never
null
-
getComment
String getComment()Retrieve the javadoc comment of this annotated element. This is the part between /** and the */, but without the doclet tags- Returns:
- the comment, otherwise
null
-
getTags
Retrieve all defined doclet tags.- Returns:
- a list of DocletTags, never
null
-
getTagsByName
Retrieve all doclettags with a specific name.- Parameters:
name
- the name of the doclet tag- Returns:
- a list of doclettags, never
null
-
getTagByName
Retrieve the doclettag by the specified name. If there are more than one tags, only return the first one.- Parameters:
name
- the name of the doclettag trying to retrieve- Returns:
- the first doclettag matching the name, otherwise
null
-
getNamedParameter
Convenience method forgetTagByName(String).getNamedParameter(String)
that also checks for null tag.- Parameters:
tagName
- the tag nameparameterName
- the parameter name- Returns:
- the value of the matching parameter, otherwise
null
- Since:
- 1.3
-