org.sonar.api.batch.sensor.issue.internal

Class DefaultIssueLocation

java.lang.Object

org.sonar.api.batch.sensor.issue.internal.DefaultIssueLocation

All Implemented Interfaces:

IssueLocation, NewIssueLocation

public class DefaultIssueLocation
extends Object
implements NewIssueLocation, IssueLocation

Field Summary

Fields inherited from interface org.sonar.api.batch.sensor.issue.NewIssueLocation

MESSAGE_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
DefaultIssueLocation()

Method Summary

Modifier and Type	Method and Description
DefaultIssueLocation	at(TextRange location) Position in the file.
InputComponent	inputComponent() The InputComponent this location belongs to.
String	message() Message of the issue.
DefaultIssueLocation	message(String message) Optional, but recommended, plain-text message for this location.
DefaultIssueLocation	on(InputComponent component) The InputComponent the issue location belongs to.
TextRange	textRange() Range of the issue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultIssueLocation

public DefaultIssueLocation()

Method Detail

on

public DefaultIssueLocation on(InputComponent component)

Description copied from interface: NewIssueLocation

The InputComponent the issue location belongs to. Mandatory.

Specified by:

on in interface NewIssueLocation

at

public DefaultIssueLocation at(TextRange location)

Description copied from interface: NewIssueLocation

Position in the file. Only applicable when NewIssueLocation.on(InputComponent) has been called with an InputFile. See InputFile.newRange(org.sonar.api.batch.fs.TextPointer, org.sonar.api.batch.fs.TextPointer)

Specified by:

at in interface NewIssueLocation

message

public DefaultIssueLocation message(String message)

Description copied from interface: NewIssueLocation

Optional, but recommended, plain-text message for this location.
Formats like Markdown or HTML are not supported. Size must not be greater than NewIssueLocation.MESSAGE_MAX_SIZE characters.

Specified by:

message in interface NewIssueLocation

inputComponent

public InputComponent inputComponent()

Description copied from interface: IssueLocation

The InputComponent this location belongs to.

Specified by:

inputComponent in interface IssueLocation

textRange

public TextRange textRange()

Description copied from interface: IssueLocation

Range of the issue. Null for global issues and issues on directories. Can also be null for files (issue global to the file).

Specified by:

textRange in interface IssueLocation

message

public String message()

Description copied from interface: IssueLocation

Message of the issue.

Specified by:

message in interface IssueLocation