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

Class VariableDescription

java.lang.Object

com.github._1c_syntax.bsl.languageserver.context.symbol.variable.VariableDescription

All Implemented Interfaces:

SourceDefinedSymbolDescription

public final class VariableDescription
extends Object
implements SourceDefinedSymbolDescription

Класс-описание переменной.

Constructor Summary

Constructors

Constructor	Description
VariableDescription(ParameterDescription param)
VariableDescription(List<Token> comments)
VariableDescription(List<Token> comments, Optional<Token> trailingComment)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDeprecationInfo()	Содержит часть строки после ключевого слова, в которой должно быть описание причины устаревания переменной либо альтернативы
String	getDescription()	Содержит полное описание переменной (весь текст)
String	getLink()	Если описание содержит только ссылку, то здесь будет ее значение
String	getPurposeDescription()	Описание назначения переменной
Range	getRange()	Диапазон, в котором располагается описание.
Optional<VariableDescription>	getTrailingDescription()
int	hashCode()
boolean	isDeprecated()	Признак устаревания переменной
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VariableDescription

public VariableDescription(List<Token> comments)

VariableDescription

public VariableDescription(List<Token> comments,
 Optional<Token> trailingComment)

VariableDescription

public VariableDescription(ParameterDescription param)

Method Details

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

getLink

public String getLink()

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

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

Specified by:

getLink in interface SourceDefinedSymbolDescription

getRange

public Range getRange()

Диапазон, в котором располагается описание.

Specified by:

getRange in interface SourceDefinedSymbolDescription

getTrailingDescription

public Optional<VariableDescription> getTrailingDescription()

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