Package com.github._1c_syntax.bsl.languageserver.commands

Interface CommandSupplier<T extends CommandArguments>

Type Parameters:

T - Конкретный тип для аргументов команды.

All Known Implementing Classes:

AbstractToggleComplexityInlayHintsCommandSupplier, ToggleCognitiveComplexityInlayHintsCommandSupplier, ToggleCyclomaticComplexityInlayHintsCommandSupplier

public interface CommandSupplier<T extends CommandArguments>

Базовый интерфейс для наполнения CommandProvider данными о доступных в документе командах.

Конкретный сапплаер может расширить состав данных, передаваемых в аргументах команды, доопределив дата-класс, наследующий CommandArguments, и указав его тип в качестве типа-параметра класса.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMAND_SUPPLIER_SUFFIX

Method Summary

Modifier and Type	Method	Description
default Command	createCommand(String title, T arguments)	Создать DTO команды.
Optional<Object>	execute(T arguments)	Выполнить серверную команду.
Class<T>	getCommandArgumentsClass()	Получить класс для аргументов команды.
default String	getId()	Идентификатор сапплаера.
default boolean	needRefreshCodeLensesAfterExecuteCommand()	Флаг, показывающий необходимость обновить линзы после выполнения команды.
default boolean	needRefreshInlayHintsAfterExecuteCommand()	Флаг, показывающий необходимость обновить inlay hints после выполнения команды.

Field Details

COMMAND_SUPPLIER_SUFFIX

static final String COMMAND_SUPPLIER_SUFFIX

See Also:

• Constant Field Values

Method Details

getId

default String getId()

Идентификатор сапплаера.

Идентификатор в аргументах команды должен совпадать с данным идентификатором.

Returns:

Идентификатор сапплаера.

createCommand

default Command createCommand(String title,
 T arguments)

Создать DTO команды.

Parameters:

title - Заголовок команды.

arguments - Аргументы команды.

Returns:

Команда с заполненными заголовком и идентификатором команды.

getCommandArgumentsClass

Class<T> getCommandArgumentsClass()

Получить класс для аргументов команды.

Returns:

Конкретный класс для аргументов команды.

execute

Optional<Object> execute(T arguments)

Выполнить серверную команду.

Parameters:

arguments - Аргументы команды.

Returns:

Результат выполнения команды.

needRefreshInlayHintsAfterExecuteCommand

default boolean needRefreshInlayHintsAfterExecuteCommand()

Флаг, показывающий необходимость обновить inlay hints после выполнения команды.

Returns:

Флаг, показывающий необходимость обновить inlay hints после выполнения команды.

needRefreshCodeLensesAfterExecuteCommand

default boolean needRefreshCodeLensesAfterExecuteCommand()

Флаг, показывающий необходимость обновить линзы после выполнения команды.

Returns:

Флаг, показывающий необходимость обновить линзы после выполнения команды.