Module xl.compiler

Package de.grogra.xl.compiler.diagnostics

Class XLDiagnostic

java.lang.Object

java.lang.Throwable

java.lang.Exception

antlr.ANTLRException

antlr.RecognitionException

de.grogra.grammar.RecognitionException

de.grogra.grammar.SemanticException

de.grogra.xl.compiler.diagnostics.XLDiagnostic

All Implemented Interfaces:

DetailedException, Disposable, UserException, Serializable, Comparable<RecognitionException>

public final class XLDiagnostic
extends SemanticException

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	XLDiagnostic.RelatedRange
static final class	XLDiagnostic.SourceRange

Field Summary

Fields

Modifier and Type	Field	Description
static final long	XL16U_WARNING

Fields inherited from class de.grogra.grammar.RecognitionException

IS_ERROR, MIN_UNUSED, warningBits

Fields inherited from class antlr.RecognitionException

column, fileName, line

Constructor Summary

Constructors

Constructor	Description
XLDiagnostic(XLDiagnosticSeverity severity, String ruleId, String categoryId, String explanation, String hint, String normalizedDetails)
XLDiagnostic(XLDiagnosticSeverity severity, String ruleId, String diagnosticCode, String categoryId, String explanation, String hint, String normalizedDetails, XLDiagnostic.SourceRange primaryRange, List<XLDiagnostic.RelatedRange> relatedRanges, String provenance)

Method Summary

Modifier and Type	Method	Description
String	getCategoryDescription()
String	getCategoryId()
String	getDetailedMessage(boolean html)
String	getDiagnosticCode()
String	getExplanation()
String	getHint()
String	getNormalizedDetails()
XLDiagnostic.SourceRange	getPrimaryRange()
String	getProvenance()
List<XLDiagnostic.RelatedRange>	getRelatedRanges()
String	getRuleId()
XLDiagnosticSeverity	getSeverity()
boolean	hasExplanation()
boolean	hasNormalizedDetails()
boolean	hasPrimaryRange()
boolean	hasProvenance()
boolean	hasRelatedRanges()
static XLDiagnostic.RelatedRange	relatedRange(String label, int start, int end)
static XLDiagnostic.SourceRange	sourceRange(int start, int end)

Methods inherited from class de.grogra.grammar.RecognitionException

compareTo, complete, convert, dispose, getColumn, getDetailedMessage, getLine, isError, set, set, set, set, set

Methods inherited from class antlr.RecognitionException

getErrorMessage, getFilename, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

XL16U_WARNING

public static final long XL16U_WARNING

See Also:

• Constant Field Values

Constructor Details

XLDiagnostic

public XLDiagnostic(XLDiagnosticSeverity severity,
 String ruleId,
 String categoryId,
 String explanation,
 String hint,
 String normalizedDetails)

XLDiagnostic

public XLDiagnostic(XLDiagnosticSeverity severity,
 String ruleId,
 String diagnosticCode,
 String categoryId,
 String explanation,
 String hint,
 String normalizedDetails,
 XLDiagnostic.SourceRange primaryRange,
 List<XLDiagnostic.RelatedRange> relatedRanges,
 String provenance)

Method Details

getSeverity

public XLDiagnosticSeverity getSeverity()

getRuleId

public String getRuleId()

getDiagnosticCode

public String getDiagnosticCode()

getCategoryId

public String getCategoryId()

getExplanation

public String getExplanation()

hasExplanation

public boolean hasExplanation()

getHint

public String getHint()

getNormalizedDetails

public String getNormalizedDetails()

hasNormalizedDetails

public boolean hasNormalizedDetails()

getPrimaryRange

public XLDiagnostic.SourceRange getPrimaryRange()

hasPrimaryRange

public boolean hasPrimaryRange()

getRelatedRanges

public List<XLDiagnostic.RelatedRange> getRelatedRanges()

hasRelatedRanges

public boolean hasRelatedRanges()

getProvenance

public String getProvenance()

hasProvenance

public boolean hasProvenance()

getCategoryDescription

public String getCategoryDescription()

Overrides:

getCategoryDescription in class SemanticException

getDetailedMessage

public String getDetailedMessage(boolean html)

Specified by:

getDetailedMessage in interface DetailedException

Overrides:

getDetailedMessage in class RecognitionException

sourceRange

public static XLDiagnostic.SourceRange sourceRange(int start,
 int end)

relatedRange

public static XLDiagnostic.RelatedRange relatedRange(String label,
 int start,
 int end)