org.sonar.plugins.python.api.tree.Tuple Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of python-frontend Show documentation

The newest version!

/*
 * SonarQube Python Plugin
 * Copyright (C) 2011-2024 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.python.api.tree;

import java.util.List;
import javax.annotation.CheckForNull;

/**
 *  *   ( {@link #elements()} )
 * 
 *
 * or
 *
 *  *   {@link #elements()}
 * 
 *
 * Note that {@code ( a )} is not a tuple, but a parenthesized expression
 *
 *  Examples:
 *  
 *    (a, b)
 *    a, b
 *    a,
 *    (a,)
 *    Empty tuple ()
 *  
 *  See https://docs.python.org/3/library/stdtypes.html?highlight=tuple#tuple
 */
public interface Tuple extends Expression {

  @CheckForNull
  Token leftParenthesis();

  List elements();

  List commas();

  @CheckForNull
  Token rightParenthesis();

}