org.sonar.api.resources.Qualifiers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation
The newest version!
/*
 * SonarQube
 * Copyright (C) 2009-2022 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.api.resources;

import java.util.List;

import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;

/**
 * The qualifier determines the exact type of a resource.
 * Plugins can define their own qualifiers.
 *
 * @since 2.6
 */
public final class Qualifiers {

  /**
   * Root portfolios. Scope of portfolios is Scopes.PROJECT
   */
  public static final String VIEW = "VW";

  /**
   * Sub-portfolios, defined in root portfolios. Scope of sub-portfolios is Scopes.PROJECT
   */
  public static final String SUBVIEW = "SVW";

  /**
   * Application portfolios. Scope of application is Scopes.PROJECT
   */
  public static final String APP = "APP";

  /**
   * Library, for example a JAR dependency of Java projects.
   * Scope of libraries is Scopes.PROJECT
   * @deprecated since 5.2 No more design features
   */
  @Deprecated
  public static final String LIBRARY = "LIB";

  /**
   * Project
   * Scope is Scopes.PROJECT
   */
  public static final String PROJECT = "TRK";

  /**
   * Module of a multi-modules project. It's sometimes called "sub-project".
   * Scope of modules is Scopes.PROJECT
   *
   * @deprecated since 7.7 as modules doesn't exist anymore
   */
  @Deprecated
  public static final String MODULE = "BRC";

  public static final String DIRECTORY = "DIR";
  public static final String FILE = "FIL";

  // ugly, should be replaced by "natures"
  public static final String UNIT_TEST_FILE = "UTS";

  /**
   * List of qualifiers, ordered from bottom to up regarding position
   * in tree of components
   *
   * @since 7.0
   */
  public static final List ORDERED_BOTTOM_UP = unmodifiableList(asList(
    FILE, UNIT_TEST_FILE, DIRECTORY, MODULE, PROJECT, APP, SUBVIEW, VIEW));

  private Qualifiers() {
    // only static methods
  }
}