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