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