org.sonar.java.model.JInitializerBlockSymbol 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.java.model;

import java.util.Collections;
import java.util.List;
import org.sonar.plugins.java.api.semantic.Symbol;
import org.sonar.plugins.java.api.semantic.SymbolMetadata;
import org.sonar.plugins.java.api.semantic.Type;
import org.sonar.plugins.java.api.tree.IdentifierTree;
import org.sonar.plugins.java.api.tree.MethodTree;

/**
 * Symbol type to represent initializer blocks. It's a type of method symbol and was introduced, so that variables
 * defined inside an initializer block can have an owner other than the containing class. This is necessary to properly
 * detect them as local variables.
 */
final class JInitializerBlockSymbol implements Symbol.MethodSymbol {
  private final TypeSymbol owner;
  private final boolean isStatic;

  public JInitializerBlockSymbol(TypeSymbol owner, boolean isStatic) {
    this.owner = owner;
    this.isStatic = isStatic;
  }

  @Override
  public MethodTree declaration() {
    return null;
  }

  @Override
  public List parameterTypes() {
    return Collections.emptyList();
  }

  @Override
  public List declarationParameters() {
    return Collections.emptyList();
  }

  @Override
  public Symbol.TypeSymbol returnType() {
    return Symbols.unknownTypeSymbol;
  }

  @Override
  public List thrownTypes() {
    return Collections.emptyList();
  }

  @Override
  public List overriddenSymbols() {
    return Collections.emptyList();
  }

  @Override
  public Symbol owner() {
    return owner;
  }

  @Override
  public Type type() {
    return Symbols.unknownType;
  }

  @Override
  public boolean isVariableSymbol() {
    return false;
  }

  @Override
  public boolean isTypeSymbol() {
    return false;
  }

  @Override
  public boolean isMethodSymbol() {
    return true;
  }

  @Override
  public boolean isPackageSymbol() {
    return false;
  }

  @Override
  public boolean isStatic() {
    return isStatic;
  }

  @Override
  public boolean isFinal() {
    return false;
  }

  @Override
  public boolean isEnum() {
    return false;
  }

  @Override
  public boolean isInterface() {
    return false;
  }

  @Override
  public boolean isAbstract() {
    return false;
  }

  @Override
  public boolean isPublic() {
    return false;
  }

  @Override
  public boolean isPrivate() {
    return false;
  }

  @Override
  public boolean isProtected() {
    return false;
  }

  @Override
  public boolean isPackageVisibility() {
    return false;
  }

  @Override
  public boolean isDeprecated() {
    return false;
  }

  @Override
  public boolean isVolatile() {
    return false;
  }

  @Override
  public boolean isUnknown() {
    return false;
  }

  @Override
  public SymbolMetadata metadata() {
    return Symbols.EMPTY_METADATA;
  }

  @Override
  public TypeSymbol enclosingClass() {
    return owner;
  }

  @Override
  public List usages() {
    return Collections.emptyList();
  }

  @Override
  public String name() {
    return isStatic ? " (initializer block)" : " (initializer block)";
  }

  @Override
  public String signature() {
    return owner.name() + "." + name();
  }

  @Override
  public boolean isOverridable() {
    return false;
  }

  @Override
  public boolean isParametrizedMethod() {
    return false;
  }

  @Override
  public boolean isDefaultMethod() {
    return false;
  }

  @Override
  public boolean isSynchronizedMethod() {
    return false;
  }

  @Override
  public boolean isVarArgsMethod() {
    return false;
  }
}