summaryrefslogtreecommitdiff
path: root/javax/lang/model/element/Element.java
diff options
context:
space:
mode:
authorAndrew John Hughes <gnu_andrew@member.fsf.org>2012-11-13 01:34:17 +0000
committerAndrew John Hughes <gnu_andrew@member.fsf.org>2012-11-13 01:34:17 +0000
commitc225934da3e25feb0ece274f8c4978c95938301a (patch)
treee8353f15b21db6ade2b2a8549c8c59c8ac217c70 /javax/lang/model/element/Element.java
parentc814d82e5a435f93150cd28b7cf0f9d600ff400d (diff)
downloadclasspath-c225934da3e25feb0ece274f8c4978c95938301a.tar.gz
Start implementing classes/fields/methods necessary to build ecj.
2012-11-12 Andrew John Hughes <gnu_andrew@member.fsf.org> New files to start supporting recent versions of ecj & javac. * javax/annotation/processing/Filer.java: Stub. * javax/annotation/processing/Messager.java: Likewise. * javax/annotation/processing/ProcessingEnvironment.java: (getElementUtils()): Added. (getFiler()): Likewise. (getLocale()): Likewise. (getMessager()): Likewise. * javax/annotation/processing/RoundEnvironment.java: (errorRaised()): Likewise. (getElementsAnnotatedWith(Class)): Likewise. (getElementsAnnotatedWith(TypeElement)): Likewise. (getRootElements()): Likewise. (processingOver()): Likewise. * javax/lang/model/SourceVersion.java: (RELEASE_0): Likewise. (RELEASE_1): Likewise. (RELEASE_2): Likewise. (RELEASE_3): Likewise. (RELEASE_4): Likewise. (RELEASE_5): Likewise. (RELEASE_6): Likewise. (isIdentifier(CharSequence)): Likewise. (latest()): Likewise. (latestSupported()): Likewise. * javax/lang/model/element/Element.java: (accept(ElementVisitor,P)): Likewise. (equals(Object)): Likewise. (getAnnotation(Class)): Likewise. (getEnclosedElements()): Likewise. (getEnclosingElement()): Likewise. (getKind()): Likewise. (hashCode()): Likewise. * javax/lang/model/element/ElementKind.java: (ANNOTATION_TYPE): Likewise. (CLASS): Likewise. (CONSTRUCTOR): Likewise. (ENUM): Likewise. (ENUM_CONSTANT): Likewise. (EXCEPTION_PARAMETER): Likewise. (FIELD): Likewise. (INSTANCE_INIT): Likewise. (INTERFACE): Likewise. (LOCAL_VARIABLE): Likewise. (METHOD): Likewise. (OTHER): Likewise. (PACKAGE): Likewise. (PARAMETER): Likewise. (STATIC_INIT): Likewise. (TYPE_PARAMETER): Likewise. * javax/lang/model/element/ElementVisitor.java: (visit(Element)): Likewise. (visit(Element, P)): Likewise. (visitType(TypeElement, P): Likewise. (visitUnknown(Element, P): Likewise. * javax/lang/model/element/TypeElement.java: Stub. * javax/lang/model/util/ElementFilter.java: (typesIn(Set)): Implemented. (FilteredSet): Class which typesIn returns an instance of. (FilteredSet.elements): New field. (FilteredSet.clazz): Likewise. (FilteredSet.FilteredSet(Set,Class)): Implemented. (FilteredSet.add(E)): Likewise. (FilteredSet.addAll(Collection)): Likewise. (FilteredSet.clear()): Likewise. (FilteredSet.contains(Object)): Likewise. (FilteredSet.containsAll(Collection)): Likewise. (FilteredSet.equals(Object)): Likewise. (FilteredSet.hashCode()): Likewise. (FilteredSet.isEmpty()): Likewise. (FilteredSet.iterator()): Likewise. (FilteredSet.remove(Object)): Likewise. (FilteredSet.removeAll(Collection)): Likewise. (FilteredSet.retainAll(Collection)): Likewise. (FilteredSet.size()): Likewise. (FilteredSet.toArray()): Likewise. (FilteredSet.toArray(T[])): Likewise. (FilteredIterator): Class which FilteredSet.iterator() provides an instance of. (FilteredIterator.iterator): New field. (FilteredIterator.clazz): Likewise. (FilteredIterator.next): Likewise. (FilteredIterator.FilteredIterator(Iterator,Class)): Implemented. (FilteredIterator.hasNext()): Likewise. (FilteredIterator.next()): Likewise. (FilteredIterator.remove()): Likewise. * javax/lang/model/util/Elements.java: (getAllMembers(TypeElement)): Likewise. (getConstantExpression(Object)): Likewise. (getDocComment(Object)): Likewise. (getTypeElement(CharSequence)): Likewise. (hides(Element,Element)): Likewise. (isDeprecated(Element)): Likewise. (printElements(Writer,Element...)): Likewise. * javax/lang/model/util/Types.java: Stub. Signed-off-by: Andrew John Hughes <gnu_andrew@member.fsf.org>
Diffstat (limited to 'javax/lang/model/element/Element.java')
-rw-r--r--javax/lang/model/element/Element.java161
1 files changed, 161 insertions, 0 deletions
diff --git a/javax/lang/model/element/Element.java b/javax/lang/model/element/Element.java
new file mode 100644
index 000000000..bd90bed27
--- /dev/null
+++ b/javax/lang/model/element/Element.java
@@ -0,0 +1,161 @@
+/* Element.java -- Represents a program element at the language level.
+ Copyright (C) 2012 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+package javax.lang.model.element;
+
+import java.lang.annotation.Annotation;
+
+import java.util.List;
+
+/**
+ * <p>
+ * Represents a program element at the language level. For example,
+ * an {@code Element} may represent a package, a class or a type
+ * parameter. Types only present at runtime in the virtual machine
+ * are not represented.
+ * </p>
+ * <p>To compare two instances, use {@link #equals(Object)} as there
+ * is no guarantee that == will hold. To determine the subtype of
+ * {@code Element}, use {@link #getKind()} or a visitor, as
+ * implementations may use the same class to implement multiple
+ * subinterfaces.</p>
+ *
+ * @since 1.6
+ */
+public interface Element
+{
+
+ /**
+ * Applies a visitor to this element.
+ *
+ * @param <R> the return type of the visitor's methods.
+ * @param <P> the type of the additional parameter used in the visitor's
+ * methods.
+ * @param visitor the visitor to apply to the element.
+ * @param param the additional parameter to be sent to the visitor.
+ * @return the return value from the visitor.
+ */
+ <R,P> R accept(ElementVisitor<R,P> visitor, P param);
+
+ /**
+ * <p>Returns {@code true} if this instance represents the same
+ * element as the one supplied.</p>
+ * <p>Please note that an element may not be equal to the same
+ * element provided by a different implementation of this framework,
+ * as the equivalence comparison may include the use of internal
+ * state which is inaccessible from the element's methods. This
+ * is similar to the way {@link Class} objects provided by different
+ * classloaders are not guaranteed to be equal.</p>
+ *
+ * @param obj the object to compare.
+ * @return {@code true} if {@code this} and {@code obj} represent
+ * the same element.
+ */
+ boolean equals(Object obj);
+
+ /**
+ * <p>Returns the element's annotation for the specified annotation type,
+ * if present, or {@code null} if not. The annotation may be directly
+ * present on the element or inherited.</p>
+ * <p>If the annotation contains an element of type {@code Class} or
+ * {@code Class[]}, attempts to read such an object will result in
+ * a {@link javax.lang.model.type.MirroredTypeException} or
+ * {@link javax.lang.model.type.MirroredTypesException} respectively.
+ * This is because information required to load the class (such as its
+ * class loader) is unavailable and so it may not be possible to load
+ * the class at all.</p>
+ * <p>Note that, unlike other methods in this framework, this method
+ * operates on runtime information obtained through reflection.
+ * As a result, the methods of the returned annotation object may
+ * throw exceptions relating to reflection failures.</p>
+ *
+ * @param <A> the type of annotation.
+ * @param annonType the {@code Class} object representing the annotation type.
+ * @return an annotation of the specified type, if present, or {@code null}.
+ * @see #getAnnotationMirrors()
+ * @see Elements#getAllAnnotationMirrors(Element)
+ * @see java.lang.reflect.AnnotatedElement#getAnnotation(Class)
+ * @see java.lang.annotation.AnnotationTypeMismatchException
+ * @see java.lang.annotation.IncompleteAnnotationException
+ * @see javax.lang.model.type.MirroredTypeException
+ * @see javax.lang.model.type.MirroredTypesException
+ */
+ <A extends Annotation> A getAnnotation(Class<A> annonType);
+
+ /**
+ * Returns the elements directly enclosed by this element.
+ * For example, a class element encloses constructor, method,
+ * field and further class elements. The returned list
+ * includes elements automatically generated by the compiler
+ * such as the default constructor and {@code values} and
+ * {@code valueOf} methods present in enumerations. Package
+ * elements contain class and interface elements, but not
+ * other packages. All other types of element do not contain
+ * other elements at this time.
+ *
+ * @return the enclosed elements, or an empty list if the
+ * element has none.
+ * @see Elements#getAllMembers(TypeElement)
+ */
+ List<? extends Element> getEnclosedElements();
+
+ /**
+ * Returns the element that encloses this element. For a top-level
+ * type, its package is returned. Package and type parameter
+ * elements return {@code null}.
+ *
+ * @return the enclosing element or {@code null} if there isn't one.
+ * @see Elements#getPackageOf(Element)
+ */
+ Element getEnclosingElement();
+
+ /**
+ * Returns the kind of this element.
+ *
+ * @return the kind of element.
+ */
+ ElementKind getKind();
+
+ /**
+ * Obeys the general contract of {@link java.lang.Object#hashCode()}.
+ *
+ * @return a hash code for this element.
+ * @see #equals(Object)
+ */
+ int hashCode();
+
+}