org.eclipse.xtext.validation

Interface Issue

All Known Implementing Classes:

Issue.IssueImpl

public interface Issue

Noextend:

This interface is not intended to be extended by clients.

Noimplement:

This interface is not intended to be implemented by clients.

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 java.lang.String	CODE_KEY
static java.lang.String	COLUMN_KEY
static java.lang.String	DATA_KEY
static java.lang.String	URI_KEY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode()
java.lang.Integer	getColumn() Returns the column in the line of the issue.
java.lang.Integer	getColumnEnd() Returns the end column in the line of the issue.
java.lang.String[]	getData()
java.lang.Integer	getLength()
java.lang.Integer	getLineNumber() Returns the one-based line number of the issue.
java.lang.Integer	getLineNumberEnd() Returns the one-based line number of the end of the issue.
java.lang.String	getMessage()
java.lang.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 java.lang.String CODE_KEY

See Also:

Constant Field Values

URI_KEY

static final java.lang.String URI_KEY

See Also:

Constant Field Values

COLUMN_KEY

static final java.lang.String COLUMN_KEY

Since:

2.9

See Also:

Constant Field Values

DATA_KEY

static final java.lang.String DATA_KEY

See Also:

Constant Field Values

Method Detail

getSeverity

Severity getSeverity()

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

getMessage

java.lang.String getMessage()

getCode

java.lang.String getCode()

getType

CheckType getType()

getUriToProblem

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

getLineNumber

java.lang.Integer getLineNumber()

Returns the one-based line number of the issue. Values smaller than 1 and null values are invalid and indicate the absence of line information on this issue.

getLineNumberEnd

java.lang.Integer getLineNumberEnd()

Returns the one-based line number of the end of the issue. Values smaller than 1 and null values are invalid and indicate the absence of line information on this issue.

Since:

2.21

getColumn

java.lang.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. Values smaller than 1 and null values are invalid and indicate the absence of column information on this issue. The region defined by line and column information includes the character at the start column.

Since:

2.9

getColumnEnd

java.lang.Integer getColumnEnd()

Returns the end column in the line of the issue. It's not the virtual end column but literally the character end 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. Values smaller than 1 and null values are invalid and indicate the absence of column information on this issue. The region defined by line and column information does not include the character at the end column.

Since:

2.21

getOffset

java.lang.Integer getOffset()

getLength

java.lang.Integer getLength()

isSyntaxError

boolean isSyntaxError()

getData

java.lang.String[] getData()

Returns:

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