org.eclipse.xtext.validation

Interface Issue

All Known Implementing Classes:

Issue.IssueImpl

public interface Issue

Author:

Sven Efftinge - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Issue.IssueImpl

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE_KEY
static String	COLUMN_KEY
static String	DATA_KEY
static String	URI_KEY

Method Summary

Methods

Modifier and Type	Method and Description
String	getCode()
Integer	getColumn() Returns the column in the line of the issue.
String[]	getData()
Integer	getLength()
Integer	getLineNumber() Returns the one-based line number of the issue.
String	getMessage()
Integer	getOffset()
Severity	getSeverity() Returns the severity of the issue.
CheckType	getType()
org.eclipse.emf.common.util.URI	getUriToProblem()
boolean	isSyntaxError()

Field Detail

CODE_KEY

static final String CODE_KEY

See Also:

Constant Field Values

URI_KEY

static final String URI_KEY

See Also:

Constant Field Values

COLUMN_KEY

static final String COLUMN_KEY

Since:

2.9

See Also:

Constant Field Values

DATA_KEY

static final String DATA_KEY

See Also:

Constant Field Values

Method Detail

getSeverity

Severity getSeverity()

Returns the severity of the issue. Defaults to Severity.ERROR.

getMessage

String getMessage()

getCode

String getCode()

getType

CheckType getType()

getUriToProblem

org.eclipse.emf.common.util.URI getUriToProblem()

getLineNumber

Integer getLineNumber()

Returns the one-based line number of the issue.

getColumn

Integer getColumn()

Returns the column in the line of the issue. It's not the virtual column but literally the character offset in the column, e.g. tab ('\t') counts as one character. The first char in a line has column number 1, the number is one-based. If no column information is available, returns -1.

Since:

2.9

getOffset

Integer getOffset()

getLength

Integer getLength()

isSyntaxError

boolean isSyntaxError()

getData

String[] getData()

Returns:

the associated user data. May be null or empty but may not contain null entries.