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 */
020package org.sonar.api.batch.sensor.issue;
021
022import com.google.common.annotations.Beta;
023import javax.annotation.CheckForNull;
024import org.sonar.api.batch.fs.InputComponent;
025import org.sonar.api.batch.fs.TextRange;
026
027/**
028 * Represents an issue location.
029 *
030 * @since 5.2
031 */
032@Beta
033public interface IssueLocation {
034
035  /**
036   * The {@link InputComponent} this location belongs to.
037   */
038  InputComponent inputComponent();
039
040  /**
041   * Range of the issue. Null for global issues and issues on directories. Can also be null
042   * for files (issue global to the file).
043   */
044  @CheckForNull
045  TextRange textRange();
046
047  /**
048   * Message of the issue.
049   */
050  @CheckForNull
051  String message();
052
053}