org.sonar.plugins.php.api.symbols.Symbol Maven / Gradle / Ivy

Go to download
/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010-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.php.api.symbols;

import java.util.List;
import javax.annotation.Nullable;
import org.sonar.plugins.php.api.tree.expression.IdentifierTree;
import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;

public interface Symbol {
  List modifiers();

  boolean hasModifier(String modifier);

  List usages();

  String name();

  /**
   * @return qualified name for class, function, method or class constant, null otherwise
   */
  @Nullable
  QualifiedName qualifiedName();

  IdentifierTree declaration();

  boolean is(Kind kind);

  boolean called(String name);

  Kind kind();

  enum Kind {
    VARIABLE,
    FUNCTION,
    PARAMETER,
    CLASS,
    FIELD;

    public boolean hasQualifiedName() {
      return this == CLASS || this == FUNCTION || this == FIELD;
    }
  }
}