• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/Type.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/javadoc/Type.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 1691

f10cffab99b4

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.javadoc;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* Represents a type. A type can be a class or interface, an
aoqi@0	30	* invocation (like {@code List<String>}) of a generic class or interface,
aoqi@0	31	* a type variable, a wildcard type ("<code>?</code>"),
aoqi@0	32	* or a primitive data type (like <code>char</code>).
aoqi@0	33	*
aoqi@0	34	* @since 1.2
aoqi@0	35	* @author Kaiyang Liu (original)
aoqi@0	36	* @author Robert Field (rewrite)
aoqi@0	37	* @author Scott Seligman (generics)
aoqi@0	38	*/
aoqi@0	39	public interface Type {
aoqi@0	40
aoqi@0	41	/**
aoqi@0	42	* Return unqualified name of type excluding any dimension information.
aoqi@0	43	* <p>
aoqi@0	44	* For example, a two dimensional array of String returns
aoqi@0	45	* "<code>String</code>".
aoqi@0	46	*/
aoqi@0	47	String typeName();
aoqi@0	48
aoqi@0	49	/**
aoqi@0	50	* Return qualified name of type excluding any dimension information.
aoqi@0	51	*<p>
aoqi@0	52	* For example, a two dimensional array of String
aoqi@0	53	* returns "<code>java.lang.String</code>".
aoqi@0	54	*/
aoqi@0	55	String qualifiedTypeName();
aoqi@0	56
aoqi@0	57	/**
aoqi@0	58	* Return the simple name of this type excluding any dimension information.
aoqi@0	59	* This is the unqualified name of the type, except that for nested types
aoqi@0	60	* only the identifier of the innermost type is included.
aoqi@0	61	* <p>
aoqi@0	62	* For example, the class {@code Outer.Inner} returns
aoqi@0	63	* "<code>Inner</code>".
aoqi@0	64	*
aoqi@0	65	* @since 1.5
aoqi@0	66	*/
aoqi@0	67	String simpleTypeName();
aoqi@0	68
aoqi@0	69	/**
aoqi@0	70	* Return the type's dimension information, as a string.
aoqi@0	71	* <p>
aoqi@0	72	* For example, a two dimensional array of String returns
aoqi@0	73	* "<code>[][]</code>".
aoqi@0	74	*/
aoqi@0	75	String dimension();
aoqi@0	76
aoqi@0	77	/**
aoqi@0	78	* Return a string representation of the type.
aoqi@0	79	* This includes any dimension information and type arguments.
aoqi@0	80	* <p>
aoqi@0	81	* For example, a two dimensional array of String may return
aoqi@0	82	* "<code>java.lang.String[][]</code>",
aoqi@0	83	* and the parameterized type {@code List<Integer>} may return
aoqi@0	84	* "{@code java.util.List<java.lang.Integer>}".
aoqi@0	85	*
aoqi@0	86	* @return a string representation of the type.
aoqi@0	87	*/
aoqi@0	88	String toString();
aoqi@0	89
aoqi@0	90	/**
aoqi@0	91	* Return true if this type represents a primitive type.
aoqi@0	92	*
aoqi@0	93	* @return true if this type represents a primitive type.
aoqi@0	94	* @since 1.5
aoqi@0	95	*/
aoqi@0	96	boolean isPrimitive();
aoqi@0	97
aoqi@0	98	/**
aoqi@0	99	* Return this type as a <code>ClassDoc</code> if it represents a class
aoqi@0	100	* or interface. Array dimensions are ignored.
aoqi@0	101	* If this type is a <code>ParameterizedType</code>,
aoqi@0	102	* <code>TypeVariable</code>, or <code>WildcardType</code>, return
aoqi@0	103	* the <code>ClassDoc</code> of the type's erasure. If this is an
aoqi@0	104	* <code>AnnotationTypeDoc</code>, return this as a <code>ClassDoc</code>
aoqi@0	105	* (but see {@link #asAnnotationTypeDoc()}).
aoqi@0	106	* If this is a primitive type, return null.
aoqi@0	107	*
aoqi@0	108	* @return the <code>ClassDoc</code> of this type,
aoqi@0	109	* or null if it is a primitive type.
aoqi@0	110	*/
aoqi@0	111	ClassDoc asClassDoc();
aoqi@0	112
aoqi@0	113	/**
aoqi@0	114	* Return this type as a <code>ParameterizedType</code> if it represents
aoqi@0	115	* an invocation of a generic class or interface. Array dimensions
aoqi@0	116	* are ignored.
aoqi@0	117	*
aoqi@0	118	* @return a <code>ParameterizedType</code> if the type is an
aoqi@0	119	* invocation of a generic type, or null if it is not.
aoqi@0	120	* @since 1.5
aoqi@0	121	*/
aoqi@0	122	ParameterizedType asParameterizedType();
aoqi@0	123
aoqi@0	124	/**
aoqi@0	125	* Return this type as a <code>TypeVariable</code> if it represents
aoqi@0	126	* a type variable. Array dimensions are ignored.
aoqi@0	127	*
aoqi@0	128	* @return a <code>TypeVariable</code> if the type is a type variable,
aoqi@0	129	* or null if it is not.
aoqi@0	130	* @since 1.5
aoqi@0	131	*/
aoqi@0	132	TypeVariable asTypeVariable();
aoqi@0	133
aoqi@0	134	/**
aoqi@0	135	* Return this type as a <code>WildcardType</code> if it represents
aoqi@0	136	* a wildcard type.
aoqi@0	137	*
aoqi@0	138	* @return a <code>WildcardType</code> if the type is a wildcard type,
aoqi@0	139	* or null if it is not.
aoqi@0	140	* @since 1.5
aoqi@0	141	*/
aoqi@0	142	WildcardType asWildcardType();
aoqi@0	143
aoqi@0	144	/**
aoqi@0	145	* Returns this type as a <code>AnnotatedType</code> if it represents
aoqi@0	146	* an annotated type.
aoqi@0	147	*
aoqi@0	148	* @return a <code>AnnotatedType</code> if the type if an annotated type,
aoqi@0	149	* or null if it is not
aoqi@0	150	* @since 1.8
aoqi@0	151	*/
aoqi@0	152	AnnotatedType asAnnotatedType();
aoqi@0	153
aoqi@0	154	/**
aoqi@0	155	* Return this type as an <code>AnnotationTypeDoc</code> if it represents
aoqi@0	156	* an annotation type. Array dimensions are ignored.
aoqi@0	157	*
aoqi@0	158	* @return an <code>AnnotationTypeDoc</code> if the type is an annotation
aoqi@0	159	* type, or null if it is not.
aoqi@0	160	* @since 1.5
aoqi@0	161	*/
aoqi@0	162	AnnotationTypeDoc asAnnotationTypeDoc();
aoqi@0	163
aoqi@0	164	/**
aoqi@0	165	* If this type is an array type, return the element type of the
aoqi@0	166	* array. Otherwise, return null.
aoqi@0	167	*
aoqi@0	168	* @return a <code>Type</code> representing the element type or null.
aoqi@0	169	* @since 1.8
aoqi@0	170	*/
aoqi@0	171	Type getElementType();
aoqi@0	172	}