org.sonar.plugins.java.api.tree.ClassTree Maven / Gradle / Ivy

Go to download
/*
 * SonarQube Java
 * Copyright (C) 2012-2023 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.java.api.tree;

import org.sonar.java.annotations.Beta;
import org.sonar.plugins.java.api.semantic.Symbol;

import javax.annotation.Nullable;

import java.util.List;

/**
 * Class, enum, interface or annotation declaration.
 * 
 * JLS 8.1. Class declaration ({@link Tree.Kind#CLASS}):
 * 
 *   {@link #modifiers()} class {@link #simpleName()} {@link #typeParameters()} extends {@link #superClass()} implements {@link #superInterfaces()} {
 *     {@link #members()}
 *   }
 * 
 * JLS 8.9. Enum declaration ({@link Tree.Kind#ENUM}):
 *  *   {@link #modifiers()} enum {@link #simpleName()} {@link #typeParameters()} implements {@link #superInterfaces()} {
 *     {@link #members()}
 *   }
 * 
 * JLS 8.10 Record declaration ({@link Tree.Kind#RECORD}):
 *  *   {@link #modifiers()} record {@link #simpleName()} {@link #typeParameters()} ({@link #recordComponents()}) implements {@link #superInterfaces()} {
 *     {@link #members()}
 *   }
 * 
 * JLS 9.1. Interface declaration ({@link Tree.Kind#INTERFACE}):
 *  *   {@link #modifiers()} interface {@link #simpleName()} {@link #typeParameters()} extends {@link #superInterfaces()} {
 *     {@link #members()}
 *   }
 * 
 * JLS 9.6. Annotation declaration ({@link Tree.Kind#ANNOTATION_TYPE}):
 *  *   {@link #modifiers()}{@code @}interface {@link #simpleName()} {
 *     {@link #members()}
 *   }
 * 
 * 
 *
 * @since Java 1.3
 */
@Beta
public interface ClassTree extends StatementTree {

  @Nullable
  SyntaxToken declarationKeyword();

  @Nullable
  IdentifierTree simpleName();

  TypeParameters typeParameters();

  /**
   * @since Java 16
   */
  @Nullable
  SyntaxToken recordOpenParenToken();

  List recordComponents();

  @Nullable
  SyntaxToken recordCloseParenToken();

  ModifiersTree modifiers();

  @Nullable
  TypeTree superClass();

  ListTree superInterfaces();

  /**
   * @since Java 15 (preview), Java 17 (final)
   */
  @Nullable
  SyntaxToken permitsKeyword();

  /**
   * @since Java 15 (preview), Java 17 (final)
   */
  ListTree permittedTypes();

  SyntaxToken openBraceToken();

  List members();

  SyntaxToken closeBraceToken();

  Symbol.TypeSymbol symbol();
}