Package com.github._1c_syntax.bsl.languageserver.providers

Class CodeLensProvider

java.lang.Object

com.github._1c_syntax.bsl.languageserver.providers.CodeLensProvider

@Component
public class CodeLensProvider
extends Object

Провайдер, обрабатывающий запросы textDocument/codeLens, codeLens/resolve, а так же отвечающий за отправку запроса workspace/codeLens/refresh.

See Also:

• CodeLens Request specification.
• CodeLens Resolve Request specification.
• CodeLens Refresh Request specification.

Constructor Summary

Constructors

Constructor	Description
CodeLensProvider(Map<String,CodeLensSupplier<CodeLensData>> codeLensSuppliersById, ObjectProvider<List<CodeLensSupplier<CodeLensData>>> enabledCodeLensSuppliersProvider, LanguageClientHolder clientHolder, ClientCapabilitiesHolder clientCapabilitiesHolder, ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
CodeLensData	extractData(CodeLens codeLens)	Извлечь данные линзы из линзы.
List<CodeLens>	getCodeLens(DocumentContext documentContext)	Получение списка CodeLens в документе.
void	handleEvent(LanguageServerConfigurationChangedEvent event)	Обработчик события LanguageServerConfigurationChangedEvent.
protected void	init()
void	refreshCodeLenses()	Отправить запрос на обновление линз кода.
CodeLens	resolveCodeLens(DocumentContext documentContext, CodeLens unresolved, CodeLensData data)	Провести операцию разрешения линзы (заполнение свойства CodeLens.setCommand(Command)).

Methods inherited from class java.lang.Object

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

Constructor Details

CodeLensProvider

@ConstructorProperties({"codeLensSuppliersById","enabledCodeLensSuppliersProvider","clientHolder","clientCapabilitiesHolder","objectMapper"})
public CodeLensProvider(Map<String,CodeLensSupplier<CodeLensData>> codeLensSuppliersById,
 ObjectProvider<List<CodeLensSupplier<CodeLensData>>> enabledCodeLensSuppliersProvider,
 LanguageClientHolder clientHolder,
 ClientCapabilitiesHolder clientCapabilitiesHolder,
 ObjectMapper objectMapper)

Method Details

init

@PostConstruct
protected void init()

getCodeLens

public List<CodeLens> getCodeLens(DocumentContext documentContext)

Получение списка CodeLens в документе.

Parameters:

documentContext - Контекст документа.

Returns:

Список линз.

resolveCodeLens

public CodeLens resolveCodeLens(DocumentContext documentContext,
 CodeLens unresolved,
 CodeLensData data)

Провести операцию разрешения линзы (заполнение свойства CodeLens.setCommand(Command)).

При разрешении линзы свойство CodeLens.setData(Object) очищается с целью уменьшения трафика между клиентом и сервером.

Parameters:

documentContext - Контекст документа.

unresolved - Неразрешенная линза.

data - Данные линзы.

Returns:

Разрешенная линза.

handleEvent

@EventListener
public void handleEvent(LanguageServerConfigurationChangedEvent event)

Обработчик события LanguageServerConfigurationChangedEvent.

В случае поддержки запроса подключенным клиентом инициирует запрос workspace/codeLens/refresh.

Parameters:

event - Событие

extractData

public CodeLensData extractData(CodeLens codeLens)

Извлечь данные линзы из линзы.

Возвращает объект данных типа, с которым был зарегистрирован сапплаер линзы (параметр-тип класса сапплаера).

Parameters:

codeLens - Линза, из которой необходимо извлечь данные.

Returns:

Извлеченные данные линзы.

refreshCodeLenses

public void refreshCodeLenses()

Отправить запрос на обновление линз кода.