ObjectBox Java 5.0.0 API

Welcome to the JavaDocs for ObjectBox, the super-fast database for objects. On these pages, you will find the API reference for the ObjectBox Java library.

The main documentation is available at docs.objectbox.io and offers a changelog, a getting started guide, and many more topics.

GitHub links: ObjectBox Java, Examples for Java, Kotlin and Android

Packages
Package
Description
io.objectbox
ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
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.annotation.apihint
Annotations to mark APIs as for example @Internal or @Experimental.
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.sync.internal
 
io.objectbox.sync.listener
 
io.objectbox.sync.server
 
io.objectbox.tree
APIs to interact with tree structures stored in ObjectBox.