Interface JavaAnnotatedElement

    • Method Detail

      • getAnnotations

        java.util.List<JavaAnnotation> getAnnotations()
        Equivalent of AnnotatedElement.getAnnotations()
        Returns:
        a list of Annotations, never null
      • getComment

        java.lang.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

        java.util.List<DocletTag> getTags()
        Retrieve all defined doclet tags.
        Returns:
        a list of DocletTags, never null
      • getTagsByName

        java.util.List<DocletTag> getTagsByName​(java.lang.String name)
        Retrieve all doclettags with a specific name.
        Parameters:
        name - the name of the doclet tag
        Returns:
        a list of doclettags, never null
      • getTagByName

        DocletTag getTagByName​(java.lang.String name)
        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

        java.lang.String getNamedParameter​(java.lang.String tagName,
                                           java.lang.String parameterName)
        Convenience method for getTagByName(String).getNamedParameter(String) that also checks for null tag.
        Parameters:
        tagName - the tag name
        parameterName - the parameter name
        Returns:
        the value of the matching parameter, otherwise null
        Since:
        1.3