Class AbstractBaseJavaEntity

    • Field Detail

      • comment

        private java.lang.String comment
      • tags

        private java.util.List<DocletTag> tags
    • Constructor Detail

      • AbstractBaseJavaEntity

        public AbstractBaseJavaEntity()
    • Method Detail

      • setSource

        public void setSource​(JavaSource source)
      • getAnnotations

        public java.util.List<JavaAnnotation> getAnnotations()
      • setAnnotations

        public void setAnnotations​(java.util.List<JavaAnnotation> annotations)
      • getDeclaringClass

        public JavaClass getDeclaringClass()
        Not every entity has a parentClass, but AnnotationFieldRef requires access to it. When used with JavaClass, don't confuse this with getSuperClass()
        Returns:
        the surrounding class
      • getComment

        public java.lang.String getComment()
      • setComment

        public void setComment​(java.lang.String comment)
      • getTags

        public java.util.List<DocletTag> getTags()
      • getTagsByName

        public java.util.List<DocletTag> getTagsByName​(java.lang.String name)
      • getTagByName

        public DocletTag getTagByName​(java.lang.String name)
      • getNamedParameter

        public 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 name of the docletTag
        parameterName - the name of the parameter
        Returns:
        the value of the named parameter
        Since:
        1.3
      • setTags

        public void setTags​(java.util.List<DocletTag> tagList)