org.sonar.api.batch.sensor.error

Interface NewAnalysisError

All Known Implementing Classes:

DefaultAnalysisError

public interface NewAnalysisError

Represents an analysis error, such as a parsing error, that occurs during the execution of a Sensor. Multiple analysis errors might be reported for the same file and issues may be created for a file which also has analysis errors reported. The handling of such situations is unspecified and might vary depending on the implementation.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
NewAnalysisError	at(TextPointer location) Location of this error.
NewAnalysisError	message(String message) Message about the error.
NewAnalysisError	onFile(InputFile inputFile) The file that was being processed when the error occurred.
void	save() Save this error information.

Method Detail

onFile

NewAnalysisError onFile(InputFile inputFile)

The file that was being processed when the error occurred. This field must be set before saving the error.

message

NewAnalysisError message(String message)

Message about the error. This field is optional.

at

NewAnalysisError at(TextPointer location)

Location of this error. This field is optional.

save

void save()

Save this error information.