com.github._1c_syntax.bsl.languageserver.completion.CompletionData

public class CompletionData extends Object

DTO для хранения промежуточных данных completion item между его созданием (textDocument/completion) и отложенным разрешением документации (completionItem/resolve).

Кладётся в CompletionItem.setData(Object) вместо жадно построенной documentation, чтобы тяжёлые описания членов широкого типа (Глобальный контекст, union типов) не путешествовали в каждом ответе completion. По этому ключу провайдер восстанавливает член типа и собирает documentation только для выбранного клиентом item.

Сериализуется клиентом в JSON и приходит обратно как JsonObject/Map — поля сделаны bean-style (Lombok @Data) для round-trip через Jackson.

Поддерживаются три вида ключа восстановления:

член типа (dot-completion): заполнены typeKind/typeQualifiedName и memberName, по ним восстанавливается член типа-владельца;
глобальная функция (no-dot completion): заполнено functionName, по нему функция ищется в глобальной области видимости. Поля типа-владельца при этом не используются;
контракт события (no-dot completion, заглушка обработчика): заполнено eventContractName, по нему контракт ищется среди событий owner-типа документа.

Constructor Summary

Constructors

Constructor

Description

CompletionData()

CompletionData(URI uri, @Nullable TypeKind typeKind, @Nullable String typeQualifiedName, @Nullable String memberName, FileType fileType, Language scriptVariant, @Nullable String functionName, @Nullable String eventContractName, @Nullable com.github._1c_syntax.bsl.types.ModuleType moduleType)

Creates a new CompletionData instance.
Method Summary

Modifier and Type

Method

Description

protected boolean

canEqual(Object other)

boolean

equals(Object o)

static CompletionData

forEventContract(URI uri, com.github._1c_syntax.bsl.types.ModuleType moduleType, @Nullable TypeRef ownerTypeRef, String eventContractName, FileType fileType, Language scriptVariant)

Создаёт ключ восстановления документации контракта платформенного события (no-dot completion, заглушка ещё не объявленного обработчика).

static CompletionData

forFunction(URI uri, String functionName, FileType fileType, Language scriptVariant)

Создаёт ключ восстановления документации глобальной функции (no-dot completion).

static CompletionData

forMember(URI uri, TypeKind typeKind, String typeQualifiedName, String memberName, FileType fileType, Language scriptVariant)

Создаёт ключ восстановления документации члена типа (dot-completion).

@Nullable String

getEventContractName()

Каноническое имя контракта платформенного события, для которого нужно восстановить документацию (no-dot completion, заглушка ещё не объявленного обработчика).

FileType

getFileType()

Тип файла-потребителя (BSL/OS) — влияет на набор членов типа и набор глобальных функций.

@Nullable String

getFunctionName()

Имя глобальной функции, для которой нужно восстановить документацию.

@Nullable String

getMemberName()

Имя члена (метода/свойства), для которого нужно восстановить документацию.

@Nullable com.github._1c_syntax.bsl.types.ModuleType

getModuleType()

Вид модуля документа (вариант event-контракта): по нему и owner-типу (typeKind/typeQualifiedName) в resolve восстанавливается набор событий без обращения к документу.

Language

getScriptVariant()

Локаль скрипта (ru/en) для отбора написаний и языка описания.

@Nullable TypeKind

getTypeKind()

Вид типа-владельца члена (часть идентичности TypeRef).

@Nullable String

getTypeQualifiedName()

Каноническое полное имя типа-владельца члена (часть идентичности TypeRef).

URI

getUri()

URI документа, в контексте которого item был построен.

int

hashCode()

void

setEventContractName(@Nullable String eventContractName)

Каноническое имя контракта платформенного события, для которого нужно восстановить документацию (no-dot completion, заглушка ещё не объявленного обработчика).

void

setFileType(FileType fileType)

Тип файла-потребителя (BSL/OS) — влияет на набор членов типа и набор глобальных функций.

void

setFunctionName(@Nullable String functionName)

Имя глобальной функции, для которой нужно восстановить документацию.

void

setMemberName(@Nullable String memberName)

Имя члена (метода/свойства), для которого нужно восстановить документацию.

void

setModuleType(@Nullable com.github._1c_syntax.bsl.types.ModuleType moduleType)

Вид модуля документа (вариант event-контракта): по нему и owner-типу (typeKind/typeQualifiedName) в resolve восстанавливается набор событий без обращения к документу.

void

setScriptVariant(Language scriptVariant)

Локаль скрипта (ru/en) для отбора написаний и языка описания.

void

setTypeKind(@Nullable TypeKind typeKind)

