jdk8-mips64-public/langtools: src/share/classes/com/sun/javadoc/Type.java@9a66ca7c79fa (annotated)

src/share/classes/com/sun/javadoc/Type.java@9a66ca7c79fa (annotated)

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

Sat, 01 Dec 2007 00:00:00 +0000

author: duke
date: Sat, 01 Dec 2007 00:00:00 +0000
changeset 1: 9a66ca7c79fa
child 554: 9d9f26857129
permissions: -rw-r--r--

Initial load

 /*
  * Copyright 1997-2006 Sun Microsystems, Inc.  All Rights Reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
  * have any questions.
  */
 package com.sun.javadoc;
 /**
  * Represents a type.  A type can be a class or interface, an
  * invocation (like {@code List<String>}) of a generic class or interface,
  * a type variable, a wildcard type ("<code>?</code>"),
  * or a primitive data type (like <code>char</code>).
  *
  * @since 1.2
  * @author Kaiyang Liu (original)
  * @author Robert Field (rewrite)
  * @author Scott Seligman (generics)
  */
 public interface Type {
     /**
      * Return unqualified name of type excluding any dimension information.
      * <p>
      * For example, a two dimensional array of String returns
      * "<code>String</code>".
      */
     String typeName();
     /**
      * Return qualified name of type excluding any dimension information.
      *<p>
      * For example, a two dimensional array of String
      * returns "<code>java.lang.String</code>".
      */
     String qualifiedTypeName();
     /**
      * Return the simple name of this type excluding any dimension information.
      * This is the unqualified name of the type, except that for nested types
      * only the identifier of the innermost type is included.
      * <p>
      * For example, the class {@code Outer.Inner} returns
      * "<code>Inner</code>".
      *
      * @since 1.5
      */
     String simpleTypeName();
     /**
      * Return the type's dimension information, as a string.
      * <p>
      * For example, a two dimensional array of String returns
      * "<code>[][]</code>".
      */
     String dimension();
     /**
      * Return a string representation of the type.
      * This includes any dimension information and type arguments.
      * <p>
      * For example, a two dimensional array of String may return
      * "<code>java.lang.String[][]</code>",
      * and the parameterized type {@code List<Integer>} may return
      * "{@code java.util.List<java.lang.Integer>}".
      *
      * @return a string representation of the type.
      */
     String toString();
     /**
      * Return true if this type represents a primitive type.
      *
      * @return true if this type represents a primitive type.
      * @since 1.5
      */
     boolean isPrimitive();
     /**
      * Return this type as a <code>ClassDoc</code> if it represents a class
      * or interface.  Array dimensions are ignored.
      * If this type is a <code>ParameterizedType</code>,
      * <code>TypeVariable</code>, or <code>WildcardType</code>, return
      * the <code>ClassDoc</code> of the type's erasure.  If this is an
      * <code>AnnotationTypeDoc</code>, return this as a <code>ClassDoc</code>
      * (but see {@link #asAnnotationTypeDoc()}).
      * If this is a primitive type, return null.
      *
      * @return the <code>ClassDoc</code> of this type,
      *         or null if it is a primitive type.
      */
     ClassDoc asClassDoc();
     /**
      * Return this type as a <code>ParameterizedType</code> if it represents
      * an invocation of a generic class or interface.  Array dimensions
      * are ignored.
      *
      * @return a <code>ParameterizedType</code> if the type is an
      *         invocation of a generic type, or null if it is not.
      * @since 1.5
      */
     ParameterizedType asParameterizedType();
     /**
      * Return this type as a <code>TypeVariable</code> if it represents
      * a type variable.  Array dimensions are ignored.
      *
      * @return a <code>TypeVariable</code> if the type is a type variable,
      *         or null if it is not.
      * @since 1.5
      */
     TypeVariable asTypeVariable();
     /**
      * Return this type as a <code>WildcardType</code> if it represents
      * a wildcard type.
      *
      * @return a <code>WildcardType</code> if the type is a wildcard type,
      *         or null if it is not.
      * @since 1.5
      */
     WildcardType asWildcardType();
     /**
      * Return this type as an <code>AnnotationTypeDoc</code> if it represents
      * an annotation type.  Array dimensions are ignored.
      *
      * @return an <code>AnnotationTypeDoc</code> if the type is an annotation
      *         type, or null if it is not.
      * @since 1.5
      */
     AnnotationTypeDoc asAnnotationTypeDoc();
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/javadoc/Type.java@9a66ca7c79fa (annotated)

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