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