Class ParserSymbolDescriptionAdapter

java.lang.Object

com.github._1c_syntax.bsl.languageserver.context.symbol.ParserSymbolDescriptionAdapter

All Implemented Interfaces:

SymbolDescription

public final class ParserSymbolDescriptionAdapter
extends Object
implements SymbolDescription

Адаптер описания, полученного bsl-parser'ом из doc-комментариев SourceDefinedSymbol, к нашему интерфейсу SymbolDescription.

Field Summary

Fields inherited from interface SymbolDescription

EMPTY

Method Summary

Modifier and Type	Method	Description
String	getDeprecationInfo()
String	getPurposeDescription()
boolean	isDeprecated()
static SymbolDescription	of(SourceDefinedSymbolDescription description)

Methods inherited from class Object

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

Methods inherited from interface SymbolDescription

isEmpty

Method Details

of

public static SymbolDescription of(SourceDefinedSymbolDescription description)

getPurposeDescription

public String getPurposeDescription()

Specified by:

getPurposeDescription in interface SymbolDescription

Returns:

основной текст описания (без блока deprecation, без параметров). Никогда не null; пустая строка означает «описания нет».

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface SymbolDescription

Returns:

true, если сущность помечена как устаревшая.

getDeprecationInfo

public String getDeprecationInfo()

Specified by:

getDeprecationInfo in interface SymbolDescription

Returns:

сопровождающий текст об устаревании (например, на что заменено). Никогда не null; пустая строка допустима.