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.server.debt;
022    
023    import org.sonar.api.ServerComponent;
024    
025    import java.util.List;
026    
027    /**
028     * @since 4.3
029     */
030    public interface DebtModel extends ServerComponent {
031    
032      /**
033       * @return all characteristics
034       */
035      List<DebtCharacteristic> allCharacteristics();
036    
037      /**
038       * @return only characteristics of highest level
039       */
040      List<DebtCharacteristic> characteristics();
041    
042      /**
043       * Return a characteristic or a sub-characteristic by its key
044       */
045      DebtCharacteristic characteristicByKey(String key);
046    
047    }