Package com.github._1c_syntax.bsl.languageserver.context.symbol.description

Class MethodDescription

java.lang.Object
com.github._1c_syntax.bsl.languageserver.context.symbol.description.MethodDescription
All Implemented Interfaces:
SourceDefinedSymbolDescription
public final class MethodDescription extends Object implements SourceDefinedSymbolDescription
Класс-описание метода (процедуры или функции).

  • Constructor Details

    • MethodDescription

      public MethodDescription(List<Token> comments)

  • Method Details

    • contains

      public boolean contains(Token first, Token last)

    • getDescription

      public String getDescription()
      Содержит полное описание метода (весь текст).
      Specified by:
      getDescription in interface SourceDefinedSymbolDescription

    • getDeprecationInfo

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

    • isDeprecated

      public boolean isDeprecated()
      Признак устаревания метода.
      Specified by:
      isDeprecated in interface SourceDefinedSymbolDescription

    • getPurposeDescription

      public String getPurposeDescription()
      Описание назначения метода.
      Specified by:
      getPurposeDescription in interface SourceDefinedSymbolDescription

    • getExamples

      public List<String> getExamples()
      Примеры использования метода.

    • getCallOptions

      public List<String> getCallOptions()
      Варианты вызова метода.

    • getParameters

      public List<ParameterDescription> getParameters()
      Параметры метода с типами и описанием.

    • getReturnedValue

      public List<TypeDescription> getReturnedValue()
      Возвращаемые значения (типы).

    • getLink

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

      TODO Временное решение, надо будет продумать в следующем релизе

      Specified by:
      getLink in interface SourceDefinedSymbolDescription

    • getRange

      public Range getRange()
      Диапазон, в котором располагается описание.
      Specified by:
      getRange in interface SourceDefinedSymbolDescription

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object