org.lflang.MessageReporterBase Class Reference

Base implementation of the MessageReporter interface. More...

Inherits org.lflang.MessageReporter.

Inherited by org.lflang.DefaultMessageReporter, org.lflang.cli.StandaloneMessageReporter, org.lflang.diagram.synthesis.util.SynthesisMessageReporter, org.lflang.federated.generator.SynchronizedMessageReporter, org.lflang.generator.LanguageServerMessageReporter, and org.lflang.validation.ValidatorMessageReporter.

Public Member Functions
default Stage2	at (Path file)
	Position the message in the file (non-null), at an unknown line.
default Stage2	at (Path file, int line)
	Position the message in the file (non-null), on the given line.
default Stage2	at (Path file, Position pos)
	Position the message in the file, using a position object.
Stage2	at (EObject node)
	Position the message on the given node (must be non-null).
Stage2	at (EObject node, EStructuralFeature feature)
	Position the message on the given node and structural feature (both must be non-null).
Stage2	at (Path file, Range range)
	Position the message on the given range in a given file (both must be non-null).
default Stage2	atNullableLine (Path file, Integer line)
	Position the message in the given file.
void	clearHistory ()
	Clear error history, if exists.
boolean	getErrorsOccurred ()
	Check if errors where reported.
Stage2	nowhere ()
	Specify that the message has no relevant position, ie it does not belong to a particular file.

Protected Member Functions
	MessageReporterBase ()
abstract void	report (Path path, Range range, DiagnosticSeverity severity, String message)
	Implementation of the reporting methods that use a path and range as position.
void	reportOnNode (EObject node, DiagnosticSeverity severity, String message)
	Implementation of the reporting methods that use a node as position.
abstract void	reportOnNode (EObject node, EStructuralFeature feature, DiagnosticSeverity severity, String message)
abstract void	reportWithoutPosition (DiagnosticSeverity severity, String message)
	Implementation of the reporting methods for nowhere().
Stage2	wrap (Stage2 e)
	A wrapper that takes care of setting the error flag if needed.

Detailed Description

Base implementation of the MessageReporter interface.

Constructor & Destructor Documentation

MessageReporterBase()

org.lflang.MessageReporterBase.MessageReporterBase ( )

protected

Member Function Documentation

at() [1/6]

default Stage2 org.lflang.MessageReporter.at ( Path file )

inherited

Position the message in the file (non-null), at an unknown line.

Implementations usually will report on the first line of the file.

at() [2/6]

default Stage2 org.lflang.MessageReporter.at ( Path file, int line )

inherited

Position the message in the file (non-null), on the given line.

Implemented in org.lflang.federated.generator.LineAdjustingMessageReporter, and org.lflang.generator.LanguageServerMessageReporter.

at() [3/6]

default Stage2 org.lflang.MessageReporter.at ( Path file, Position pos )

inherited

Position the message in the file, using a position object.

at() [4/6]

Stage2 org.lflang.MessageReporterBase.at

(

EObject

node

)

Position the message on the given node (must be non-null).

Implements org.lflang.MessageReporter.

at() [5/6]

Stage2 org.lflang.MessageReporterBase.at	(	EObject	node,
		EStructuralFeature	feature )

Position the message on the given node and structural feature (both must be non-null).

Implements org.lflang.MessageReporter.

at() [6/6]

Stage2 org.lflang.MessageReporterBase.at	(	Path	file,
		Range	range )

Position the message on the given range in a given file (both must be non-null).

Implements org.lflang.MessageReporter.

atNullableLine()

default Stage2 org.lflang.MessageReporter.atNullableLine ( Path file, Integer line )

inherited

Position the message in the given file.

The line may be null. This is a convenience wrapper that calls either at(Path, int) or at(Path).

clearHistory()

void org.lflang.MessageReporterBase.clearHistory

(

)

Clear error history, if exists.

This is usually only the case for error markers in Epoch (Eclipse).

Implements org.lflang.MessageReporter.

getErrorsOccurred()

boolean org.lflang.MessageReporterBase.getErrorsOccurred

(

)

Check if errors where reported.

Returns

true if errors where reported

Implements org.lflang.MessageReporter.

Reimplemented in org.lflang.cli.StandaloneMessageReporter, org.lflang.federated.generator.SynchronizedMessageReporter, and org.lflang.generator.LanguageServerMessageReporter.

nowhere()

Stage2 org.lflang.MessageReporterBase.nowhere

(

)

Specify that the message has no relevant position, ie it does not belong to a particular file.

Implements org.lflang.MessageReporter.

report()

abstract void org.lflang.MessageReporterBase.report ( Path path, Range range, DiagnosticSeverity severity, String message )

abstractprotected

Implementation of the reporting methods that use a path and range as position.

Reimplemented in org.lflang.cli.StandaloneMessageReporter, org.lflang.DefaultMessageReporter, org.lflang.diagram.synthesis.util.SynthesisMessageReporter, org.lflang.federated.generator.SynchronizedMessageReporter, and org.lflang.validation.ValidatorMessageReporter.

reportOnNode() [1/2]

void org.lflang.MessageReporterBase.reportOnNode ( EObject node, DiagnosticSeverity severity, String message )

protected

Implementation of the reporting methods that use a node as position.

reportOnNode() [2/2]

abstract void org.lflang.MessageReporterBase.reportOnNode ( EObject node, EStructuralFeature feature, DiagnosticSeverity severity, String message )

abstractprotected

Reimplemented in org.lflang.cli.StandaloneMessageReporter, org.lflang.DefaultMessageReporter, org.lflang.diagram.synthesis.util.SynthesisMessageReporter, org.lflang.federated.generator.SynchronizedMessageReporter, org.lflang.generator.LanguageServerMessageReporter, and org.lflang.validation.ValidatorMessageReporter.

reportWithoutPosition()

abstract void org.lflang.MessageReporterBase.reportWithoutPosition ( DiagnosticSeverity severity, String message )

abstractprotected

Implementation of the reporting methods for nowhere().

Reimplemented in org.lflang.cli.StandaloneMessageReporter, org.lflang.DefaultMessageReporter, org.lflang.diagram.synthesis.util.SynthesisMessageReporter, org.lflang.federated.generator.SynchronizedMessageReporter, org.lflang.generator.LanguageServerMessageReporter, and org.lflang.validation.ValidatorMessageReporter.

wrap()

Stage2 org.lflang.MessageReporterBase.wrap ( Stage2 e )

protected

A wrapper that takes care of setting the error flag if needed.

---

The documentation for this class was generated from the following file:

• /Users/runner/work/lingua-franca/lingua-franca/core/src/main/java/org/lflang/MessageReporterBase.java