jdk/src/share/classes/java/lang/reflect/TypeVariable.java
author darcy
Tue, 06 Sep 2011 21:19:31 -0700
changeset 10433 3154f134c8d9
parent 5506 202f599c92aa
child 14342 8435a30053c1
permissions -rw-r--r--
7086192: (reflect) Have TypeVariable extend AnnotatedElement Reviewed-by: mcimadamore
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 2003, 2005, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang.reflect;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * TypeVariable is the common superinterface for type variables of kinds.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * A type variable is created the first time it is needed by a reflective
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * method, as specified in this package.  If a type variable t is referenced
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * by a type (i.e, class, interface or annotation type) T, and T is declared
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * by the nth enclosing class of T (see JLS 8.1.2), then the creation of t
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * requires the resolution (see JVMS 5) of the ith enclosing class of T,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * for i = 0 to n, inclusive. Creating a type variable must not cause the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * creation of its bounds. Repeated creation of a type variable has no effect.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <p>Multiple objects may be instantiated at run-time to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * represent a given type variable. Even though a type variable is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * created only once, this does not imply any requirement to cache
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * instances representing the type variable. However, all instances
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * representing a type variable must be equal() to each other.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * As a consequence, users of type variables must not rely on the identity
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * of instances of classes implementing this interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * @param <D> the type of generic declaration that declared the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * underlying type variable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 */
10433
3154f134c8d9 7086192: (reflect) Have TypeVariable extend AnnotatedElement
darcy
parents: 5506
diff changeset
    51
public interface TypeVariable<D extends GenericDeclaration> extends Type, AnnotatedElement {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * Returns an array of {@code Type} objects representing the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * upper bound(s) of this type variable.  Note that if no upper bound is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * explicitly declared, the upper bound is {@code Object}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * <p>For each upper bound B: <ul> <li>if B is a parameterized
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * type or a type variable, it is created, (see {@link
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * java.lang.reflect.ParameterizedType ParameterizedType} for the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * details of the creation process for parameterized types).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * <li>Otherwise, B is resolved.  </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * @throws TypeNotPresentException  if any of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     *     bounds refers to a non-existent type declaration
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * @throws MalformedParameterizedTypeException if any of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     *     bounds refer to a parameterized type that cannot be instantiated
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     *     for any reason
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * @return an array of {@code Type}s representing the upper
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     *     bound(s) of this type variable
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    Type[] getBounds();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * Returns the {@code GenericDeclaration} object representing the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * generic declaration declared this type variable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * @return the generic declaration declared for this type variable.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    D getGenericDeclaration();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * Returns the name of this type variable, as it occurs in the source code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * @return the name of this type variable, as it appears in the source code
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    String getName();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
}