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.batch.fs;
021
022/**
023 * Common interface for all input components.
024 *
025 * @since 5.2
026 * @see InputFile
027 * @see InputDir
028 * @see InputModule
029 */
030public interface InputComponent {
031
032  /**
033   * Component key shared by all part of SonarQube (batch, server, WS...). 
034   * It doesn't include the branch.
035   */
036  String key();
037
038  /**
039   * Is the component an {@link InputFile}
040   */
041  boolean isFile();
042
043}