001/* 002 * SonarQube 003 * Copyright (C) 2009-2016 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * This program is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * This program is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public License 017 * along with this program; if not, write to the Free Software Foundation, 018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 019 */ 020package org.sonar.api.batch.debt; 021 022import javax.annotation.CheckForNull; 023 024import java.util.List; 025 026/** 027 * This class can be used to retrieve characteristics or sub-characteristics from the technical debt model during analysis. 028 * 029 * Unfortunately, this class cannot be used to set characteristic on {@link org.sonar.api.measures.Measure}, 030 * because the Measure API still uses deprecated {@link org.sonar.api.technicaldebt.batch.Characteristic}. 031 * 032 * @since 4.3 033 * @deprecated since 5.1 debt model will soon be unavailable on batch side 034 */ 035@Deprecated 036public interface DebtModel { 037 038 /** 039 * Return only characteristics 040 */ 041 List<DebtCharacteristic> characteristics(); 042 043 /** 044 * Return sub-characteristics of a characteristic 045 */ 046 List<DebtCharacteristic> subCharacteristics(String characteristicKey); 047 048 /** 049 * Return characteristics and sub-characteristics 050 */ 051 List<DebtCharacteristic> allCharacteristics(); 052 053 /** 054 * Return a characteristic or a sub-characteristic by a key 055 */ 056 @CheckForNull 057 DebtCharacteristic characteristicByKey(String key); 058 059}