src/share/classes/javax/lang/model/util/Elements.java

Print this page




  60      *
  61      * @param name  the canonical name
  62      * @return the named type element, or {@code null} if it cannot be found
  63      */
  64     TypeElement getTypeElement(CharSequence name);
  65 
  66     /**
  67      * Returns the values of an annotation's elements, including defaults.
  68      *
  69      * @see AnnotationMirror#getElementValues()
  70      * @param a  annotation to examine
  71      * @return the values of the annotation's elements, including defaults
  72      */
  73     Map<? extends ExecutableElement, ? extends AnnotationValue>
  74             getElementValuesWithDefaults(AnnotationMirror a);
  75 
  76     /**
  77      * Returns the text of the documentation (&quot;Javadoc&quot;)
  78      * comment of an element.
  79      *















  80      * @param e  the element being examined
  81      * @return the documentation comment of the element, or {@code null}
  82      *          if there is none

  83      */
  84     String getDocComment(Element e);
  85 
  86     /**
  87      * Returns {@code true} if the element is deprecated, {@code false} otherwise.
  88      *
  89      * @param e  the element being examined
  90      * @return {@code true} if the element is deprecated, {@code false} otherwise
  91      */
  92     boolean isDeprecated(Element e);
  93 
  94     /**
  95      * Returns the <i>binary name</i> of a type element.
  96      *
  97      * @param type  the type element being examined
  98      * @return the binary name
  99      *
 100      * @see TypeElement#getQualifiedName
 101      * @jls3 13.1 The Form of a Binary
 102      */




  60      *
  61      * @param name  the canonical name
  62      * @return the named type element, or {@code null} if it cannot be found
  63      */
  64     TypeElement getTypeElement(CharSequence name);
  65 
  66     /**
  67      * Returns the values of an annotation's elements, including defaults.
  68      *
  69      * @see AnnotationMirror#getElementValues()
  70      * @param a  annotation to examine
  71      * @return the values of the annotation's elements, including defaults
  72      */
  73     Map<? extends ExecutableElement, ? extends AnnotationValue>
  74             getElementValuesWithDefaults(AnnotationMirror a);
  75 
  76     /**
  77      * Returns the text of the documentation (&quot;Javadoc&quot;)
  78      * comment of an element.
  79      *
  80      * <p> A documentation comment of an element is a comment that
  81      * begins with "{@code /**}" , ends with a separate
  82      * "<code>*&#47</code>", and immediately precedes the element,
  83      * ignoring white space.  Therefore, a documentation comment
  84      * contains at least three"{@code *}" characters.  The text
  85      * returned for the documentation comment is a processed form of
  86      * the comment as it appears in source code.  The leading "{@code
  87      * /**}" and trailing "<code>*&#47</code>" are removed.  For lines
  88      * of the comment starting after the initial "{@code /**}",
  89      * leading white space characters are discarded as are any
  90      * consecutive "{@code *}" characters appearing after the white
  91      * space or starting the line.  The processed lines are then
  92      * concatenated together (including line terminators) and
  93      * returned.
  94      *
  95      * @param e  the element being examined
  96      * @return the documentation comment of the element, or {@code null}
  97      *          if there is none
  98      * @jls3 3.6 White Space
  99      */
 100     String getDocComment(Element e);
 101 
 102     /**
 103      * Returns {@code true} if the element is deprecated, {@code false} otherwise.
 104      *
 105      * @param e  the element being examined
 106      * @return {@code true} if the element is deprecated, {@code false} otherwise
 107      */
 108     boolean isDeprecated(Element e);
 109 
 110     /**
 111      * Returns the <i>binary name</i> of a type element.
 112      *
 113      * @param type  the type element being examined
 114      * @return the binary name
 115      *
 116      * @see TypeElement#getQualifiedName
 117      * @jls3 13.1 The Form of a Binary
 118      */