Class WorkDoneProgressHelper

java.lang.Object

com.github._1c_syntax.bsl.languageserver.client.WorkDoneProgressHelper

@Component
public class WorkDoneProgressHelper
extends Object

Помощник для работы с progress-уведомлениями LSP.

Управляет созданием и обновлением индикаторов прогресса выполнения длительных операций (WorkDoneProgress).

Индикатор, начатый до того, как клиент готов их показывать (handleEvent(ClientInitializedEvent)), клиенту не отправляется, а только запоминается: создать индикатор по запросу сервера клиент может лишь после уведомления initialized — раньше запрос window/workDoneProgress/create ему нечем обработать, и индикатор теряется. Когда клиент готов, индикаторы, ещё не законченные к этому моменту, создаются у него с текущим состоянием; законченные раньше не показываются вовсе.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	WorkDoneProgressHelper.WorkDoneProgressReporter

Constructor Summary

Constructors

Constructor	Description
WorkDoneProgressHelper(LanguageClientHolder languageClientHolder, ClientCapabilitiesHolder clientCapabilitiesHolder)

Method Summary

Modifier and Type	Method	Description
WorkDoneProgressHelper.WorkDoneProgressReporter	createProgress(int size, String messagePostfix)
void	handleEvent(ClientInitializedEvent event)	Клиент готов показывать индикаторы — пришло уведомление initialized.

Methods inherited from class Object

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

Constructor Details

WorkDoneProgressHelper

@ConstructorProperties({"languageClientHolder","clientCapabilitiesHolder"})
public WorkDoneProgressHelper(LanguageClientHolder languageClientHolder,
 ClientCapabilitiesHolder clientCapabilitiesHolder)

Method Details

createProgress

public WorkDoneProgressHelper.WorkDoneProgressReporter createProgress(int size,
 String messagePostfix)

handleEvent

@EventListener
public void handleEvent(ClientInitializedEvent event)

Клиент готов показывать индикаторы — пришло уведомление initialized.

Индикаторы, начатые раньше и ещё не законченные, создаются у клиента с текущим состоянием; новые создаются сразу.

Parameters:

event - событие окончания инициализации клиента.