< prev index next >

src/java.compiler/share/classes/javax/lang/model/element/TypeElement.java

Print this page


   1 /*
   2  * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  42  * The distinction is most apparent with generic types,
  43  * for which a single element can define a whole
  44  * family of types.  For example, the element
  45  * {@code java.util.Set} corresponds to the parameterized types
  46  * {@code java.util.Set<String>} and {@code java.util.Set<Number>}
  47  * (and many others), and to the raw type {@code java.util.Set}.
  48  *
  49  * <p> Each method of this interface that returns a list of elements
  50  * will return them in the order that is natural for the underlying
  51  * source of program information.  For example, if the underlying
  52  * source of information is Java source code, then the elements will be
  53  * returned in source code order.
  54  *
  55  * @author Joseph D. Darcy
  56  * @author Scott Seligman
  57  * @author Peter von der Ah&eacute;
  58  * @see DeclaredType
  59  * @since 1.6
  60  */
  61 public interface TypeElement extends Element, Parameterizable, QualifiedNameable {
  62     /**
  63      * Returns the type defined by this type element, returning the
  64      * <i>prototypical</i> type for an element representing a generic type.
  65      *
  66      * <p>A generic element defines a family of types, not just one.
  67      * If this is a generic element, a prototypical type is
  68      * returned which has the element's invocation on the
  69      * type variables corresponding to its own formal type parameters.
  70      * For example,
  71      * for the generic class element {@code C<N extends Number>},
  72      * the parameterized type {@code C<N>} is returned.
  73      * The {@link Types} utility interface has more general methods
  74      * for obtaining the full range of types defined by an element.
  75      *
  76      * @return the type defined by this type element
  77      *
  78      * @see Types#asMemberOf(DeclaredType, Element)
  79      * @see Types#getDeclaredType(TypeElement, TypeMirror...)
  80      */
  81     @Override
  82     TypeMirror asType();
  83 
  84     /**
  85      * Returns the fields, methods, constructors, and member types
  86      * that are directly declared in this class or interface.
  87      *
  88      * This includes any {@linkplain Elements.Origin#MANDATED
  89      * mandated} elements such as the (implicit) default constructor
  90      * and the implicit {@code values} and {@code valueOf} methods of
  91      * an enum type.
  92      *
  93      * @apiNote As a particular instance of the {@linkplain
  94      * javax.lang.model.element general accuracy requirements} and the
  95      * ordering behavior required of this interface, the list of
  96      * enclosed elements will be returned in the natural order for the
  97      * originating source of information about the type.  For example,
  98      * if the information about the type is originating from a source
  99      * file, the elements will be returned in source code order.
 100      * (However, in that case the the ordering of {@linkplain
 101      * Elements.Origin#MANDATED implicitly declared} elements, such as
 102      * default constructors, is not specified.)
 103      *


   1 /*
   2  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  42  * The distinction is most apparent with generic types,
  43  * for which a single element can define a whole
  44  * family of types.  For example, the element
  45  * {@code java.util.Set} corresponds to the parameterized types
  46  * {@code java.util.Set<String>} and {@code java.util.Set<Number>}
  47  * (and many others), and to the raw type {@code java.util.Set}.
  48  *
  49  * <p> Each method of this interface that returns a list of elements
  50  * will return them in the order that is natural for the underlying
  51  * source of program information.  For example, if the underlying
  52  * source of information is Java source code, then the elements will be
  53  * returned in source code order.
  54  *
  55  * @author Joseph D. Darcy
  56  * @author Scott Seligman
  57  * @author Peter von der Ah&eacute;
  58  * @see DeclaredType
  59  * @since 1.6
  60  */
  61 public interface TypeElement extends Element, Parameterizable, QualifiedNameable {






















  62     /**
  63      * Returns the fields, methods, constructors, and member types
  64      * that are directly declared in this class or interface.
  65      *
  66      * This includes any {@linkplain Elements.Origin#MANDATED
  67      * mandated} elements such as the (implicit) default constructor
  68      * and the implicit {@code values} and {@code valueOf} methods of
  69      * an enum type.
  70      *
  71      * @apiNote As a particular instance of the {@linkplain
  72      * javax.lang.model.element general accuracy requirements} and the
  73      * ordering behavior required of this interface, the list of
  74      * enclosed elements will be returned in the natural order for the
  75      * originating source of information about the type.  For example,
  76      * if the information about the type is originating from a source
  77      * file, the elements will be returned in source code order.
  78      * (However, in that case the the ordering of {@linkplain
  79      * Elements.Origin#MANDATED implicitly declared} elements, such as
  80      * default constructors, is not specified.)
  81      *


< prev index next >