Package org.eclipse.xtext.diagnostics

Interface Diagnostic

All Superinterfaces:

org.eclipse.emf.ecore.resource.Resource.Diagnostic

All Known Implementing Classes:

AbstractDiagnostic, EObjectDiagnosticImpl, ExceptionDiagnostic, TransformationDiagnostic, XtextLinkingDiagnostic, XtextSyntaxDiagnostic, XtextSyntaxDiagnosticWithRange

public interface Diagnostic
extends org.eclipse.emf.ecore.resource.Resource.Diagnostic

A specialized Resource.Diagnostic that knows about the region in the document, e.g. the getOffset() and getLength() of the issue source. A region starts in a start line before a start column and ends in an end line before an end column. Implementors should inherit from AbstractDiagnostic instead of implementing this interface directly.

See Also:

XtextLinkingDiagnostic, XtextSyntaxDiagnostic, ExceptionDiagnostic

Noimplement:

This interface is not intended to be implemented by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LINKING_DIAGNOSTIC
static java.lang.String	SYNTAX_DIAGNOSITC	Deprecated. use SYNTAX_DIAGNOSTIC instead.
static java.lang.String	SYNTAX_DIAGNOSTIC
static java.lang.String	SYNTAX_DIAGNOSTIC_WITH_RANGE

Method Summary

Modifier and Type	Method	Description
int	getColumnEnd()	Returns the end column location of the issue within the source.
int	getLength()	Returns the length of this diagnostic.
int	getLineEnd()	Returns the end line location of the issue within the source.
int	getOffset()	Returns the offset of this diagnostic.

Methods inherited from interface org.eclipse.emf.ecore.resource.Resource.Diagnostic

getColumn, getLine, getLocation, getMessage

Field Detail

SYNTAX_DIAGNOSTIC

static final java.lang.String SYNTAX_DIAGNOSTIC

Since:

2.1

See Also:

Constant Field Values

SYNTAX_DIAGNOSTIC_WITH_RANGE

static final java.lang.String SYNTAX_DIAGNOSTIC_WITH_RANGE

Since:

2.7

See Also:

Constant Field Values

SYNTAX_DIAGNOSITC

@Deprecated
static final java.lang.String SYNTAX_DIAGNOSITC

Deprecated.

use SYNTAX_DIAGNOSTIC instead.

See Also:

Constant Field Values

LINKING_DIAGNOSTIC

static final java.lang.String LINKING_DIAGNOSTIC

See Also:

Constant Field Values

Method Detail

getOffset

int getOffset()

Returns the offset of this diagnostic.

Returns:

the offset of this diagnostic.

getLength

int getLength()

Returns the length of this diagnostic.

Returns:

the length of this diagnostic.

getLineEnd

int getLineEnd()

Returns the end line location of the issue within the source. Line 1 is the first line of a document.

Returns:

the end line location of the issue.

Since:

2.21

getColumnEnd

int getColumnEnd()

Returns the end column location of the issue within the source. The region does not include the end column character itself. Column 1 is the first column of a line.

Returns:

the end column location of the issue.

Since:

2.21