@ParametersAreNonnullByDefault
Package io.objectbox
ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
The following core classes are the essential interface to ObjectBox:
- MyObjectBox: Generated by the Gradle plugin, supplies a
BoxStoreBuilder
to build a BoxStore for your app. BoxStore
: The database interface, allows to manage Boxes.Box
: Persists and queries for Objects, there is one for each Entity class.
For more details look at the documentation of individual classes and docs.objectbox.io.
-
Interface Summary Interface Description EntityInfo<T> Factory<T> Generic Factory that provides a resource on demand (if and when it is required).TxCallback<T> Callback to be used forBoxStore.runInTxAsync(Runnable, TxCallback)
andBoxStore.callInTxAsync(Callable, TxCallback)
. -
Class Summary Class Description Box<T> A Box to put and get Objects of a specific Entity class.BoxStore An ObjectBox database that providesBoxes
to put and get objects of specific entity classes (seeBoxStore.boxFor(Class)
).BoxStoreBuilder Configures and builds aBoxStore
with reasonable defaults.DebugFlags Deprecated. DebugFlags moved to config package: useDebugFlags
instead.InternalAccess Exposes internal APIs to tests and code in other packages.Property<ENTITY> Meta data describing a Property of an ObjectBox Entity.