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

Class TypeDescription

java.lang.Object

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

public final class TypeDescription
extends Object

Описание типа параметра, прочитанного из описания метода

Constructor Summary

Constructors

Constructor	Description
TypeDescription(String name, String description, List<ParameterDescription> parameters, String link, boolean isHyperlink)	Creates a new TypeDescription instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Описание типа.
String	getLink()	Если описание параметров содержит только ссылку, то здесь будет ее значение
String	getName()	Имя типа.
List<ParameterDescription>	getParameters()	Параметры (ключи или поля) типа для сложных типов данных.
int	hashCode()
boolean	isHyperlink()	Признак того, что параметр является гиперссылкой
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TypeDescription

@ConstructorProperties({"name","description","parameters","link","isHyperlink"})
public TypeDescription(String name,
 String description,
 List<ParameterDescription> parameters,
 String link,
 boolean isHyperlink)

Creates a new TypeDescription instance.

Parameters:

name - Имя типа. На данный момент может быть строковый массив перечисления типов а также гиперссылка на метод

description - Описание типа. Может быть пустым

parameters - Параметры (ключи или поля) типа для сложных типов данных. Может быть пустым

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

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

isHyperlink - Признак того, что параметр является гиперссылкой

Method Details

getName

public String getName()

Имя типа. На данный момент может быть строковый массив перечисления типов а также гиперссылка на метод

getDescription

public String getDescription()

Описание типа. Может быть пустым

getParameters

public List<ParameterDescription> getParameters()

Параметры (ключи или поля) типа для сложных типов данных. Может быть пустым

getLink

public String getLink()

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

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

isHyperlink

public boolean isHyperlink()

Признак того, что параметр является гиперссылкой

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