001 /* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2014 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * SonarQube 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 * SonarQube 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 */ 020 021 package org.sonar.api.batch.debt; 022 023 import javax.annotation.CheckForNull; 024 025 import java.util.List; 026 027 /** 028 * This class can be used to retrieve characteristics or sub-characteristics from the technical debt model during analysis. 029 * 030 * Unfortunately, this class cannot be used to set characteristic on {@link org.sonar.api.measures.Measure}, 031 * because the Measure API still uses deprecated {@link org.sonar.api.technicaldebt.batch.Characteristic}. 032 * 033 * @since 4.3 034 */ 035 public interface DebtModel { 036 037 /** 038 * Return only characteristics 039 */ 040 List<DebtCharacteristic> characteristics(); 041 042 /** 043 * Return sub-characteristics of a characteristic 044 */ 045 List<DebtCharacteristic> subCharacteristics(String characteristicKey); 046 047 /** 048 * Return characteristics and sub-characteristics 049 */ 050 List<DebtCharacteristic> allCharacteristics(); 051 052 /** 053 * Return a characteristic or a sub-characteristic by a key 054 */ 055 @CheckForNull 056 DebtCharacteristic characteristicByKey(String key); 057 058 }