Class AbstractVariableSymbol

java.lang.Object

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

All Implemented Interfaces:

Describable, Exportable, SourceDefinedSymbol, Symbol, VariableSymbol, Comparable<VariableSymbol>

Direct Known Subclasses:

IntBasedVariableSymbol, ShortBasedVariableSymbol

public abstract class AbstractVariableSymbol
extends Object
implements VariableSymbol

Общая реализация символа переменной.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractVariableSymbol.Builder

Field Summary

Fields inherited from interface VariableSymbol

NATURAL_ORDER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractVariableSymbol(String name, SourceDefinedSymbol scope, Optional<SourceDefinedSymbol> parent, byte kind, boolean export)

Method Summary

Modifier and Type	Method	Description
void	accept(SymbolTreeVisitor visitor)	Обработчик захода в символ при обходе символьного дерева.
static AbstractVariableSymbol.Builder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SourceDefinedSymbol>	getChildren()
Optional<VariableDescription>	getDescription()	Описание переменной.
VariableKind	getKind()
String	getName()	Имя переменной.
DocumentContext	getOwner()	Файл, в котором располагается переменная, — файл её области.
Optional<SourceDefinedSymbol>	getParent()
SourceDefinedSymbol	getScope()	Область доступности символа.
Range	getSelectionRange()
SymbolKind	getSymbolKind()
int	hashCode()
boolean	isExport()	Признак экспортной переменной.
void	setParent(Optional<SourceDefinedSymbol> parent)
String	toString()

Methods inherited from class Object

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

Methods inherited from interface Describable

getSymbolDescription

Methods inherited from interface SourceDefinedSymbol

containsPosition, getRange, getRootParent, getRootParent

Methods inherited from interface Symbol

getTags, isDeprecated

Methods inherited from interface VariableSymbol

compareTo, getAnnotations, getVariableNameEndCharacter, getVariableNameLine, getVariableNameRange, getVariableNameStartCharacter

Constructor Details

AbstractVariableSymbol

protected AbstractVariableSymbol(String name,
 SourceDefinedSymbol scope,
 Optional<SourceDefinedSymbol> parent,
 byte kind,
 boolean export)

Method Details

getOwner

public DocumentContext getOwner()

Файл, в котором располагается переменная, — файл её области. Не хранится: переменных на большой конфигурации миллионы, и поле на каждую стоило бы десятки мегабайт.

Specified by:

getOwner in interface SourceDefinedSymbol

Returns:

Документ, в котором объявлен данный символ.

getDescription

public Optional<VariableDescription> getDescription()

Описание переменной. Описана малая доля переменных, и описание хранит отдельный подкласс (DescribedVariableSymbol), а не поле каждой переменной.

Specified by:

getDescription in interface Describable

Specified by:

getDescription in interface VariableSymbol

Returns:

Описание символа в форме, поставляемой bsl-parser'ом (используется диагностиками, которые знают конкретные подтипы MethodDescription/VariableDescription и т.п.).

getParent

public Optional<SourceDefinedSymbol> getParent()

Specified by:

getParent in interface SourceDefinedSymbol

Returns:

Символ, внутри которого располагается данный символ.

setParent

public void setParent(Optional<SourceDefinedSymbol> parent)

Specified by:

setParent in interface SourceDefinedSymbol

Parameters:

parent - Символ, внутри которого располагается данный символ.

getChildren

public List<SourceDefinedSymbol> getChildren()

Specified by:

getChildren in interface SourceDefinedSymbol

Returns:

Список "детей" символа - символов, которые располагаются внутри данного символа.

getSymbolKind

public SymbolKind getSymbolKind()

Specified by:

getSymbolKind in interface Symbol

Returns:

Тип символа.

getKind

public VariableKind getKind()

Specified by:

getKind in interface VariableSymbol

Returns:

Вид переменной

accept

public void accept(SymbolTreeVisitor visitor)

Description copied from interface: Symbol

Обработчик захода в символ при обходе символьного дерева.

Specified by:

accept in interface Symbol

Parameters:

visitor - Обходчик дерева.

getSelectionRange

public Range getSelectionRange()

Specified by:

getSelectionRange in interface SourceDefinedSymbol

Returns:

Место интереса символа. Например, диапазон, где указано имя символа (в противовес полной строки декларации символа).

builder

public static AbstractVariableSymbol.Builder builder()

getName

public String getName()

Имя переменной.

Specified by:

getName in interface Symbol

Returns:

Имя символа.

getScope

public SourceDefinedSymbol getScope()

Область доступности символа. Метод или модуль; файл переменной — её файл (см. getOwner()).

Specified by:

getScope in interface VariableSymbol

Returns:

Область объявления переменной.

isExport

public boolean isExport()

Признак экспортной переменной.

Specified by:

isExport in interface Exportable

Returns:

Сущность является экспортной.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object