clean_repo_objectbox
library
Classes
-
Admin
-
ObjectBox Admin allows you to explore the database in a regular web browser.
-
Backlink
-
Backlink annotation specifies a link in a reverse direction of another
relation.
-
BigIntDefaultConverter
-
-
BigIntKeyValueUseCase
-
-
BoolDefaultConverter
-
-
BoolKeyValueUseCase
-
-
Box<T>
-
A Box instance gives you access to objects of a particular type.
You get Box instances via Store.box() or Box(Store).
-
CleanRepoObjectbox
-
-
Condition<EntityT>
-
A Query condition base class.
-
Converter<Domain, Entity>
-
General converter entity <==> domain, it generalize and extract the
conversion entity => domain & domain => entity in a single isolated class
-
CRUDObjectBox<Entity extends EntityObject>
-
Default CRUD repository of type Entity extends EntityObject
for ObjectBox direct operations.
-
CRUDObjectBox_Impl<Entity extends EntityObject>
-
EXAMPLE:
This is the implementation of DefaultObjectBoxCRUDRepositoryExternal.
-
CRUDRepository<Domain>
-
Repository of CRUD operations, of type Domain.
Generally not implemented, instead extends the repo from DelegatedCRUDRepository.
-
DateTimeDefaultConverter
-
-
DebugFlags
-
Passed as
debugFlags
when calling Store.new to enable debug options.
-
DefaultDateTimeKeyValueUseCaseImpl
-
-
DelegatedCRUDRepository<Domain, Entity extends EntityObject, ExternalRepo extends CRUDObjectBox<Entity>>
-
Default implementation of CRUDRepository of type Domain & Entity extends EntityObject
It's basically a delegate to the ObjectBox.
-
DoubleDefaultConverter
-
-
DoubleKeyValueUseCase
-
-
Entity
-
Entity annotation is used on a class to let ObjectBox know it should store
it - making the class a "persistable Entity".
-
EntityObject
-
Simplest of all entity's objects
Entity has IntIdentifier and Comparable<EntityObject>
-
Id
-
Annotation Id can be used to specify an entity ID property if it's named
anything else then "id" (case insensitive).
-
Index
-
Specifies that the property should be indexed.
-
IntDefaultConverter
-
-
IntKeyValueUseCase
-
-
KeyValueConverter
-
-
KeyValueCoreModule
-
-
KeyValueDataModule
-
-
KeyValueDomain
-
-
KeyValueEntity
-
-
KeyValueEntity_
-
KeyValueEntity entity fields to define ObjectBox queries.
-
KeyValueObjectBox
-
-
KeyValueRepo
-
-
KeyValueUseCase
-
-
KeyValueUseCaseImpl
-
-
Order
-
Groups query order flags.
-
Property
-
Property annotation enables you to explicitly configure some details about
how a field is stored in the database.
-
PropertyQuery<T>
-
Property query base.
-
Query<T>
-
A repeatable Query returning the latest matching Objects.
-
QueryBuilder<T>
-
Query builder allows creating reusable queries.
-
SingleKeyValueConverter<K, V>
-
-
SingleKeyValueObjectBox
-
-
SingleKeyValueRepo<K, V>
-
-
SingleKeyValueUseCase<K, V>
-
-
SingleKeyValueUseCaseImpl<K, V>
-
-
Store
-
Represents an ObjectBox database and works together with Box to allow
getting and putting.
-
Sync
-
ObjectBox Sync makes data available and
synchronized across devices, online and offline.
-
SyncChange
-
Sync incoming data event.
-
SyncClient
-
Sync client is used to connect to an ObjectBox sync server.
-
SyncCredentials
-
Credentials used to authenticate a sync client against a server.
-
ToMany<EntityT>
-
Manages a to-many relation, an unidirectional link from a "source" entity to
multiple objects of a "target" entity.
-
ToOne<EntityT>
-
Manages a to-one relation, an unidirectional link from a "source" entity to
a "target" entity. The target object is referenced by its ID, which is
persisted in the source object.
-
Transient
-
Transient annotation marks fields that should not be stored in the database.
-
Unique
-
Enforces that the value of a property is unique among all objects in a box
before an object can be put.
-
Version
-
Wrapper for a semantic version information.
Mixins
-
IntIdentifier
-
Standard for unique identifier of every entity.
Functions
-
getObjectBoxModel()
→ ModelDefinition
-
ObjectBox model definition, pass it to Store - Store(getObjectBoxModel())
-
openStore({String? directory, int? maxDBSizeInKB, int? fileMode, int? maxReaders, bool queriesCaseSensitiveDefault = true, String? macosApplicationGroup})
→ Future<Store>
-
Open an ObjectBox store with the model declared in this file.