1 /*
   2  * Copyright 2004 Sun Microsystems, Inc.  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.  Sun designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any questions.
  24  */
  25 
  26 package com.sun.mirror.type;
  27 
  28 
  29 import com.sun.mirror.declaration.*;
  30 
  31 
  32 /**
  33  * Represents a class type.
  34  * Interface types are represented separately by {@link InterfaceType}.
  35  * Note that an {@linkplain EnumType enum} is a kind of class.
  36  *
  37  * <p> While a {@link ClassDeclaration} represents the <i>declaration</i>
  38  * of a class, a <tt>ClassType</tt> represents a class <i>type</i>.
  39  * See {@link TypeDeclaration} for more on this distinction.
  40  *
  41  * @author Joseph D. Darcy
  42  * @author Scott Seligman
  43  * @since 1.5
  44  */
  45 
  46 public interface ClassType extends DeclaredType {
  47 
  48     /**
  49      * {@inheritDoc}
  50      */
  51     ClassDeclaration getDeclaration();
  52 
  53     /**
  54      * Returns the class type that is a direct supertype of this one.
  55      * This is the superclass of this type's declaring class, with any
  56      * type arguments substituted in.
  57      * The only class with no superclass is <tt>java.lang.Object</tt>,
  58      * for which this method returns <tt>null</tt>.
  59      *
  60      * <p> For example, the class type extended by
  61      * {@code java.util.TreeSet<String>} is
  62      * {@code java.util.AbstractSet<String>}.
  63      *
  64      * @return the class type that is a direct supertype of this one,
  65      * or <tt>null</tt> if there is none
  66      */
  67     ClassType getSuperclass();
  68 }