com.github._1c_syntax.bsl.languageserver.commands.CommandSupplier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bsl-language-server Show documentation

Language Server Protocol implementation for 1C (BSL) - 1C:Enterprise 8 and OneScript languages.

There is a newer version: 0.24.0-rc.1

/*
 * This file is a part of BSL Language Server.
 *
 * Copyright (c) 2018-2024
 * Alexey Sosnoviy , Nikita Fedkin  and contributors
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 *
 * BSL Language Server is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * BSL Language Server is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with BSL Language Server.
 */
package com.github._1c_syntax.bsl.languageserver.commands;

import org.eclipse.lsp4j.Command;

import java.beans.Introspector;
import java.util.List;
import java.util.Optional;

/**
 * Базовый интерфейс для наполнения {@link com.github._1c_syntax.bsl.languageserver.providers.CommandProvider}
 * данными о доступных в документе командах.
 * 
 * Конкретный сапплаер может расширить состав данных, передаваемых в аргументах команды, доопределив дата-класс,
 * наследующий {@link CommandArguments}, и указав его тип в качестве типа-параметра класса.
 *
 * @param  Конкретный тип для аргументов команды.
 */

public interface CommandSupplier {

  String COMMAND_SUPPLIER_SUFFIX = "CommandSupplier";

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

   * Идентификатор в аргументах команды должен совпадать с данным идентификатором.
   *
   * @return Идентификатор сапплаера.
   */
  default String getId() {
    String simpleName = getClass().getSimpleName();
    if (simpleName.endsWith(COMMAND_SUPPLIER_SUFFIX)) {
      simpleName = simpleName.substring(0, simpleName.length() - COMMAND_SUPPLIER_SUFFIX.length());
      simpleName = Introspector.decapitalize(simpleName);
    }

    return simpleName;
  }

  /**
   * Создать DTO команды.
   *
   * @param title Заголовок команды.
   * @param arguments Аргументы команды.
   * @return Команда с заполненными заголовком и идентификатором команды.
   */
  default Command createCommand(String title, T arguments) {
    return new Command(title, getId(), List.of(arguments));
  }

  /**
   * Получить класс для аргументов команды.
   *
   * @return Конкретный класс для аргументов команды.
   */
  Class getCommandArgumentsClass();

  /**
   * Выполнить серверную команду.
   *
   * @param arguments Аргументы команды.
   *
   * @return Результат выполнения команды.
   */
  Optional