Вид типа-владельца члена (часть идентичности TypeRef).

void

setTypeQualifiedName(@Nullable String typeQualifiedName)

Каноническое полное имя типа-владельца члена (часть идентичности TypeRef).

void

setUri(URI uri)

URI документа, в контексте которого item был построен.

String

toString()

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- CompletionData
  
  public CompletionData()
- CompletionData
  
  @ConstructorProperties({"uri","typeKind","typeQualifiedName","memberName","fileType","scriptVariant","functionName","eventContractName","moduleType"}) public CompletionData(URI uri, @Nullable TypeKind typeKind, @Nullable String typeQualifiedName, @Nullable String memberName, FileType fileType, Language scriptVariant, @Nullable String functionName, @Nullable String eventContractName, @Nullable com.github._1c_syntax.bsl.types.ModuleType moduleType)
  
  Creates a new CompletionData instance.
  
  Parameters:
  
  uri - URI документа, в контексте которого item был построен.
  Нужен для completionItem/resolve: запрос приходит без позиции и без текстового документа, а typeService/globalScopeProvider — workspace-scoped бины. По этому URI восстанавливается документ и его workspace, чтобы установить workspace-контекст перед резолвом documentation.
  
  typeKind - Вид типа-владельца члена (часть идентичности TypeRef). null для варианта глобальной функции.
  
  typeQualifiedName - Каноническое полное имя типа-владельца члена (часть идентичности TypeRef). null для варианта глобальной функции.
  
  memberName - Имя члена (метода/свойства), для которого нужно восстановить документацию. null для варианта глобальной функции.
  
  fileType - Тип файла-потребителя (BSL/OS) — влияет на набор членов типа и набор глобальных функций.
  
  scriptVariant - Локаль скрипта (ru/en) для отбора написаний и языка описания.
  
  functionName - Имя глобальной функции, для которой нужно восстановить документацию. Заполнено только для варианта глобальной функции; для члена типа — null.
  
  eventContractName - Каноническое имя контракта платформенного события, для которого нужно восстановить документацию (no-dot completion, заглушка ещё не объявленного обработчика). Заполнено только для варианта event-контракта; для члена типа и глобальной функции — null.
  
  moduleType - Вид модуля документа (вариант event-контракта): по нему и owner-типу (typeKind/typeQualifiedName) в resolve восстанавливается набор событий без обращения к документу. Заполнено только для варианта event-контракта.
Method Details
- forMember
  
  public static CompletionData forMember(URI uri, TypeKind typeKind, String typeQualifiedName, String memberName, FileType fileType, Language scriptVariant)
  
  Создаёт ключ восстановления документации члена типа (dot-completion).
  
  Parameters:
  
  uri - URI документа, в контексте которого построен item.
  
  typeKind - вид типа-владельца члена.
  
  typeQualifiedName - каноническое полное имя типа-владельца.
  
  memberName - имя члена (метода/свойства).
  
  fileType - тип файла-потребителя (BSL/OS).
  
  scriptVariant - локаль скрипта (ru/en).
  
  Returns:
  
  ключ восстановления члена типа.
- forFunction
  
  public static CompletionData forFunction(URI uri, String functionName, FileType fileType, Language scriptVariant)
  
  Создаёт ключ восстановления документации глобальной функции (no-dot completion).
  
  Parameters:
  
  uri - URI документа, в контексте которого построен item.
  
  functionName - имя глобальной функции.
  
  fileType - тип файла-потребителя (BSL/OS).
  
  scriptVariant - локаль скрипта (ru/en).
  
  Returns:
  
  ключ восстановления глобальной функции.
- forEventContract
  
  public static CompletionData forEventContract(URI uri, com.github._1c_syntax.bsl.types.ModuleType moduleType, @Nullable TypeRef ownerTypeRef, String eventContractName, FileType fileType, Language scriptVariant)
  
  Создаёт ключ восстановления документации контракта платформенного события (no-dot completion, заглушка ещё не объявленного обработчика). Набор событий восстанавливается по паре (moduleType, ownerTypeRef) без обращения к документу.
  
  Parameters:
  
  uri - URI документа, в контексте которого построен item.
  
  moduleType - вид модуля документа.
  
  ownerTypeRef - owner-тип событий (null для .os-класса и глобальных модулей).
  
  eventContractName - каноническое имя контракта события.
  
  fileType - тип файла-потребителя (BSL/OS).
  
  scriptVariant - локаль скрипта (ru/en).
  
  Returns:
  
  ключ восстановления контракта события.
