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

Class VariableDescription

java.lang.Object

com.github._1c_syntax.bsl.parser.description.VariableDescription

All Implemented Interfaces:

SourceDefinedSymbolDescription

public final class VariableDescription
extends Object
implements SourceDefinedSymbolDescription

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

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github._1c_syntax.bsl.parser.description.SourceDefinedSymbolDescription

contains

Method Details

getDescription

public String getDescription()

Description copied from interface: SourceDefinedSymbolDescription

Содержит полное описание (весь текст).

Specified by:

getDescription in interface SourceDefinedSymbolDescription

Returns:

Строка с описанием

getDeprecationInfo

public String getDeprecationInfo()

Description copied from interface: SourceDefinedSymbolDescription

Содержит часть строки после ключевого слова, в которой должно быть описание причины устаревания либо альтернативы.

Specified by:

getDeprecationInfo in interface SourceDefinedSymbolDescription

Returns:

Строка с описанием причины устаревания

isDeprecated

public boolean isDeprecated()

Description copied from interface: SourceDefinedSymbolDescription

Признак устаревания.

Specified by:

isDeprecated in interface SourceDefinedSymbolDescription

Returns:

Признак устаревания: True - устарел

getPurposeDescription

public String getPurposeDescription()

Description copied from interface: SourceDefinedSymbolDescription

Описание назначения (при наличии).

Specified by:

getPurposeDescription in interface SourceDefinedSymbolDescription

Returns:

Строка с описанием

getLink

public String getLink()

Description copied from interface: SourceDefinedSymbolDescription

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

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

Specified by:

getLink in interface SourceDefinedSymbolDescription

Returns:

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

getSimpleRange

public SimpleRange getSimpleRange()

Description copied from interface: SourceDefinedSymbolDescription

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

Specified by:

getSimpleRange in interface SourceDefinedSymbolDescription

Returns:

Область описания

getTrailingDescription

public Optional<VariableDescription> getTrailingDescription()