org.sonar.plugins.java.api.tree.CaseLabelTree 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 java.util.List;

/**
 * 'case' label in a 'switch' statement.
 *
 * JLS 14.11
 *
 *  *   case {@link #expression()} :
 *   default :
 * 
 *
 * @since Java 1.3
 *
 *  *   case {@link #expressions()} :
 *   case {@link #expressions()} ->
 *   default ->
 * 
 *
 * @since Java 12 (SonarJava 5.12 - Support of Java 12)
 */
@Beta
public interface CaseLabelTree extends Tree {

  SyntaxToken caseOrDefaultKeyword();

  /**
   * @return true for case with colon: "case 3:" or "default:"
   *         false for case with arrow: "case 3 ->" or "default ->"
   * @since SonarJava 5.12: Support of Java 12
   */
  boolean isFallThrough();

  /**
   * @since SonarJava 5.12: Support of Java 12
   */
  List expressions();

  /**
   * @since SonarJava 5.12: Support of Java 12
   */
  SyntaxToken colonOrArrowToken();

}