- getUri
  
  public URI getUri()
  
  URI документа, в контексте которого item был построен.
  Нужен для completionItem/resolve: запрос приходит без позиции и без текстового документа, а typeService/globalScopeProvider — workspace-scoped бины. По этому URI восстанавливается документ и его workspace, чтобы установить workspace-контекст перед резолвом documentation.
- getTypeKind
  
  public @Nullable TypeKind getTypeKind()
  
  Вид типа-владельца члена (часть идентичности TypeRef). null для варианта глобальной функции.
- getTypeQualifiedName
  
  public @Nullable String getTypeQualifiedName()
  
  Каноническое полное имя типа-владельца члена (часть идентичности TypeRef). null для варианта глобальной функции.
- getMemberName
  
  public @Nullable String getMemberName()
  
  Имя члена (метода/свойства), для которого нужно восстановить документацию. null для варианта глобальной функции.
- getFileType
  
  public FileType getFileType()
  
  Тип файла-потребителя (BSL/OS) — влияет на набор членов типа и набор глобальных функций.
- getScriptVariant
  
  public Language getScriptVariant()
  
  Локаль скрипта (ru/en) для отбора написаний и языка описания.
- getFunctionName
  
  public @Nullable String getFunctionName()
  
  Имя глобальной функции, для которой нужно восстановить документацию. Заполнено только для варианта глобальной функции; для члена типа — null.
- getEventContractName
  
  public @Nullable String getEventContractName()
  
  Каноническое имя контракта платформенного события, для которого нужно восстановить документацию (no-dot completion, заглушка ещё не объявленного обработчика). Заполнено только для варианта event-контракта; для члена типа и глобальной функции — null.
- getModuleType
  
  public @Nullable com.github._1c_syntax.bsl.types.ModuleType getModuleType()
  
  Вид модуля документа (вариант event-контракта): по нему и owner-типу (typeKind/typeQualifiedName) в resolve восстанавливается набор событий без обращения к документу. Заполнено только для варианта event-контракта.
- setUri
  
  public void setUri(URI uri)
  
  URI документа, в контексте которого item был построен.
  Нужен для completionItem/resolve: запрос приходит без позиции и без текстового документа, а typeService/globalScopeProvider — workspace-scoped бины. По этому URI восстанавливается документ и его workspace, чтобы установить workspace-контекст перед резолвом documentation.
- setTypeKind
  
  public void setTypeKind(@Nullable TypeKind typeKind)
  
  Вид типа-владельца члена (часть идентичности TypeRef). null для варианта глобальной функции.
- setTypeQualifiedName
  
  public void setTypeQualifiedName(@Nullable String typeQualifiedName)
  
  Каноническое полное имя типа-владельца члена (часть идентичности TypeRef). null для варианта глобальной функции.
- setMemberName
  
  public void setMemberName(@Nullable String memberName)
  
  Имя члена (метода/свойства), для которого нужно восстановить документацию. null для варианта глобальной функции.
- setFileType
  
  public void setFileType(FileType fileType)
  
  Тип файла-потребителя (BSL/OS) — влияет на набор членов типа и набор глобальных функций.
- setScriptVariant
  
  public void setScriptVariant(Language scriptVariant)
  
  Локаль скрипта (ru/en) для отбора написаний и языка описания.
- setFunctionName
  
  public void setFunctionName(@Nullable String functionName)
  
  Имя глобальной функции, для которой нужно восстановить документацию. Заполнено только для варианта глобальной функции; для члена типа — null.
- setEventContractName
  
  public void setEventContractName(@Nullable String eventContractName)
  
  Каноническое имя контракта платформенного события, для которого нужно восстановить документацию (no-dot completion, заглушка ещё не объявленного обработчика). Заполнено только для варианта event-контракта; для члена типа и глобальной функции — null.
- setModuleType
  
  public void setModuleType(@Nullable com.github._1c_syntax.bsl.types.ModuleType moduleType)
  
  Вид модуля документа (вариант event-контракта): по нему и owner-типу (typeKind/typeQualifiedName) в resolve восстанавливается набор событий без обращения к документу. Заполнено только для варианта event-контракта.
- 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

Class CompletionData

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Details

CompletionData

CompletionData

Method Details

forMember

forFunction

forEventContract

getUri

getTypeKind

getTypeQualifiedName

getMemberName

getFileType

getScriptVariant

getFunctionName

getEventContractName

getModuleType

setUri

setTypeKind

setTypeQualifiedName

setMemberName

setFileType

setScriptVariant

setFunctionName

setEventContractName

setModuleType

equals

canEqual

hashCode

toString