001/* 002 * SonarQube 003 * Copyright (C) 2009-2017 SonarSource SA 004 * mailto:info 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.ce.measure; 021 022import javax.annotation.CheckForNull; 023 024/** 025 * Component that can be used in a {@link MeasureComputer} 026 * 027 * @since 5.2 028 */ 029public interface Component { 030 031 enum Type { 032 PROJECT, MODULE, DIRECTORY, FILE, VIEW, SUBVIEW 033 } 034 035 Type getType(); 036 037 String getKey(); 038 039 /** 040 * The attributes of the Component if it's type is File. 041 * 042 * @throws IllegalStateException if the Component's type is not {@link Type#FILE} 043 */ 044 FileAttributes getFileAttributes(); 045 046 interface FileAttributes { 047 048 boolean isUnitTest(); 049 050 @CheckForNull 051 String getLanguageKey(); 052 053 } 054}