org.eclipse.xtext.nodemodel
Class SyntaxErrorMessage

java.lang.Object
  org.eclipse.xtext.nodemodel.SyntaxErrorMessage

public class SyntaxErrorMessage
extends java.lang.Object

A syntax error message represents a parsing problem. May be produced due to parser or lexer errors.

Author:

Sebastian Zarnekow - Initial contribution and API

See Also:

ISyntaxErrorMessageProvider

Constructor Summary

SyntaxErrorMessage(java.lang.String message, java.lang.String issueCode)

SyntaxErrorMessage(java.lang.String message, java.lang.String issueCode, java.lang.String[] issueData)

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getIssueCode()
java.lang.String[]	getIssueData()
java.lang.String	getMessage()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SyntaxErrorMessage

public SyntaxErrorMessage(java.lang.String message,
                          java.lang.String issueCode)

SyntaxErrorMessage

public SyntaxErrorMessage(java.lang.String message,
                          java.lang.String issueCode,
                          java.lang.String[] issueData)

Parameters:

message - the error message. May not be null.

issueCode - the issue code used to associate quick fixes with this error. May be null.

issueData - the issue data. Be careful to not modify the array after passing it to the constructor since it will not create a pessimistic copy. May be null.

Method Detail

getIssueCode

public java.lang.String getIssueCode()

Returns:

the issue code. May be null.

getMessage

public java.lang.String getMessage()

Returns:

the error message. Never null.

getIssueData

public java.lang.String[] getIssueData()

Returns:

the issue data. May be null. Callers should not modify the array since it is no pessimistic copy.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object