Package com.github._1c_syntax.bsl.parser.description

Interface SourceDefinedSymbolDescription

All Known Implementing Classes:
MethodDescription, VariableDescription
public interface SourceDefinedSymbolDescription
Базовый интерфейс объектов, имеющих описание

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    contains(Token first, Token last)
    Проверяет вхождение области заданной двумя пограничными токенами в область описания
    String
    getDeprecationInfo()
    Содержит часть строки после ключевого слова, в которой должно быть описание причины устаревания либо альтернативы.
    String
    getDescription()
    Содержит полное описание (весь текст).
    String
    getLink()
    Если описание содержит только ссылку, то здесь будет ее значение
    String
    getPurposeDescription()
    Описание назначения (при наличии).
    SimpleRange
    getSimpleRange()
    Диапазон, в котором располагается описание.
    boolean
    isDeprecated()
    Признак устаревания.

  • Method Details

    • getDescription

      String getDescription()
      Содержит полное описание (весь текст).
      Returns:
      Строка с описанием

    • getDeprecationInfo

      String getDeprecationInfo()
      Содержит часть строки после ключевого слова, в которой должно быть описание причины устаревания либо альтернативы.
      Returns:
      Строка с описанием причины устаревания

    • isDeprecated

      boolean isDeprecated()
      Признак устаревания.
      Returns:
      Признак устаревания: True - устарел

    • getPurposeDescription

      String getPurposeDescription()
      Описание назначения (при наличии).
      Returns:
      Строка с описанием

    • getLink

      String getLink()
      Если описание содержит только ссылку, то здесь будет ее значение

      TODO Временное решение, надо будет продумать кошерное решение

      Returns:
      Строка с текстом ссылки (без префикса см./see)

    • getSimpleRange

      SimpleRange getSimpleRange()
      Диапазон, в котором располагается описание.
      Returns:
      Область описания

    • contains

      default boolean contains(Token first, Token last)
      Проверяет вхождение области заданной двумя пограничными токенами в область описания
      Parameters:
      first - Токен левого верхнего угла области
      last - Токен нижнего правого узла области
      Returns:
      Признак вхождения