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.error;
021
022import org.sonar.api.batch.fs.InputFile;
023import org.sonar.api.batch.fs.TextPointer;
024import org.sonar.api.batch.sensor.Sensor;
025
026/**
027 * Represents an analysis error, such as a parsing error, that occurs during the execution of a {@link Sensor}.
028 * Multiple analysis errors might be reported for the same file and issues may be created for a file which also has analysis errors reported. 
029 * The handling of such situations is unspecified and might vary depending on the implementation.
030 * 
031 * @since 6.0
032 */
033public interface NewAnalysisError {
034  /**
035   * The file that was being processed when the error occurred. This field must be set before saving the error.
036   */
037  NewAnalysisError onFile(InputFile inputFile);
038
039  /**
040   * Message about the error. This field is optional.
041   */
042  NewAnalysisError message(String message);
043
044  /**
045   * Location of this error. This field is optional.
046   */
047  NewAnalysisError at(TextPointer location);
048
049  /**
050   * Save this error information.
051   */
052  void save();
053}