diff options
author | Andrew John Hughes <gnu_andrew@member.fsf.org> | 2012-11-29 11:34:28 +0000 |
---|---|---|
committer | Andrew John Hughes <gnu_andrew@member.fsf.org> | 2012-11-29 11:34:28 +0000 |
commit | f913ee5ae1a0338aaf622f25429d66fd8c888c63 (patch) | |
tree | 595809fb8a84b36e2f9862df5905abe5afe2b03c /javax/lang/model/element | |
parent | 449a0b97ab63a4bff26ae281322fc3afaab16569 (diff) | |
download | classpath-f913ee5ae1a0338aaf622f25429d66fd8c888c63.tar.gz |
Add Name & PackageElement along with methods that depend on them.
2012-11-29 Andrew John Hughes <gnu_andrew@member.fsf.org>
* javax/lang/model/element/ElementVisitor.java:
(visitExecutable(ExecutableElement, P)): Correct documentation.
(visitTypeParameter(TypeParameterElement, P)): Likewise.
(visitVariable(VariableElement, P)): Likewise.
(visitPackage(PackageElement, P)): Added.
* javax/lang/model/element/Name.java:
Added.
(contentEquals(CharSequence)): Added.
(equals(Object)): Likewise.
(hashCode()): Likewise.
* javax/lang/model/element/PackageElement.java:
Added.
(getQualifiedName()): Added.
(isUnnamed()): Likewise.
* javax/lang/model/element/TypeElement.java:
(getQualifiedName()): Added.
* javax/lang/model/util/Elements.java:
(getBinaryName(TypeElement)): Added.
(getName(CharSequence)): Likewise.
(getPackageElement(CharSequence)): Likewise.
(getPackageOf(Element)): Likewise.
Signed-off-by: Andrew John Hughes <gnu_andrew@member.fsf.org>
Diffstat (limited to 'javax/lang/model/element')
-rw-r--r-- | javax/lang/model/element/ElementVisitor.java | 15 | ||||
-rw-r--r-- | javax/lang/model/element/Name.java | 90 | ||||
-rw-r--r-- | javax/lang/model/element/PackageElement.java | 72 | ||||
-rw-r--r-- | javax/lang/model/element/TypeElement.java | 17 |
4 files changed, 191 insertions, 3 deletions
diff --git a/javax/lang/model/element/ElementVisitor.java b/javax/lang/model/element/ElementVisitor.java index 656795daa..e25a035dc 100644 --- a/javax/lang/model/element/ElementVisitor.java +++ b/javax/lang/model/element/ElementVisitor.java @@ -106,7 +106,7 @@ public interface ElementVisitor<R,P> /** * Visits an executable element. * - * @param element the type element to visit. + * @param element the executable element to visit. * @param param the additional parameter, specific to the visitor. * May be {@code null} if permitted by the visitor. */ @@ -115,7 +115,7 @@ public interface ElementVisitor<R,P> /** * Visits a type parameter element. * - * @param element the type element to visit. + * @param element the type parameter element to visit. * @param param the additional parameter, specific to the visitor. * May be {@code null} if permitted by the visitor. */ @@ -124,10 +124,19 @@ public interface ElementVisitor<R,P> /** * Visits a variable element. * - * @param element the type element to visit. + * @param element the variable element to visit. * @param param the additional parameter, specific to the visitor. * May be {@code null} if permitted by the visitor. */ R visitVariable(VariableElement element, P param); + /** + * Visits a package element. + * + * @param element the package element to visit. + * @param param the additional parameter, specific to the visitor. + * May be {@code null} if permitted by the visitor. + */ + R visitPackage(PackageElement element, P param); + } diff --git a/javax/lang/model/element/Name.java b/javax/lang/model/element/Name.java new file mode 100644 index 000000000..28da2cab6 --- /dev/null +++ b/javax/lang/model/element/Name.java @@ -0,0 +1,90 @@ +/* Name.java -- An immutable sequence of characters. + 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; + +/** + * <p>An immutable sequence of characters, representing a name. + * An empty name has a length of zero.</p> + * <p>Names created by the same implementation are comparable + * using {@link #equals(Object)} and thus usable in a collection. + * This guarantee as regards the "same implementation" also + * applies to successive annotation rounds in the context of + * annotation processing.</p> + * + * @author Andrew John Hughes (gnu_andrew@member.fsf.org) + * @since 1.6 + * @see javax.lang.model.util.Elements#getName(CharSequence) + */ +public interface Name + extends CharSequence +{ + + /** + * Returns true if the sequence of characters within this + * name is the same as the specified sequence of characters. + * + * @param chars the sequence of characters to compare. + * @return true if {@code chars} represents the same sequence + * of characters as this name. + * @see String#contentEquals(CharSequence) + */ + boolean contentEquals(CharSequence chars); + + /** + * Returns {@code true} if the specified object represents the + * same name as this instance. Name comparisons are not + * just reliant on the content of the name (see + * {@link #contentEquals(CharSequence)}) but also + * the implementation which created the name. + * + * @param obj the object to compare. + * @return {@code true} if {@code this} and {@code obj} represent + * the same element. + */ + boolean equals(Object obj); + + /** + * Obeys the general contract of {@link java.lang.Object#hashCode()}. + * + * @return a hash code for this element. + * @see #equals(Object) + */ + int hashCode(); + +} + diff --git a/javax/lang/model/element/PackageElement.java b/javax/lang/model/element/PackageElement.java new file mode 100644 index 000000000..71a06bc94 --- /dev/null +++ b/javax/lang/model/element/PackageElement.java @@ -0,0 +1,72 @@ +/* PackageElement.java -- Represents a package. + 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; + +/** + * Represents a package, providing access to information about + * it and its members. + * + * @author Andrew John Hughes (gnu_andrew@member.fsf.org) + * @since 1.6 + * @see javax.lang.model.util.Elements#getPackageOf(Element) + */ +public interface PackageElement + extends Element +{ + + /** + * Returns the fully qualified name (<emph>canonical + * name</emph>) of the package, as specified in section + * 6.7 of the Java Language Specification, or an empty + * name if the package is unnamed. + * + * @return the fully qualified name of the package. + * @see #isUnnamed() + */ + Name getQualifiedName(); + + /** + * Returns {@code true} if this is an unnamed package. + * Unnamed packages are detailed in section 7.4.2 of + * the Java Language Specification. + * + * @return true if this is an unnamed package. + */ + boolean isUnnamed(); + +} diff --git a/javax/lang/model/element/TypeElement.java b/javax/lang/model/element/TypeElement.java index c6b76197e..ed11d3ea1 100644 --- a/javax/lang/model/element/TypeElement.java +++ b/javax/lang/model/element/TypeElement.java @@ -99,4 +99,21 @@ public interface TypeElement */ List<? extends TypeParameterElement> getTypeParameters(); + /** + * Returns the fully qualified or <emph>canonical</emph> + * name of this type element. For a local or anonymous + * class, the empty string is returned. Generic types + * do not include their type parameters in the returned + * string i.e. {@code "java.util.Set"} not + * {@code "java.util.Set<E>"}. A period ({@code "."}) is + * the only separator used, including for nested classes + * such as {@code "java.util.Map.Entry"}. See + * Section 6.7 of the Java Language Specification for + * more details. + * + * @return the canonical name of this type element. + * @see javax.lang.model.util.Elements#getBinaryName(TypeElement) + */ + Name getQualifiedName(); + } |