org.lflang.diagram.lsp.Progress Class Reference

A class for reporting the progress of an ongoing task. More...

Public Member Functions
void	begin ()
	Report that the task tracked by this is done.
void	end (String message)
	Mark the task tracked by this as terminated.
CancelIndicator	getCancelIndicator ()
	Return the cancel indicator for the task tracked by this Progress.
	Progress (LanguageClient client, String title, boolean cancellable)
	Initialize the Progress of a task titled title that is triggered via client.
void	report (String message, Integer percentage)
	Report the progress of the task tracked by this.

Static Public Member Functions
static void	cancel (int token)
	Cancel the task tracked by the Progress that has token token.

Detailed Description

A class for reporting the progress of an ongoing task.

Author

Peter Donovan

Constructor & Destructor Documentation

Progress()

org.lflang.diagram.lsp.Progress.Progress	(	LanguageClient	client,
		String	title,
		boolean	cancellable )

Initialize the Progress of a task titled title that is triggered via client.

Parameters

client	A language client through which a task was triggered.
title	The title of the task.
cancellable	Whether the task tracked by this can be cancelled.

Member Function Documentation

begin()

void org.lflang.diagram.lsp.Progress.begin

(

)

Report that the task tracked by this is done.

cancel()

void org.lflang.diagram.lsp.Progress.cancel ( int token )

static

Cancel the task tracked by the Progress that has token token.

end()

void org.lflang.diagram.lsp.Progress.end

(

String

message

)

Mark the task tracked by this as terminated.

Parameters

message

A message describing the outcome of the task.

getCancelIndicator()

CancelIndicator org.lflang.diagram.lsp.Progress.getCancelIndicator

(

)

Return the cancel indicator for the task tracked by this Progress.

Returns

the cancel indicator for the task tracked by this Progress

report()

void org.lflang.diagram.lsp.Progress.report	(	String	message,
		Integer	percentage )

Report the progress of the task tracked by this.

Parameters

message	A message describing the progress of the task.
percentage	The percentage of completion (0-100).

---

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

• /Users/runner/work/lingua-franca/lingua-franca/lsp/src/main/java/org/lflang/diagram/lsp/Progress.java