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 org.sonar.api.batch.fs.InputComponent;
023import org.sonar.api.batch.fs.InputFile;
024import org.sonar.api.batch.fs.TextRange;
025
026/**
027 * Represents one issue location. See {@link NewIssue#newLocation()}.
028 *
029 * @since 5.2
030 */
031public interface NewIssueLocation {
032
033  /**
034   * Maximum number of characters in the message.
035   */
036  int MESSAGE_MAX_SIZE = 4000;
037
038  /**
039   * The {@link InputComponent} the issue location belongs to. Mandatory.
040   */
041  NewIssueLocation on(InputComponent component);
042
043  /**
044   * Position in the file. Only applicable when {@link #on(InputComponent)} has been called with an InputFile. 
045   * See {@link InputFile#newRange(org.sonar.api.batch.fs.TextPointer, org.sonar.api.batch.fs.TextPointer)}
046   */
047  NewIssueLocation at(TextRange location);
048
049  /**
050   * Optional, but recommended, plain-text message for this location.
051   * <br>
052   * Formats like Markdown or HTML are not supported. Size must not be greater than {@link #MESSAGE_MAX_SIZE} characters.
053   */
054  NewIssueLocation message(String message);
055
056}