src/share/classes/javax/lang/model/type/TypeVariable.java

Fri, 06 Feb 2009 12:49:48 -0800

author
darcy
date
Fri, 06 Feb 2009 12:49:48 -0800
changeset 216
58fcba61a77d
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6794071: Provide exception superclass for UnknownFooExceptions
Reviewed-by: jjg

duke@1 1 /*
duke@1 2 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package javax.lang.model.type;
duke@1 27
duke@1 28
duke@1 29 import javax.lang.model.element.Element;
duke@1 30 import javax.lang.model.element.TypeParameterElement;
duke@1 31 import javax.lang.model.util.Types;
duke@1 32
duke@1 33
duke@1 34 /**
duke@1 35 * Represents a type variable.
duke@1 36 * A type variable may be explicitly declared by a
duke@1 37 * {@linkplain TypeParameterElement type parameter} of a
duke@1 38 * type, method, or constructor.
duke@1 39 * A type variable may also be declared implicitly, as by
duke@1 40 * the capture conversion of a wildcard type argument
duke@1 41 * (see chapter 5 of <i>The Java Language Specification, Third
duke@1 42 * Edition</i>).
duke@1 43 *
duke@1 44 * @author Joseph D. Darcy
duke@1 45 * @author Scott Seligman
duke@1 46 * @author Peter von der Ah&eacute;
duke@1 47 * @see TypeParameterElement
duke@1 48 * @since 1.6
duke@1 49 */
duke@1 50 public interface TypeVariable extends ReferenceType {
duke@1 51
duke@1 52 /**
duke@1 53 * Returns the element corresponding to this type variable.
duke@1 54 *
duke@1 55 * @return the element corresponding to this type variable
duke@1 56 */
duke@1 57 Element asElement();
duke@1 58
duke@1 59 /**
duke@1 60 * Returns the upper bound of this type variable.
duke@1 61 *
duke@1 62 * <p> If this type variable was declared with no explicit
duke@1 63 * upper bounds, the result is {@code java.lang.Object}.
duke@1 64 * If it was declared with multiple upper bounds,
duke@1 65 * the result is an intersection type (modeled as a
duke@1 66 * {@link DeclaredType}).
duke@1 67 * Individual bounds can be found by examining the result's
duke@1 68 * {@linkplain Types#directSupertypes(TypeMirror) supertypes}.
duke@1 69 *
duke@1 70 * @return the upper bound of this type variable
duke@1 71 */
duke@1 72 TypeMirror getUpperBound();
duke@1 73
duke@1 74 /**
duke@1 75 * Returns the lower bound of this type variable. While a type
duke@1 76 * parameter cannot include an explicit lower bound declaration,
duke@1 77 * capture conversion can produce a type variable with a
duke@1 78 * non-trivial lower bound. Type variables otherwise have a
duke@1 79 * lower bound of {@link NullType}.
duke@1 80 *
duke@1 81 * @return the lower bound of this type variable
duke@1 82 */
duke@1 83 TypeMirror getLowerBound();
duke@1 84 }

mercurial