All Classes and Interfaces
Class
Description
A
SyncListener with empty implementations of all interface methods.Implements
ReadBuf using an array of bytes
as a backing storage.Defines a backlink relation, which is based on another relation reversing the direction.
Marks a class as an ObjectBox Entity super class.
All vector access objects derive from this class, and add their own accessors.
APIs annotated with @Beta may change and may be even removed in a future release (but is somewhat less likely
compared to
Experimental).Helper type for accessing vector of booleans.
A Box to put and get Objects of a specific Entity class.
An ObjectBox database that provides
Boxes to put and get objects of specific entity classes
(see BoxStore.boxFor(Class)).Configures and builds a
BoxStore with reasonable defaults.A branch within a
Tree.You can throw this inside a
QueryConsumer to signal Query.forEach(QueryConsumer) should "break".Class that collects utility functions around `ByteBuffer`.
Helper type for accessing vector of signed or unsigned 8-bit values.
Special bit flags used in cluster mode only.
Configuration to connect to another (remote) cluster peer.
Internal class to keep configuration for a cluster peer.
Used with
Unique to specify the conflict resolution strategy.Used by
SyncClient to observe connectivity changes.Class that holds shared constants
Base class for exceptions thrown when a constraint would be violated during a put operation.
Supplies a
converter to store custom Property types as a supported Convert.dbType().Credentials consist of a type and the credentials data to perform authentication checks.
Credentials types for login at a sync server.
Use with
@Type to override how a property value is stored and interpreted in the database.Observer that can be subscribed to publishers (e.g.
The result of subscribing an @
DataObserver using @SubscriptionBuilder.observer(DataObserver).Tracks any number of
DataSubscription objects, which can be canceled with a single DataSubscriptionList.cancel() call.Transforms or processes data before it is given to subscribed
DataObservers.General exception for things that may go wrong with the database.
Listener for exceptions occurring during database operations.
Interface cannot have native methods.
Thrown when applying a database operation would exceed the (default)
maxSizeInKByte configured for the Store.Thrown when applying a transaction would exceed the
maxDataSizeInKByte
configured for the store.Thrown when the maximum of readers (read transactions) was exceeded.
Thrown when there is an error with the data schema (data model).
Thrown when an error occurred that requires the store to be closed.
Not intended for normal use.
Debug flags typically enable additional "debug logging" that can be helpful to better understand what is going on
internally.
Deprecated.
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.
Helper type for accessing vector of double values.
Marks a class as an ObjectBox Entity.
Not really an enum, but binary flags to use across languages
Exceptions thrown in
DataObserver and @DataTransformer can be observed by an error observer set via
SubscriptionBuilder.onError(ErrorObserver).APIs annotated with @Experimental are likely to change and may be even removed in a future release.
Generic Factory that provides a resource on demand (if and when it is required).
Use with
BoxStore.hasFeature(Feature).Thrown when a special feature was used, which is not part of the native library.
Errors were detected in a database file, e.g.
Class that helps you build a FlatBuffer.
A class that allows a user to create an InputStream from a ByteBuffer.
An interface that provides a user of the FlatBufferBuilder class the ability to specify
the method in which the internal buffer gets allocated.
An implementation of the ByteBufferFactory interface that is used when
one is not provided by the user.
Options to open a store with.
This class can be used to parse FlexBuffer messages.
Represents a array of bytes element in the buffer
Represents a key element in the buffer.
Represent a vector of keys in a map
Map object representing a set of key-value pairs.
Base class of all types below.
Represents an generic element in the buffer.
Object that represents a set of elements with the same type
Object that represents a set of elements in the buffer
Helper class that builds FlexBuffers
Converts between
Object properties and byte arrays using FlexBuffers.Helper type for accessing vector of float values.
The distance algorithm used by an HNSW index (vector search).
Flags as a part of the
HnswIndex configuration.Flags as a part of the HNSW configuration.
Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
Marks the ID property of an
@Entity.Marks a property as a companion to an @Id property.
ID tuple: besides the main ID there is also a UID for verification
Wraps the ID of a matching object and a score when using
Query.findIdsWithScores(long, long).Specifies that the property should be indexed.
ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see
IndexType.DEFAULT).A
FlexObjectConverter that uses Integer as map keys.Like
IntegerFlexMapConverter, but always restores integer map values as Long.APIs annotated with @Internal must NOT be used.
Exposes internal APIs to tests and code in other packages.
Exposes internal APIs to tests and code in other packages.
Helper type for accessing vector of signed or unsigned 32-bit values.
A thread-safe, unmodifiable
List that gets Objects from their Box not until they are accessed.(Potentially internal) value object created in our JNI layer to represent a leaf with all stored data.
Logic based query conditions, currently
LogicQueryCondition.AndCondition and LogicQueryCondition.OrCondition.Combines the left condition using AND with the right condition.
Combines the left condition using OR with the right condition.
A
FlexObjectConverter that uses Long as map keys.Like
LongFlexMapConverter, but always restores integer map values as Long.Helper type for accessing vector of long values.
A model describes all entities and other meta data.
Allows to specify a simple name mapping for entities and properties.
Separate class, so we can mock BoxStore.
Thrown if
Query.findUnique() or
Query.findUniqueId() is called,
but the query matches more than one object.Specifies that property is not null
Used as a converter if a property is annotated with
@DefaultValue("").Thrown if a property query aggregate function can not compute a result due to a number type overflowing.
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"
A
DataPublisher that notifies DataObservers about changes in an entity box.Wraps a matching object and a score when using
Query.findWithScores(long, long).Specifies ordering of related collection of
relation
E.g.: @OrderBy("name, age DESC") List collection;
If used as marker (@OrderBy List collection), then collection is ordered by primary key
invalid reference
RelationNot really an enum, but binary flags to use across languages
Errors related to pages were detected in a database file, e.g.
Provides access to platform-specific features.
Meta data describing a Property of an ObjectBox Entity.
To use custom types in your entity, implement this to convert db values to entity values and back.
Bit-flags defining the behavior of properties.
Query for a specific property; create using
Query.property(Property).A condition on a
Property, which can have an alias to allow referring to it later.Property based query conditions with implementations split by number and type of values,
such as LongCondition, LongLongCondition,
LongArrayCondition and the general NullCondition.Conditions for properties with an
HnswIndex.Basic type of a property
A repeatable Query returning the latest matching objects.
Builds a
Query using conditions which can then be used to return a list of matching Objects.Allows building queries with a fluent interface.
Hides the
QueryConditionImpl.apply(QueryBuilder) method from the public API (QueryCondition).Decides which entities to keep as a query result.
A
DataPublisher that subscribes to an ObjectClassPublisher if there is at least one observer.Represent a chunk of data, where FlexBuffers will read from.
Interface to represent a read-write buffer.
Meta info describing a relation including source and target entity.
Static methods to Rx-ify ObjectBox queries.
Static methods to Rx-ify ObjectBox queries.
Helper type for accessing vector of signed or unsigned 16-bit values.
Like
StringFlexMapConverter, but always restores integer map values as Long.Converts a String map entity property to a byte array database value using FlexBuffers.
Helper type for accessing vector of String.
All structs in the generated code derive from this class, and add their own accessors.
Enables sync for an
Entity class.ObjectBox Sync makes data available on other devices.
A builder to create a
SyncClient; the builder itself should be created via
Sync.client(BoxStore, String, SyncCredentials).A collection of changes made to one entity type during a sync transaction.
Notifies of fine granular changes on the object level happening during sync.
ObjectBox sync client.
Internal sync client implementation.
Listens to sync completed events.
Listens to sync connection events.
Use the static helper methods to build Sync credentials,
for example
SyncCredentials.sharedSecret("secret").Internal credentials implementation.
Internal credentials implementation for user and password authentication.
Flags to adjust sync behavior like additional logging.
Combines the functionality of a Sync client and a Sync server.
Builder for a Sync client and server hybrid setup, a
SyncHybrid.This listener has callback methods invoked by all fundamental synchronization events.
Codes used by
SyncLoginListener.onLoginFailed(long).Listens to login events.
ObjectBox sync server.
Creates a
SyncServer and allows to set additional configuration.Bit flags to configure the Sync Server.
Internal sync server implementation.
The Sync server configuration used to configure a starting Sync Server.
Returned by
SyncClientImpl.getSyncState().All tables in the generated code derive from this class, and add their own accessors.
Defines the property serving as the target ID of a ToOne.
A to-many relation of an entity that references multiple objects of a
ToMany entity.A to-one relation of an entity that references one object of a
ToOne entity.Transient fields are not persisted in the database.
A higher level tree API operating on branch and leaf nodes.
Options flags for trees.
Callback to be used for
BoxStore.runInTxAsync(Runnable, TxCallback) and
BoxStore.callInTxAsync(Callable, TxCallback).Use on a property to override how its value is stored and interpreted in the database.
UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
Helper type for accessing vector of unions.
Enforces that the value of a property is unique among all objects in a box before an object can be put.
Thrown when a @
Unique constraint would be violated during a put operation.Indicates that values of an integer property (e.g.
Utility methods for decoding bytes into
String.This class implements the Utf8 API using the Java Utf8 encoder.
A set of low-level, high-performance static utility methods related
to the UTF-8 character encoding.
Deprecated.
This class has moved to the config package, use
ValidateOnOpenModePages instead.Defines if and how the database is checked for valid key/value (KV) entries when opening it.
Defines if and how the database is checked for structural consistency (pages) when opening it.
The vector distance algorithm used by an
HnswIndex (vector search).
DebugFlagsinstead.