Package io.objectbox

@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.

Related Packages

Package	Description
io.objectbox.annotation	Annotations to mark a class as an @Entity, to specify the @Id Property, to create an @Index or a @Transient Property.
io.objectbox.config
io.objectbox.converter	For use with @Convert: PropertyConverter to convert custom Property types.
io.objectbox.exception	Various exceptions thrown by ObjectBox.
io.objectbox.query	Classes related to building a Query or PropertyQuery.
io.objectbox.reactive	Classes to configure a DataSubscription for observing Box or Query changes.
io.objectbox.relation	Classes to manage ToOne and ToMany relations between Entities.
io.objectbox.sync	ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g.
io.objectbox.tree	APIs to interact with tree structures stored in ObjectBox.

Class	Description
Box<T>	A Box to put and get Objects of a specific Entity class.
BoxStore	An ObjectBox database that provides Boxes to put and get objects of specific entity classes (see BoxStore.boxFor(Class)).
BoxStoreBuilder	Configures and builds a BoxStore with reasonable defaults.
DebugFlags	Deprecated. DebugFlags moved to config package: use DebugFlags instead.
EntityInfo<T>
Factory<T>	Generic Factory that provides a resource on demand (if and when it is required).
InternalAccess	Exposes internal APIs to tests and code in other packages.
Property<ENTITY>	Meta data describing a Property of an ObjectBox Entity.
TxCallback<T>	Callback to be used for BoxStore.runInTxAsync(Runnable, TxCallback) and BoxStore.callInTxAsync(Callable, TxCallback).