org.sonar.api.batch.debt.DebtModel Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.batch.debt;

import javax.annotation.CheckForNull;

import java.util.List;

/**
 * This class can be used to retrieve characteristics or sub-characteristics from the technical debt model during analysis.
 *
 * Unfortunately, this class cannot be used to set characteristic on {@link org.sonar.api.measures.Measure},
 * because the Measure API still uses deprecated {@link org.sonar.api.technicaldebt.batch.Characteristic}.
 *
 * @since 4.3
 */
public interface DebtModel {

  /**
   * Return only characteristics
   */
  List characteristics();

  /**
   * Return sub-characteristics of a characteristic
   */
  List subCharacteristics(String characteristicKey);

  /**
   * Return characteristics and sub-characteristics
   */
  List allCharacteristics();

  /**
   * Return a characteristic or a sub-characteristic by a key
   */
  @CheckForNull
  DebtCharacteristic characteristicByKey(String key);

}