1 /*
   2  * Copyright (c) 2005, 2014, 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  */
  25 
  26 package com.sun.source.tree;
  27 
  28 import java.util.Collections;
  29 import java.util.List;
  30 import javax.lang.model.element.Name;
  31 
  32 /**
  33  * A tree node for a class, interface, enum, or annotation
  34  * type declaration.
  35  *
  36  * For example:
  37  * <pre>
  38  *   <em>modifiers</em> class <em>simpleName</em> <em>typeParameters</em>
  39  *       extends <em>extendsClause</em>
  40  *       implements <em>implementsClause</em>
  41  *   {
  42  *       <em>members</em>
  43  *   }
  44  * </pre>
  45  *
  46  * @jls 8.1 Class Declarations
  47  * @jls 8.9 Enum Types
  48  * @jls 9.1 Interface Declarations
  49  * @jls 9.6 Annotation Types
  50  *
  51  * @author Peter von der Ah&eacute;
  52  * @author Jonathan Gibbons
  53  * @since 1.6
  54  */
  55 public interface ClassTree extends StatementTree {
  56     /**
  57      * Returns the modifiers, including any annotations,
  58      * for this type declaration.
  59      * @return the modifiers
  60      */
  61     ModifiersTree getModifiers();
  62 
  63     /**
  64      * Returns the simple name of this type declaration.
  65      * @return the simple name
  66      */
  67     Name getSimpleName();
  68 
  69     /**
  70      * Returns any type parameters of this type declaration.
  71      * @return the type parameters
  72      */
  73     List<? extends TypeParameterTree> getTypeParameters();
  74 
  75     /**
  76      * Returns the supertype of this type declaration,
  77      * or {@code null} if none is provided.
  78      * @return the supertype
  79      */
  80     Tree getExtendsClause();
  81 
  82     /**
  83      * Returns the interfaces implemented by this type declaration.
  84      * @return the interfaces
  85      */
  86     List<? extends Tree> getImplementsClause();
  87 
  88     /**
  89      * Returns the subtypes permitted by this type declaration.
  90      * @implSpec this implementation returns an empty list
  91      * @return the subtypes
  92      * @since amber
  93      */
  94     @Deprecated(forRemoval=true, since="amber")
  95     @SuppressWarnings("removal")
  96     default List<? extends Tree> getPermitsClause() {
  97         return Collections.emptyList();
  98     }
  99 
 100     /**
 101      * Returns the members declared in this type declaration.
 102      * @return the members
 103      */
 104     List<? extends Tree> getMembers();
 105 }