Tue, 22 Oct 2013 17:42:10 -0700
8027119: Cleanup javadoc comments for taglet API
Reviewed-by: mduigou
1 /*
2 * Copyright (c) 2003, 2013, 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
23 * questions.
24 */
26 package com.sun.javadoc;
29 /**
30 * Represents a type variable.
31 * For example, the generic interface {@code List<E>} has a single
32 * type variable {@code E}.
33 * A type variable may have explicit bounds, as in
34 * {@code C<R extends Remote>}.
35 *
36 * @author Scott Seligman
37 * @since 1.5
38 */
39 public interface TypeVariable extends Type {
41 /**
42 * Return the bounds of this type variable.
43 * These are the types given by the <i>extends</i> clause.
44 * Return an empty array if there are no explicit bounds.
45 *
46 * @return the bounds of this type variable.
47 */
48 Type[] bounds();
50 /**
51 * Return the class, interface, method, or constructor within
52 * which this type variable is declared.
53 *
54 * @return the class, interface, method, or constructor within
55 * which this type variable is declared.
56 */
57 ProgramElementDoc owner();
59 /**
60 * Get the annotations of this program element.
61 * Return an empty array if there are none.
62 */
63 public AnnotationDesc[] annotations();
65 }