All Classes

Class	Description
AbstractSyncListener	A SyncListener with empty implementations of all interface methods.
ArrayReadWriteBuf	Implements ReadBuf using an array of bytes as a backing storage.
Backlink	Defines a backlink relation, which is based on another relation reversing the direction.
BaseEntity	Marks a class as an ObjectBox Entity super class.
BaseVector	All vector access objects derive from this class, and add their own accessors.
Beta	APIs annotated with @Beta may change and may be even removed in a future release (but is somewhat less likely compared to Experimental).
BooleanVector	Helper type for accessing vector of booleans.
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.
Branch	A branch within a Tree.
BreakForEach	You can throw this inside a QueryConsumer to signal Query.forEach(QueryConsumer) should "break".
ByteBufferReadWriteBuf
ByteBufferUtil	Class that collects utility functions around `ByteBuffer`.
ByteVector	Helper type for accessing vector of signed or unsigned 8-bit values.
CallWithHandle<RESULT>
ClusterFlags	Special bit flags used in cluster mode only.
ClusterPeerConfig	Configuration to connect to another (remote) cluster peer.
ClusterPeerConfig.Vector
ClusterPeerInfo	Internal class to keep configuration for a cluster peer.
ConflictStrategy	Used with Unique to specify the conflict resolution strategy.
ConnectivityMonitor	Used by SyncClient to observe connectivity changes.
Constants	Class that holds shared constants
ConstraintViolationException	Base class for exceptions thrown when a constraint would be violated during a put operation.
Convert	Supplies a converter to store custom Property types as a supported Convert.dbType().
Credentials	Credentials consist of a type and the credentials data to perform authentication checks.
Credentials.Vector
CredentialsType	Credentials types for login at a sync server.
Cursor<T>
CursorFactory<T>
DatabaseType	Use with @Type to override how a property value is stored and interpreted in the database.
DataObserver<T>	Observer that can be subscribed to publishers (e.g.
DataPublisher<T>
DataPublisherUtils
DataSubscription	The result of subscribing an @DataObserver using @SubscriptionBuilder.observer(DataObserver).
DataSubscriptionImpl<T>
DataSubscriptionList	Tracks any number of DataSubscription objects, which can be canceled with a single DataSubscriptionList.cancel() call.
DataTransformer<FROM,TO>	Transforms or processes data before it is given to subscribed DataObservers.
DbDetachedException
DbException	General exception for things that may go wrong with the database.
DbExceptionListener	Listener for exceptions occurring during database operations.
DbExceptionListenerJni	Interface cannot have native methods.
DbFullException	Thrown when applying a database operation would exceed the (default) maxSizeInKByte configured for the Store.
DbMaxDataSizeExceededException	Thrown when applying a transaction would exceed the maxDataSizeInKByte configured for the store.
DbMaxReadersExceededException	Thrown when the maximum of readers (read transactions) was exceeded.
DbSchemaException	Thrown when there is an error with the data schema (data model).
DbShutdownException	Thrown when an error occurred that requires the store to be closed.
DebugCursor	Not intended for normal use.
DebugFlags	Debug flags typically enable additional "debug logging" that can be helpful to better understand what is going on internally.
DebugFlags	Deprecated. DebugFlags moved to config package: use DebugFlags instead.
DefaultValue	Defines the Java code of the default value to use for a property, when getting an existing entity and the database value for the property is null.
DelegatingObserver<T>
DoubleVector	Helper type for accessing vector of double values.
EagerRelation<S,T>
Entity	Marks a class as an ObjectBox Entity.
EntityFlags	Not really an enum, but binary flags to use across languages
EntityInfo<T>
ErrorObserver	Exceptions thrown in DataObserver and @DataTransformer can be observed by an error observer set via SubscriptionBuilder.onError(ErrorObserver).
Experimental	APIs annotated with @Experimental are likely to change and may be even removed in a future release.
Factory<T>	Generic Factory that provides a resource on demand (if and when it is required).
Feature	Use with BoxStore.hasFeature(Feature).
FeatureNotAvailableException	Thrown when a special feature was used, which is not part of the native library.
FileCorruptException	Errors were detected in a database file, e.g.
FlatBufferBuilder	Class that helps you build a FlatBuffer.
FlatBufferBuilder.ByteBufferBackedInputStream	A class that allows a user to create an InputStream from a ByteBuffer.
FlatBufferBuilder.ByteBufferFactory	An interface that provides a user of the FlatBufferBuilder class the ability to specify the method in which the internal buffer gets allocated.
FlatBufferBuilder.HeapByteBufferFactory	An implementation of the ByteBufferFactory interface that is used when one is not provided by the user.
FlatStoreOptions	Options to open a store with.
FlatStoreOptions.Vector
FlexBuffers	This class can be used to parse FlexBuffer messages.
FlexBuffers.Blob	Represents a array of bytes element in the buffer
FlexBuffers.FlexBufferException
FlexBuffers.Key	Represents a key element in the buffer.
FlexBuffers.KeyVector	Represent a vector of keys in a map
FlexBuffers.Map	Map object representing a set of key-value pairs.
FlexBuffers.Object	Base class of all types below.
FlexBuffers.Reference	Represents an generic element in the buffer.
FlexBuffers.Sized
FlexBuffers.TypedVector	Object that represents a set of elements with the same type
FlexBuffers.Unsigned
FlexBuffers.Vector	Object that represents a set of elements in the buffer
FlexBuffersBuilder	Helper class that builds FlexBuffers
FlexBuffersBuilder.Value
FlexObjectConverter	Converts between Object properties and byte arrays using FlexBuffers.
FloatVector	Helper type for accessing vector of float values.
HnswDistanceType	The distance algorithm used by an HNSW index (vector search).
HnswFlags	Flags as a part of the HnswIndex configuration.
HnswFlags	Flags as a part of the HNSW configuration.
HnswIndex	Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
HnswParams	Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
HnswParams.Vector
Id	Marks the ID property of an @Entity.
IdCompanion	Marks a property as a companion to an @Id property.
IdGetter<T>
IdUid	ID tuple: besides the main ID there is also a UID for verification
IdUid.Vector
IdWithScore	Wraps the ID of a matching object and a score when using Query.findIdsWithScores(long, long).
Index	Specifies that the property should be indexed.
IndexType	ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see IndexType.DEFAULT).
IntegerFlexMapConverter	A FlexObjectConverter that uses Integer as map keys.
IntegerLongMapConverter	Like IntegerFlexMapConverter, but always restores integer map values as Long.
Internal	APIs annotated with @Internal must NOT be used.
InternalAccess	Exposes internal APIs to tests and code in other packages.
InternalAccess	Exposes internal APIs to tests and code in other packages.
IntVector	Helper type for accessing vector of signed or unsigned 32-bit values.
JniTest
JwtConfig
JwtConfig.Vector
KeyValueCursor
LazyList<E>	A thread-safe, unmodifiable List that gets Objects from their Box not until they are accessed.
Leaf	A data leaf represents a data value in a Tree as a child of a Branch.
LeafNode	(Potentially internal) value object created in our JNI layer to represent a leaf with all stored data.
ListFactory
ListFactory.ArrayListFactory
ListFactory.CopyOnWriteArrayListFactory
LogicQueryCondition<T>	Logic based query conditions, currently LogicQueryCondition.AndCondition and LogicQueryCondition.OrCondition.
LogicQueryCondition.AndCondition<T>	Combines the left condition using AND with the right condition.
LogicQueryCondition.OrCondition<T>	Combines the left condition using OR with the right condition.
LongFlexMapConverter	A FlexObjectConverter that uses Long as map keys.
LongLongMapConverter	Like LongFlexMapConverter, but always restores integer map values as Long.
LongVector	Helper type for accessing vector of long values.
Model	A model describes all entities and other meta data.
Model.Vector
ModelBuilder
ModelEntity
ModelEntity.Vector
ModelModifier
ModelProperty
ModelProperty.Vector
ModelRelation
ModelRelation.Vector
ModelUpdate
NameInDb	Allows to specify a simple name mapping for entities and properties.
NativeLibraryLoader	Separate class, so we can mock BoxStore.
NonUniqueResultException	Thrown if Query.findUnique() or Query.findUniqueId() is called, but the query matches more than one object.
NotNull	Specifies that property is not null
NullToEmptyStringConverter	Used as a converter if a property is annotated with @DefaultValue("").
NumericOverflowException	Thrown if a property query aggregate function can not compute a result due to a number type overflowing.
ObjectBoxThreadPool	Custom thread pool similar to Executors.newCachedThreadPool() with the following adjustments: Release thread local resources (BoxStore.closeThreadResources()) Reduce keep-alive time for threads to 20 seconds Uses a ThreadFactory to name threads like "ObjectBox-1-Thread-1"
ObjectBoxThreadPool.ObjectBoxThreadFactory
ObjectClassPublisher	A DataPublisher that notifies DataObservers about changes in an entity box.
ObjectClassPublisher.PublishRequest
ObjectsMessageBuilder
ObjectWithScore<T>	Wraps a matching object and a score when using Query.findWithScores(long, long).
OrderBy	Specifies ordering of related collection of Relation relation E.g.: @OrderBy("name, age DESC") List collection; If used as marker (@OrderBy List collection), then collection is ordered by primary key
OrderFlags	Not really an enum, but binary flags to use across languages
PagesCorruptException	Errors related to pages were detected in a database file, e.g.
Platform	Provides access to platform-specific features.
Property<ENTITY>	Meta data describing a Property of an ObjectBox Entity.
PropertyConverter<P,D>	To use custom types in your entity, implement this to convert db values to entity values and back.
PropertyFlags	Bit-flags defining the behavior of properties.
PropertyQuery	Query for a specific property; create using Query.property(Property).
PropertyQueryCondition<T>	A condition on a Property, which can have an alias to allow referring to it later.
PropertyQueryConditionImpl<T>	Property based query conditions with implementations split by number and type of values, such as LongCondition, LongLongCondition, LongArrayCondition and the general NullCondition.
PropertyQueryConditionImpl.ByteArrayCondition<T>
PropertyQueryConditionImpl.ByteArrayCondition.Operation
PropertyQueryConditionImpl.DoubleCondition<T>
PropertyQueryConditionImpl.DoubleCondition.Operation
PropertyQueryConditionImpl.DoubleDoubleCondition<T>
PropertyQueryConditionImpl.DoubleDoubleCondition.Operation
PropertyQueryConditionImpl.IntArrayCondition<T>
PropertyQueryConditionImpl.IntArrayCondition.Operation
PropertyQueryConditionImpl.LongArrayCondition<T>
PropertyQueryConditionImpl.LongArrayCondition.Operation
PropertyQueryConditionImpl.LongCondition<T>
PropertyQueryConditionImpl.LongCondition.Operation
PropertyQueryConditionImpl.LongLongCondition<T>
PropertyQueryConditionImpl.LongLongCondition.Operation
PropertyQueryConditionImpl.NearestNeighborCondition<T>	Conditions for properties with an HnswIndex.
PropertyQueryConditionImpl.NullCondition<T>
PropertyQueryConditionImpl.NullCondition.Operation
PropertyQueryConditionImpl.StringArrayCondition<T>
PropertyQueryConditionImpl.StringArrayCondition.Operation
PropertyQueryConditionImpl.StringCondition<T>
PropertyQueryConditionImpl.StringCondition.Operation
PropertyQueryConditionImpl.StringStringCondition<T>
PropertyQueryConditionImpl.StringStringCondition.Operation
PropertyType	Basic type of a property
Query<T>	A repeatable Query returning the latest matching objects.
QueryBuilder<T>	Builds a Query using conditions which can then be used to return a list of matching Objects.
QueryBuilder.Operator
QueryBuilder.StringOrder
QueryCondition<T>	Allows building queries with a fluent interface.
QueryConditionImpl<T>	Hides the QueryConditionImpl.apply(QueryBuilder) method from the public API (QueryCondition).
QueryConsumer<T>
QueryFilter<T>	Decides which entities to keep as a query result.
QueryPublisher<T>	A DataPublisher that subscribes to an ObjectClassPublisher if there is at least one observer.
QueryPublisher.SubscribedObservers<T>
QueryThreadLocal<T>	A ThreadLocal that, given an original Query object, returns a copy, for each thread.
ReadBuf	Represent a chunk of data, where FlexBuffers will read from.
ReadWriteBuf	Interface to represent a read-write buffer.
ReflectionCache
RelationCountCondition<T>
RelationInfo<SOURCE,TARGET>	Meta info describing a relation including source and target entity.
RunWithParam<T>
RxBoxStore	Static methods to Rx-ify ObjectBox queries.
RxQuery	Static methods to Rx-ify ObjectBox queries.
Scheduler
Schedulers
ShortVector	Helper type for accessing vector of signed or unsigned 16-bit values.
StringFlexMapConverter	A FlexObjectConverter.
StringLongMapConverter	Like StringFlexMapConverter, but always restores integer map values as Long.
StringMapConverter	Converts a String map entity property to a byte array database value using FlexBuffers.
StringVector	Helper type for accessing vector of String.
Struct	All structs in the generated code derive from this class, and add their own accessors.
SubscriptionBuilder<T>	Builds a DataSubscription for a DataObserver passed via SubscriptionBuilder.observer(DataObserver).
Sync	Enables sync for an Entity class.
Sync	ObjectBox Sync makes data available on other devices.
SyncBuilder	A builder to create a SyncClient; the builder itself should be created via Sync.client(BoxStore, String, SyncCredentials).
SyncBuilder.RequestUpdatesMode
SyncChange	A collection of changes made to one entity type during a sync transaction.
SyncChangeListener	Notifies of fine granular changes on the object level happening during sync.
SyncClient	ObjectBox sync client.
SyncClientImpl	Internal sync client implementation.
SyncClientImpl.ObjectsMessageBuilderImpl
SyncCompletedListener	Listens to sync completed events.
SyncConnectionListener	Listens to sync connection events.
SyncCredentials	Use the static helper methods to build Sync credentials, for example SyncCredentials.sharedSecret("secret").
SyncCredentials.CredentialsType
SyncCredentialsToken	Internal credentials implementation.
SyncCredentialsUserPassword	Internal credentials implementation for user and password authentication.
SyncFlags	Flags to adjust sync behavior like additional logging.
SyncHybrid	Combines the functionality of a Sync client and a Sync server.
SyncHybridBuilder	Builder for a Sync client and server hybrid setup, a SyncHybrid.
SyncListener	This listener has callback methods invoked by all fundamental synchronization events.
SyncLoginCodes	Codes used by SyncLoginListener.onLoginFailed(long).
SyncLoginListener	Listens to login events.
SyncServer	ObjectBox sync server.
SyncServerBuilder	Creates a SyncServer and allows to set additional configuration.
SyncServerFlags	Bit flags to configure the Sync Server.
SyncServerImpl	Internal sync server implementation.
SyncServerOptions	The Sync server configuration used to configure a starting Sync Server.
SyncServerOptions.Vector
SyncState	Returned by SyncClientImpl.getSyncState().
SyncTimeListener
Table	All tables in the generated code derive from this class, and add their own accessors.
TargetIdProperty	Defines the property serving as the target ID of a ToOne.
ToMany<TARGET>	A to-many relation of an entity that references multiple objects of a ToMany entity.
ToManyGetter<SOURCE,TARGET>
ToOne<TARGET>	A to-one relation of an entity that references one object of a ToOne entity.
ToOneGetter<SOURCE,TARGET>
Transaction
Transient	Transient fields are not persisted in the database.
Tree	A higher level tree API operating on branch and leaf nodes.
TreeOptionFlags	Options flags for trees.
TxCallback<T>	Callback to be used for BoxStore.runInTxAsync(Runnable, TxCallback) and BoxStore.callInTxAsync(Callable, TxCallback).
Type	Use on a property to override how its value is stored and interpreted in the database.
Uid	UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
UnionVector	Helper type for accessing vector of unions.
Unique	Enforces that the value of a property is unique among all objects in a box before an object can be put.
UniqueViolationException	Thrown when a @Unique constraint would be violated during a put operation.
Unsigned	Indicates that values of an integer property (e.g.
Utf8
Utf8.DecodeUtil	Utility methods for decoding bytes into String.
Utf8.UnpairedSurrogateException
Utf8Old	This class implements the Utf8 API using the Java Utf8 encoder.
Utf8Old.Cache
Utf8Safe	A set of low-level, high-performance static utility methods related to the UTF-8 character encoding.
Utf8Safe.UnpairedSurrogateException
ValidateOnOpenMode	Deprecated. This class has moved to the config package, use ValidateOnOpenModePages instead.
ValidateOnOpenModeKv	Defines if and how the database is checked for valid key/value (KV) entries when opening it.
ValidateOnOpenModePages	Defines if and how the database is checked for structural consistency (pages) when opening it.
VectorDistanceType	The vector distance algorithm used by an HnswIndex (vector search).
WeakDataObserver<T>