Package org.sonar.api.batch.sensor.issue

Interface NewIssueLocation

public interface NewIssueLocation

Represents one issue location. See NewIssue.newLocation().

Since:

5.2

Field Summary

Fields

Modifier and Type	Field	Description
static int	MESSAGE_MAX_SIZE	Maximum number of characters in the message.

Method Summary

Modifier and Type	Method	Description
NewIssueLocation	at(TextRange location)	Position in the file.
NewIssueLocation	message(java.lang.String message)	Optional, but recommended, plain-text message for this location.
NewIssueLocation	message(java.lang.String message, java.util.List<NewMessageFormatting> newMessageFormatting)	Optional, message that can be formatted on the frontend. Formats like Markdown or HTML are not supported.
NewMessageFormatting	newMessageFormatting()	Creates new instance of NewMessageFormatting
NewIssueLocation	on(InputComponent component)	The InputComponent the issue location belongs to.

Field Detail

MESSAGE_MAX_SIZE

static final int MESSAGE_MAX_SIZE

Maximum number of characters in the message.

See Also:

Constant Field Values

Method Detail

on

NewIssueLocation on(InputComponent component)

The InputComponent the issue location belongs to. Mandatory.

at

NewIssueLocation at(TextRange location)

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

message

NewIssueLocation message(java.lang.String message)

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

message

NewIssueLocation message(java.lang.String message,
                         java.util.List<NewMessageFormatting> newMessageFormatting)

Optional, message that can be formatted on the frontend.
Formats like Markdown or HTML are not supported. Size must not be greater than MESSAGE_MAX_SIZE characters.
throws IllegalArgumentException if any of the NewMessageFormatting instances passed in the newMessageFormatting is that:
- start is lesser than 0
- end is lesser than start
- end is greater than the size of message

Since:

9.13

newMessageFormatting

NewMessageFormatting newMessageFormatting()

Creates new instance of NewMessageFormatting

Returns:

builder for NewMessageFormatting

Since:

9.13