1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
/* * @(#)Elements.java 1.11 06/08/16 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.lang.model.util; import java.util.List; import java.util.Map; import javax.lang.model.element.*; import javax.lang.model.type.*; /** * Utility methods for operating on program elements. * * <p><b>Compatibility Note:</b> Methods may be added to this interface * in future releases of the platform. * * @author Joseph D. Darcy * @author Scott Seligman * @author Peter von der Ahé * @version 1.11 06/08/16 * @see javax.annotation.processing.ProcessingEnvironment#getElementUtils * @since 1.6 */ public interface Elements { /** * Returns a package given its fully qualified name. * * @param name fully qualified package name, or "" for an unnamed package * @return the named package, or {@code null} if it cannot be found */ PackageElement getPackageElement(CharSequence name); /** * Returns a type element given its canonical name. * * @param name the canonical name * @return the named type element, or {@code null} if it cannot be found */ TypeElement getTypeElement(CharSequence name); /** * Returns the values of an annotation's elements, including defaults. * * @see AnnotationMirror#getElementValues() * @param a annotation to examine * @return the values of the annotation's elements, including defaults */ Map<? extends ExecutableElement, ? extends AnnotationValue> getElementValuesWithDefaults(AnnotationMirror a); /** * Returns the text of the documentation ("Javadoc") * comment of an element. * * @param e the element being examined * @return the documentation comment of the element, or {@code null} * if there is none */ String getDocComment(Element e); /** * Returns {@code true} if the element is deprecated, {@code false} otherwise. * * @param e the element being examined * @return {@code true} if the element is deprecated, {@code false} otherwise */ boolean isDeprecated(Element e); /** * Returns the <i>binary name</i> of a type element. * * @param type the type element being examined * @return the binary name * * @see TypeElement#getQualifiedName * @jls3 13.1 The Form of a Binary */ Name getBinaryName(TypeElement type); /** * Returns the package of an element. The package of a package is * itself. * * @param type the element being examined * @return the package of an element */ PackageElement getPackageOf(Element type); /** * Returns all members of a type element, whether inherited or * declared directly. For a class the result also includes its * constructors, but not local or anonymous classes. * * <p>Note that elements of certain kinds can be isolated using * methods in {@link ElementFilter}. * * @param type the type being examined * @return all members of the type * @see Element#getEnclosedElements */ List<? extends Element> getAllMembers(TypeElement type); /** * Returns all annotations of an element, whether * inherited or directly present. * * @param e the element being examined * @return all annotations of the element * @see Element#getAnnotationMirrors */ List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e); /** * Tests whether one type, method, or field hides another. * * @param hider the first element * @param hidden the second element * @return {@code true} if and only if the first element hides * the second */ boolean hides(Element hider, Element hidden); /** * Tests whether one method, as a member of a given type, * overrides another method. * When a non-abstract method overrides an abstract one, the * former is also said to <i>implement</i> the latter. * * <p> In the simplest and most typical usage, the value of the * {@code type} parameter will simply be the class or interface * directly enclosing {@code overrider} (the possibly-overriding * method). For example, suppose {@code m1} represents the method * {@code String.hashCode} and {@code m2} represents {@code * Object.hashCode}. We can then ask whether {@code m1} overrides * {@code m2} within the class {@code String} (it does): * * <blockquote> * {@code assert elements.overrides(m1, m2, * elements.getTypeElement("java.lang.String")); } * </blockquote> * * A more interesting case can be illustrated by the following example * in which a method in type {@code A} does not override a * like-named method in type {@code B}: * * <blockquote> * {@code class A { public void m() {} } }<br> * {@code interface B { void m(); } }<br> * ...<br> * {@code m1 = ...; // A.m }<br> * {@code m2 = ...; // B.m }<br> * {@code assert ! elements.overrides(m1, m2, * elements.getTypeElement("A")); } * </blockquote> * * When viewed as a member of a third type {@code C}, however, * the method in {@code A} does override the one in {@code B}: * * <blockquote> * {@code class C extends A implements B {} }<br> * ...<br> * {@code assert elements.overrides(m1, m2, * elements.getTypeElement("C")); } * </blockquote> * * @param overrider the first method, possible overrider * @param overridden the second method, possibly being overridden * @param type the type of which the first method is a member * @return {@code true} if and only if the first method overrides * the second * @jls3 8.4.8 Inheritance, Overriding, and Hiding * @jls3 9.4.1 Inheritance and Overriding */ boolean overrides(ExecutableElement overrider, ExecutableElement overridden, TypeElement type); /** * Returns the text of a <i>constant expression</i> representing a * primitive value or a string. * The text returned is in a form suitable for representing the value * in source code. * * @param value a primitive value or string * @return the text of a constant expression * @throws IllegalArgumentException if the argument is not a primitive * value or string * * @see VariableElement#getConstantValue() */ String getConstantExpression(Object value); /** * Prints a representation of the elements to the given writer in * the specified order. The main purpose of this method is for * diagnostics. The exact format of the output is <em>not</em> * specified and is subject to change. * * @param w the writer to print the output to * @param elements the elements to print */ void printElements(java.io.Writer w, Element... elements); /** * Return a name with the same sequence of characters as the * argument. * * @param cs the character sequence to return as a name */ Name getName(CharSequence cs); }