Record Class ApiMetadataDto

java.lang.Object

java.lang.Record

com.github._1c_syntax.bsl.languageserver.mcp.dto.ApiMetadataDto

Record Components:

sinceVersion - Версия платформы, начиная с которой член доступен; null, если не задано.

deprecatedSinceVersion - Версия, начиная с которой устарел; null, если не задано.

recommendedReplacements - Рекомендуемые замены устаревшего члена.

availabilities - Контексты исполнения, в которых член доступен.

accessMode - Режим доступа для свойства (READ / READ_WRITE); null для методов.

returnValueDescription - Текст раздела «Возвращаемое значение»; null, если отсутствует.

notes - Текст раздела «Замечание»; null, если отсутствует.

examples - Примеры использования.

seeAlso - «См. также» — связанные сущности.

public record ApiMetadataDto(@Nullable String sinceVersion, @Nullable String deprecatedSinceVersion, List<String> recommendedReplacements, List<String> availabilities, @Nullable String accessMode, @Nullable String returnValueDescription, @Nullable String notes, List<String> examples, List<String> seeAlso)
extends Record

Метаинформация элемента API из справочника: контексты исполнения, версионная совместимость, тексты разделов «Возвращаемое значение», «Замечание», «Примеры», «См. также». Для 1С источник — синтакс-помощник платформы, для OneScript — встроенный справочник типов.

Описывает как член типа, так и сам тип или его конструктор — набор заполненных полей зависит от источника (у типа нет режима доступа, у конструктора — описания возвращаемого значения).

Field Summary

Fields

Modifier and Type	Field	Description
static final ApiMetadataDto	EMPTY	Пустая метаинформация — все поля null или пустые списки.

Constructor Summary

Constructors

Constructor	Description
ApiMetadataDto(@Nullable String sinceVersion, @Nullable String deprecatedSinceVersion, List<String> recommendedReplacements, List<String> availabilities, @Nullable String accessMode, @Nullable String returnValueDescription, @Nullable String notes, List<String> examples, List<String> seeAlso)	Creates an instance of a ApiMetadataDto record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	accessMode()	Returns the value of the accessMode record component.
List<String>	availabilities()	Returns the value of the availabilities record component.
@Nullable String	deprecatedSinceVersion()	Returns the value of the deprecatedSinceVersion record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	examples()	Returns the value of the examples record component.
static ApiMetadataDto	from(PlatformMetadata metadata, Language language)
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
@Nullable String	notes()	Returns the value of the notes record component.
List<String>	recommendedReplacements()	Returns the value of the recommendedReplacements record component.
@Nullable String	returnValueDescription()	Returns the value of the returnValueDescription record component.
List<String>	seeAlso()	Returns the value of the seeAlso record component.
@Nullable String	sinceVersion()	Returns the value of the sinceVersion record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

EMPTY

public static final ApiMetadataDto EMPTY

Пустая метаинформация — все поля null или пустые списки.

Constructor Details

ApiMetadataDto

public ApiMetadataDto(@Nullable String sinceVersion,
 @Nullable String deprecatedSinceVersion,
 List<String> recommendedReplacements,
 List<String> availabilities,
 @Nullable String accessMode,
 @Nullable String returnValueDescription,
 @Nullable String notes,
 List<String> examples,
 List<String> seeAlso)

Creates an instance of a ApiMetadataDto record class.

Parameters:

sinceVersion - the value for the sinceVersion record component

deprecatedSinceVersion - the value for the deprecatedSinceVersion record component

recommendedReplacements - the value for the recommendedReplacements record component

availabilities - the value for the availabilities record component

accessMode - the value for the accessMode record component

returnValueDescription - the value for the returnValueDescription record component

notes - the value for the notes record component

examples - the value for the examples record component

seeAlso - the value for the seeAlso record component

Method Details

from

public static ApiMetadataDto from(PlatformMetadata metadata,
 Language language)

isEmpty

public boolean isEmpty()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sinceVersion

public @Nullable String sinceVersion()

Returns the value of the sinceVersion record component.

Returns:

the value of the sinceVersion record component

deprecatedSinceVersion

public @Nullable String deprecatedSinceVersion()

Returns the value of the deprecatedSinceVersion record component.

Returns:

the value of the deprecatedSinceVersion record component

recommendedReplacements

public List<String> recommendedReplacements()

Returns the value of the recommendedReplacements record component.

Returns:

the value of the recommendedReplacements record component

availabilities

public List<String> availabilities()

Returns the value of the availabilities record component.

Returns:

the value of the availabilities record component

accessMode

public @Nullable String accessMode()

Returns the value of the accessMode record component.

Returns:

the value of the accessMode record component

returnValueDescription

public @Nullable String returnValueDescription()

Returns the value of the returnValueDescription record component.

Returns:

the value of the returnValueDescription record component

notes

public @Nullable String notes()

Returns the value of the notes record component.

Returns:

the value of the notes record component

examples

public List<String> examples()

Returns the value of the examples record component.

Returns:

the value of the examples record component

seeAlso

public List<String> seeAlso()

Returns the value of the seeAlso record component.

Returns:

the value of the seeAlso record component