mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 05:25:19 +00:00
added documentation
This commit is contained in:
@@ -1,5 +1,8 @@
|
|||||||
enum Mode { SIMPLE, INSTANCE, PROVIDER_INSTANCE }
|
enum Mode { SIMPLE, INSTANCE, PROVIDER_INSTANCE }
|
||||||
|
|
||||||
|
/// RU: Класс Binding<T> настраивает параметры экземпляра.
|
||||||
|
/// ENG: The Binding<T> class configures the settings for the instance.
|
||||||
|
///
|
||||||
class Binding<T> {
|
class Binding<T> {
|
||||||
late Mode _mode;
|
late Mode _mode;
|
||||||
late Type _key;
|
late Type _key;
|
||||||
@@ -14,18 +17,50 @@ class Binding<T> {
|
|||||||
_key = T;
|
_key = T;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// RU: Метод возвращает [Mode] экземпляра.
|
||||||
|
/// ENG: The method returns the [Mode] of the instance.
|
||||||
|
///
|
||||||
|
/// return [Mode]
|
||||||
Mode get mode => _mode;
|
Mode get mode => _mode;
|
||||||
|
|
||||||
|
/// RU: Метод возвращает тип экземпляра.
|
||||||
|
/// ENG: The method returns the type of the instance.
|
||||||
|
///
|
||||||
|
/// return [Type]
|
||||||
Type get key => _key;
|
Type get key => _key;
|
||||||
|
|
||||||
|
/// RU: Метод возвращает имя экземпляра.
|
||||||
|
/// ENG: The method returns the name of the instance.
|
||||||
|
///
|
||||||
|
/// return [String]
|
||||||
String get name => _name;
|
String get name => _name;
|
||||||
|
|
||||||
|
/// RU: Метод проверяет сингелтон экземпляр или нет.
|
||||||
|
/// ENG: The method checks the singleton instance or not.
|
||||||
|
///
|
||||||
|
/// return [bool]
|
||||||
bool get isSingeltone => _isSingeltone;
|
bool get isSingeltone => _isSingeltone;
|
||||||
|
|
||||||
|
/// RU: Метод проверяет именован экземпляр или нет.
|
||||||
|
/// ENG: The method checks whether the instance is named or not.
|
||||||
|
///
|
||||||
|
/// return [bool]
|
||||||
bool get isNamed => _isNamed;
|
bool get isNamed => _isNamed;
|
||||||
|
|
||||||
|
/// RU: Добавляет имя для экземляпя [value].
|
||||||
|
/// ENG: Added name for instance [value].
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> withName(String name) {
|
Binding<T> withName(String name) {
|
||||||
_name = name;
|
_name = name;
|
||||||
_isNamed = true;
|
_isNamed = true;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// RU: Инициализация экземляпяра [value].
|
||||||
|
/// ENG: Initialization instance [value].
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> toInstance(T value) {
|
Binding<T> toInstance(T value) {
|
||||||
_mode = Mode.INSTANCE;
|
_mode = Mode.INSTANCE;
|
||||||
_instance = value;
|
_instance = value;
|
||||||
@@ -33,12 +68,20 @@ class Binding<T> {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// RU: Инициализация экземляпяра через провайдер [value].
|
||||||
|
/// ENG: Initialization instance via provider [value].
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> toProvide(T Function() value) {
|
Binding<T> toProvide(T Function() value) {
|
||||||
_mode = Mode.PROVIDER_INSTANCE;
|
_mode = Mode.PROVIDER_INSTANCE;
|
||||||
_provider = value;
|
_provider = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// RU: Инициализация экземляпяра как сингелтон [value].
|
||||||
|
/// ENG: Initialization instance as a singelton [value].
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> singeltone() {
|
Binding<T> singeltone() {
|
||||||
if (_mode == Mode.PROVIDER_INSTANCE) {
|
if (_mode == Mode.PROVIDER_INSTANCE) {
|
||||||
_instance = _provider.call();
|
_instance = _provider.call();
|
||||||
@@ -47,7 +90,15 @@ class Binding<T> {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// RU: Поиск экземпляра.
|
||||||
|
/// ENG: Resolve instance.
|
||||||
|
///
|
||||||
|
/// return [T]
|
||||||
T? get instance => _instance;
|
T? get instance => _instance;
|
||||||
|
|
||||||
|
/// RU: Поиск экземпляра.
|
||||||
|
/// ENG: Resolve instance.
|
||||||
|
///
|
||||||
|
/// return [T]
|
||||||
T? get provider => _provider.call();
|
T? get provider => _provider.call();
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user