Autumn Docs

Оформление

Публичный интерфейс библиотеки autumn-collections ​

Аннотации ​

Классы ​

Прилепляемые коллекции ​

АннотацияПрилепляемаяКоллекция ​

ПриСозданииОбъекта ​

bsl
// Помечает класс как реализацию прилепляемой коллекции с заданным именем.
//
// Имя используется при запросе коллекции через
// УправляющийПрилепляемымиКоллекциями.ПолучитьПрилепляемуюКоллекцию.
//
// Класс, помеченный аннотацией `&ПрилепляемаяКоллекция`, должен реализовать следующий интерфейс:
// * `Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт`
// * `Функция Получить() Экспорт`
//
// Размещается над конструктором класса.
//
// Параметры:
//   Значение - Строка - Имя регистрируемой прилепляемой коллекции (например, "Массив", "Соответствие").
//
// Пример:
// &ПрилепляемаяКоллекция("МояКоллекция")
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
Процедура ПриСозданииОбъекта(Значение)

УправляющийПрилепляемымиКоллекциями ​

ПриСозданииОбъекта ​

bsl
// Реестр зарегистрированных классов прилепляемых коллекций.
// Создаёт пустой реестр и описание интерфейса, которому должен соответствовать
// любой класс прилепляемой коллекции (методы `Добавить(Желудь, ОпределениеЖелудя)`
// и `Получить()`).
//
Процедура ПриСозданииОбъекта()

ДобавитьПрилепляемуюКоллекцию ​

bsl
// Регистрирует класс прилепляемой коллекции в реестре.
//
// Тип должен иметь конструктор, помеченный аннотацией `&ПрилепляемаяКоллекция("Имя")`,
// и реализовывать интерфейс прилепляемой коллекции (`Добавить`, `Получить`).
// Имя коллекции считывается из параметра аннотации и используется как ключ реестра.
//
// Параметры:
//   Тип - Тип - Тип класса прилепляемой коллекции, помеченный аннотацией `&ПрилепляемаяКоллекция`.
//
Процедура ДобавитьПрилепляемуюКоллекцию(Тип) Экспорт

ПолучитьПрилепляемуюКоллекцию ​

bsl
// Создаёт и возвращает новый экземпляр прилепляемой коллекции по её имени.
// Если коллекция с таким именем не зарегистрирована — вызывает исключение.
//
// Параметры:
//   Имя - Строка - Имя зарегистрированной прилепляемой коллекции.
//
//  Возвращаемое значение:
//   Произвольный - Новый экземпляр класса прилепляемой коллекции с указанным именем.
//
Функция ПолучитьПрилепляемуюКоллекцию(Имя) Экспорт

ЕстьПрилепляемаяКоллекция ​

bsl
// Проверяет, зарегистрирована ли прилепляемая коллекция с указанным именем.
//
// Параметры:
//   Имя - Строка - Имя проверяемой прилепляемой коллекции.
//
//  Возвращаемое значение:
//   Булево - Истина, если коллекция с таким именем зарегистрирована, иначе Ложь.
//
Функция ЕстьПрилепляемаяКоллекция(Имя) Экспорт

ПрилепляемаяКоллекцияКарта ​

ПриСозданииОбъекта ​

bsl
// Конструктор прилепляемой коллекции на основе карты.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Карта".
//
Процедура ПриСозданииОбъекта()

Добавить ​

bsl
// Добавляет очередной желудь в коллекцию. Ключом служит имя желудя.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить ​

bsl
// Возвращает прилеплённые желуди в виде неизменяемой карты, где ключом служит имя
// желудя (Строка), а значением — экземпляр желудя (Произвольный).
//
//  Возвращаемое значение:
//   ФиксированнаяКарта - карта прилеплённых желудей.
//
Функция Получить() Экспорт

ПрилепляемаяКоллекцияМассив ​

ПриСозданииОбъекта ​

bsl
// Конструктор прилепляемой коллекции на основе массива.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Массив".
//
Процедура ПриСозданииОбъекта()

Добавить ​

bsl
// Добавляет очередной желудь в коллекцию.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить ​

bsl
// Возвращает прилеплённые желуди в виде неизменяемого массива.
//
//  Возвращаемое значение:
//   ФиксированныйМассив из Произвольный - желуди в порядке прилепления.
//
Функция Получить() Экспорт

ПрилепляемаяКоллекцияМножество ​

ПриСозданииОбъекта ​

bsl
// Конструктор прилепляемой коллекции на основе множества.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Множество".
//
Процедура ПриСозданииОбъекта()

Добавить ​

bsl
// Добавляет очередной желудь в коллекцию. Повторное добавление одного и того же
// желудя игнорируется.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить ​

bsl
// Возвращает прилеплённые желуди в виде неизменяемого множества уникальных элементов.
//
//  Возвращаемое значение:
//   ФиксированноеМножество из Произвольный - уникальные прилеплённые желуди.
//
Функция Получить() Экспорт

ПрилепляемаяКоллекцияСоответствие ​

ПриСозданииОбъекта ​

bsl
// Конструктор прилепляемой коллекции на основе соответствия.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Соответствие".
//
Процедура ПриСозданииОбъекта()

Добавить ​

bsl
// Добавляет очередной желудь в коллекцию. Ключом служит имя желудя.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить ​

bsl
// Возвращает прилеплённые желуди в виде неизменяемого соответствия.
//
//  Возвращаемое значение:
//   ФиксированноеСоответствие:
//    * Ключ     - Строка - имя желудя
//    * Значение - Произвольный - желудь
//
Функция Получить() Экспорт

ПрилепляемаяКоллекцияСписок ​

ПриСозданииОбъекта ​

bsl
// Конструктор прилепляемой коллекции на основе списка.
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "Список".
//
Процедура ПриСозданииОбъекта()

Добавить ​

bsl
// Добавляет очередной желудь в коллекцию.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить ​

bsl
// Возвращает прилеплённые желуди в виде неизменяемого списка в порядке прилепления.
//
//  Возвращаемое значение:
//   ФиксированныйСписок из Произвольный - желуди в порядке прилепления.
//
Функция Получить() Экспорт

ПрилепляемаяКоллекцияТаблицаЗначений ​

ПриСозданииОбъекта ​

bsl
// Конструктор прилепляемой коллекции на основе таблицы значений с колонками
// «Имя», «Желудь», «ОпределениеЖелудя».
// Регистрируется в УправляющийПрилепляемымиКоллекциями как коллекция "ТаблицаЗначений".
//
Процедура ПриСозданииОбъекта()

Добавить ​

bsl
// Добавляет очередной желудь в коллекцию отдельной строкой с именем, экземпляром
// и определением желудя.
//
// Параметры:
//   Желудь - Произвольный - Добавляемый экземпляр желудя.
//   ОпределениеЖелудя - ОпределениеЖелудя - Определение добавляемого желудя.
//
Процедура Добавить(Желудь, ОпределениеЖелудя) Экспорт

Получить ​

bsl
// Возвращает прилеплённые желуди в виде копии таблицы значений.
//
//  Возвращаемое значение:
//   ТаблицаЗначений:
//    * Имя               - Строка - имя желудя
//    * Желудь            - Произвольный - экземпляр желудя
//    * ОпределениеЖелудя - ОпределениеЖелудя - определение желудя
//
Функция Получить() Экспорт