A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes All Packages

A

AbstractSyncClientListener - Class in io.objectbox.sync
A SyncClientListener with empty implementations of all interface methods.
AbstractSyncClientListener() - Constructor for class io.objectbox.sync.AbstractSyncClientListener
 
accept(T) - Method in interface io.objectbox.query.QueryConsumer
 
add(int, E) - Method in class io.objectbox.query.LazyList
 
add(int, TARGET) - Method in class io.objectbox.relation.ToMany
See ToMany.add(Object) for general comments.
add(E) - Method in class io.objectbox.query.LazyList
 
add(E) - Method in class io.objectbox.query.LazyList.LazyIterator
 
add(DataSubscription) - Method in class io.objectbox.reactive.DataSubscriptionList
Add the given subscription to the list of tracked subscriptions.
add(TARGET) - Method in class io.objectbox.relation.ToMany
Adds the given entity to the list and tracks the addition so it can be later applied to the database (e.g.
addAll(int, Collection<? extends E>) - Method in class io.objectbox.query.LazyList
 
addAll(int, Collection<? extends TARGET>) - Method in class io.objectbox.relation.ToMany
See ToMany.add(Object) for general comments.
addAll(Collection<? extends E>) - Method in class io.objectbox.query.LazyList
 
addAll(Collection<? extends TARGET>) - Method in class io.objectbox.relation.ToMany
See ToMany.add(Object) for general comments.
and() - Method in class io.objectbox.query.QueryBuilder
And AND changes how conditions are combined using a following OR.
androidContext(Object) - Method in class io.objectbox.BoxStoreBuilder
On Android, you can pass a Context to set the base directory using this method.
androidReLinker(Object) - Method in class io.objectbox.BoxStoreBuilder
Pass a custom ReLinkerInstance, for example ReLinker.log(logger) to use for loading the native library on Android devices.
API_KEY - io.objectbox.sync.SyncCredentials.CredentialsType
 
apiKey(byte[]) - Static method in class io.objectbox.sync.SyncCredentials
Authenticate with a pre-shared key.
apiKey(String) - Static method in class io.objectbox.sync.SyncCredentials
Authenticate with a pre-shared key.
applyChangesToDb() - Method in class io.objectbox.relation.ToMany
Applies (persists) tracked changes (added and removed entities) to the target box and/or updates standalone relations.
applyTo(QueryBuilder, QueryBuilder.StringOrder) - Method in interface io.objectbox.query.QueryCondition
 
applyTo(QueryBuilder, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryCondition.PropertyCondition
 
ArrayListFactory() - Constructor for class io.objectbox.relation.ListFactory.ArrayListFactory
 
assignable() - Method in annotation type io.objectbox.annotation.Id
Allows IDs of new entities to be assigned manually.
attach(T) - Method in class io.objectbox.Box
 
AUTH_UNREACHABLE - Static variable in class io.objectbox.sync.SyncLoginCodes
 
authenticatorCredentials(SyncCredentials) - Method in class io.objectbox.sync.server.SyncServerBuilder
Adds additional authenticator credentials to authenticate clients with.
avg() - Method in class io.objectbox.query.PropertyQuery
Calculates the average of all values for the given number property over all Objects matching the query.
avgLong() - Method in class io.objectbox.query.PropertyQuery
Calculates the average of all values for the given integer property over all Objects matching the query.
awaitFirstLogin(long) - Method in interface io.objectbox.sync.SyncClient
Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired.
awaitFirstLogin(long) - Method in class io.objectbox.sync.SyncClientImpl
 

B

backlink(RelationInfo<TARGET, ?>) - Method in class io.objectbox.query.QueryBuilder
Creates a backlink (reversed link) to another entity, for which you also can describe conditions using the returned builder.
Backlink - Annotation Type in io.objectbox.annotation
Defines a backlink relation, which is based on another relation reversing the direction.
backlinkToManyGetter - Variable in class io.objectbox.relation.RelationInfo
For ToMany relations based on ToMany backlinks (null otherwise).
backlinkToOneGetter - Variable in class io.objectbox.relation.RelationInfo
For ToMany relations based on ToOne backlinks (null otherwise).
BAD_VERSION - Static variable in class io.objectbox.sync.SyncLoginCodes
 
baseDirectory(File) - Method in class io.objectbox.BoxStoreBuilder
In combination with BoxStoreBuilder.name(String), this lets you specify the location of where the DB files should be stored.
BaseEntity - Annotation Type in io.objectbox.annotation
Annotation for an entity base class.
beginReadTx() - Method in class io.objectbox.BoxStore
Internal, low level method: use BoxStore.runInReadTx(Runnable) instead.
beginTx() - Method in class io.objectbox.BoxStore
Internal, low level method: use BoxStore.runInTx(Runnable) instead.
Beta - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Beta may change and may be even removed in a future release (but is somewhat less likely compared to Experimental).
between(Property<T>, double, double) - Method in class io.objectbox.query.QueryBuilder
 
between(Property<T>, long, long) - Method in class io.objectbox.query.QueryBuilder
 
between(Property<T>, Date, Date) - Method in class io.objectbox.query.QueryBuilder
 
between(Object, Object) - Method in class io.objectbox.Property
Creates an "BETWEEN ...
BETWEEN - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
Box<T> - Class in io.objectbox
A box to store objects of a particular class.
boxFor(Class<T>) - Method in class io.objectbox.BoxStore
Returns a Box for the given type.
BoxStore - Class in io.objectbox
Represents an ObjectBox database and gives you Boxes to get and put Objects of a specific type (see BoxStore.boxFor(Class)).
BoxStoreBuilder - Class in io.objectbox
Builds a BoxStore with optional configurations.
BoxStoreBuilder(byte[]) - Constructor for class io.objectbox.BoxStoreBuilder
 
BreakForEach - Exception in io.objectbox.query
You can throw this inside a QueryConsumer to signal Query.forEach(QueryConsumer) should "break".
BreakForEach() - Constructor for exception io.objectbox.query.BreakForEach
 
build() - Method in class io.objectbox.BoxStoreBuilder
Builds a BoxStore using any given configuration.
build() - Method in class io.objectbox.query.QueryBuilder
Builds the query and closes this QueryBuilder.
build() - Method in class io.objectbox.sync.server.SyncServerBuilder
Note: this clears all previously set authenticator credentials.
build() - Method in class io.objectbox.sync.SyncBuilder
 
buildDefault() - Method in class io.objectbox.BoxStoreBuilder
Builds the default BoxStore instance, which can be acquired using BoxStore.getDefault().

C

callInReadTx(Callable<T>) - Method in class io.objectbox.BoxStore
Calls the given callable inside a read(-only) transaction.
callInReadTxWithRetry(Callable<T>, int, int, boolean) - Method in class io.objectbox.BoxStore
Calls BoxStore.callInReadTx(Callable) and retries in case a DbException is thrown.
callInTx(Callable<R>) - Method in class io.objectbox.BoxStore
Like BoxStore.runInTx(Runnable), but allows returning a value and throwing an exception.
callInTxAsync(Callable<R>, TxCallback<R>) - Method in class io.objectbox.BoxStore
Runs the given Runnable as a transaction in a separate thread.
callInTxNoException(Callable<R>) - Method in class io.objectbox.BoxStore
Like BoxStore.callInTx(Callable), but throws no Exception.
cancel() - Method in interface io.objectbox.reactive.DataSubscription
The Observer shall not receive anymore updates.
cancel() - Method in class io.objectbox.reactive.DataSubscriptionList
Cancels all tracked subscriptions and removes all references to them.
cancelUpdates() - Method in interface io.objectbox.sync.SyncClient
Asks the server to pause sync updates.
cancelUpdates() - Method in class io.objectbox.sync.SyncClientImpl
 
CASE_INSENSITIVE - io.objectbox.query.QueryBuilder.StringOrder
The default: case insensitive ASCII characters
CASE_SENSITIVE - io.objectbox.query.QueryBuilder.StringOrder
Case matters ('a' != 'A').
CASE_SENSITIVE - Static variable in class io.objectbox.query.OrderFlags
Makes upper case letters (e.g.
CASE_SENSITIVE - Static variable in class io.objectbox.query.QueryBuilder
Makes upper case letters (e.g.
certificatePath(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
 
certificatePath(String) - Method in class io.objectbox.sync.SyncBuilder
 
changesListener(SyncChangesListener) - Method in class io.objectbox.sync.server.SyncServerBuilder
Sets a listener to observe fine granular changes happening during sync.
changesListener(SyncChangesListener) - Method in class io.objectbox.sync.SyncBuilder
Sets a listener to observe fine granular changes happening during sync.
checkCached() - Method in class io.objectbox.query.LazyList
 
cleanStaleReadTransactions() - Method in class io.objectbox.BoxStore
 
clear() - Method in class io.objectbox.query.LazyList
 
clear() - Method in class io.objectbox.relation.ToMany
 
clear() - Method in class io.objectbox.sync.SyncCredentialsToken
Clear after usage.
clearDefaultStore() - Static method in class io.objectbox.BoxStore
Clears the convenience instance.
client(BoxStore, String, SyncCredentials) - Static method in class io.objectbox.sync.Sync
Start building a sync client.
CLIENT_ID_TAKEN - Static variable in class io.objectbox.sync.SyncLoginCodes
 
close() - Method in class io.objectbox.BoxStore
Closes the BoxStore and frees associated resources.
close() - Method in class io.objectbox.query.Query
If possible, try to close the query once you are done with it to reclaim resources immediately.
close() - Method in class io.objectbox.query.QueryBuilder
 
close() - Method in interface io.objectbox.sync.server.SyncServer
Closes and cleans up all resources used by this sync server.
close() - Method in class io.objectbox.sync.server.SyncServerImpl
 
close() - Method in interface io.objectbox.sync.SyncClient
Closes and cleans up all resources used by this sync client.
close() - Method in class io.objectbox.sync.SyncClientImpl
 
closeThreadResources() - Method in class io.objectbox.Box
Like BoxStore.closeThreadResources(), but limited to only this Box.
closeThreadResources() - Method in class io.objectbox.BoxStore
Call this method from a thread that is about to be shutdown or likely not to use ObjectBox anymore: it frees any cached resources tied to the calling thread (e.g.
commitWriter(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
 
ConstraintViolationException - Exception in io.objectbox.exception
Base class for exceptions thrown when a constraint would be violated during a put operation.
ConstraintViolationException(String) - Constructor for exception io.objectbox.exception.ConstraintViolationException
 
contains(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
contains(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
contains(Object) - Method in class io.objectbox.query.LazyList
 
contains(Object) - Method in class io.objectbox.relation.ToMany
 
contains(String) - Method in class io.objectbox.Property
 
CONTAINS - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
containsAll(Collection<?>) - Method in class io.objectbox.query.LazyList
 
containsAll(Collection<?>) - Method in class io.objectbox.relation.ToMany
 
context - Static variable in class io.objectbox.BoxStore
On Android used for native library loading.
Convert - Annotation Type in io.objectbox.annotation
Specifies PropertyConverter for the field to support custom types
converter() - Method in annotation type io.objectbox.annotation.Convert
Converter class
converterClass - Variable in class io.objectbox.Property
 
convertToDatabaseValue(P) - Method in interface io.objectbox.converter.PropertyConverter
 
convertToEntityProperty(D) - Method in interface io.objectbox.converter.PropertyConverter
 
CopyOnWriteArrayListFactory() - Constructor for class io.objectbox.relation.ListFactory.CopyOnWriteArrayListFactory
 
count() - Method in class io.objectbox.Box
Returns the count of all stored objects in this box.
count() - Method in class io.objectbox.query.PropertyQuery
The count of non-null values.
count() - Method in class io.objectbox.query.Query
Returns the count of Objects matching the query.
count(long) - Method in class io.objectbox.Box
Returns the count of all stored objects in this box or the given maxCount, whichever is lower.
createDebugWithoutModel() - Static method in class io.objectbox.BoxStoreBuilder
Not for application use.
createList() - Method in class io.objectbox.relation.ListFactory.ArrayListFactory
 
createList() - Method in class io.objectbox.relation.ListFactory.CopyOnWriteArrayListFactory
 
createList() - Method in interface io.objectbox.relation.ListFactory
 
CREDENTIALS_REJECTED - Static variable in class io.objectbox.sync.SyncLoginCodes
 
customType - Variable in class io.objectbox.Property
Type, which is converted to a type supported by the DB.

D

DataObserver<T> - Interface in io.objectbox.reactive
Observer that can be subscribed to publishers (e.g.
DataPublisher<T> - Interface in io.objectbox.reactive
 
DataSubscription - Interface in io.objectbox.reactive
The result of subscribing an @DataObserver using @SubscriptionBuilder.observer(DataObserver).
dataSubscriptionList(DataSubscriptionList) - Method in class io.objectbox.reactive.SubscriptionBuilder
 
DataSubscriptionList - Class in io.objectbox.reactive
Tracks any number of DataSubscription objects, which can be canceled with a single DataSubscriptionList.cancel() call.
DataSubscriptionList() - Constructor for class io.objectbox.reactive.DataSubscriptionList
 
DataTransformer<FROM,​TO> - Interface in io.objectbox.reactive
Transforms or processes data before it is given to subscribed DataObservers.
DbDetachedException - Exception in io.objectbox.exception
 
DbDetachedException() - Constructor for exception io.objectbox.exception.DbDetachedException
 
DbDetachedException(String) - Constructor for exception io.objectbox.exception.DbDetachedException
 
DbException - Exception in io.objectbox.exception
General exception for things that may go wrong with the database.
DbException(String) - Constructor for exception io.objectbox.exception.DbException
 
DbException(String, int) - Constructor for exception io.objectbox.exception.DbException
 
DbException(String, Throwable) - Constructor for exception io.objectbox.exception.DbException
 
DbExceptionListener - Interface in io.objectbox.exception
Listener for exceptions occurring during database operations.
DbFullException - Exception in io.objectbox.exception
 
DbFullException(String) - Constructor for exception io.objectbox.exception.DbFullException
 
DbFullException(String, int) - Constructor for exception io.objectbox.exception.DbFullException
 
DbMaxReadersExceededException - Exception in io.objectbox.exception
Thrown when the maximum of readers (read transactions) was exceeded.
DbMaxReadersExceededException(String) - Constructor for exception io.objectbox.exception.DbMaxReadersExceededException
 
DbMaxReadersExceededException(String, int) - Constructor for exception io.objectbox.exception.DbMaxReadersExceededException
 
dbName - Variable in class io.objectbox.Property
 
DbSchemaException - Exception in io.objectbox.exception
 
DbSchemaException(String) - Constructor for exception io.objectbox.exception.DbSchemaException
 
DbShutdownException - Exception in io.objectbox.exception
Thrown when an error occurred that requires the DB to shutdown.
DbShutdownException(String) - Constructor for exception io.objectbox.exception.DbShutdownException
 
DbShutdownException(String, int) - Constructor for exception io.objectbox.exception.DbShutdownException
 
dbType() - Method in annotation type io.objectbox.annotation.Convert
Class of the DB type the Java property is converted to/from.
debugFlags(int) - Method in class io.objectbox.BoxStoreBuilder
Debug flags typically enable additional logging, see DebugFlags for valid values.
DebugFlags - Class in io.objectbox
Not really an enum, but binary flags to use across languages
debugRelations() - Method in class io.objectbox.BoxStoreBuilder
Enables some debug logging for relations.
debugTransactions() - Method in class io.objectbox.BoxStoreBuilder
Deprecated.
DEFAULT - io.objectbox.annotation.IndexType
Use the default index type depending on the property type: IndexType.VALUE for scalars and IndexType.HASH for Strings.
DEFAULT_MAX_DB_SIZE_KBYTE - Static variable in class io.objectbox.BoxStoreBuilder
The default maximum size the DB can grow to, which can be overwritten using BoxStoreBuilder.maxSizeInKByte.
DEFAULT_NAME - Static variable in class io.objectbox.BoxStoreBuilder
The default DB name, which can be overwritten using BoxStoreBuilder.name(String).
DelegatingObserver<T> - Interface in io.objectbox.reactive
 
deleteAllFiles() - Method in class io.objectbox.BoxStore
Danger zone! This will delete all data (files) of this BoxStore! You must call BoxStore.close() before and read the docs of that method carefully!
deleteAllFiles(File) - Static method in class io.objectbox.BoxStore
Danger zone! This will delete all files in the given directory!
deleteAllFiles(File, String) - Static method in class io.objectbox.BoxStore
Danger zone! This will delete all files in the given directory!
deleteAllFiles(Object, String) - Static method in class io.objectbox.BoxStore
Danger zone! This will delete all files in the given directory!
DESCENDING - Static variable in class io.objectbox.query.OrderFlags
Reverts the order from ascending (default) to descending.
DESCENDING - Static variable in class io.objectbox.query.QueryBuilder
Reverts the order from ascending (default) to descending.
describe() - Method in class io.objectbox.query.Query
For logging and testing, returns a string describing this query like "Query for entity Example with 4 conditions with properties prop1, prop2".
describeParameters() - Method in class io.objectbox.query.Query
For logging and testing, returns a string describing the conditions of this query like "(prop1 == A AND prop2 is null)".
diagnose() - Method in class io.objectbox.BoxStore
Gives info that can be useful for debugging.
directory(File) - Method in class io.objectbox.BoxStoreBuilder
The directory where all DB files should be placed in.
distinct() - Method in class io.objectbox.query.PropertyQuery
Only distinct values should be returned (e.g.
distinct(QueryBuilder.StringOrder) - Method in class io.objectbox.query.PropertyQuery
For string properties you can specify QueryBuilder.StringOrder.CASE_SENSITIVE if you want to have case sensitive distinct values (e.g.

E

eager(int, RelationInfo, RelationInfo...) - Method in class io.objectbox.query.QueryBuilder
Like QueryBuilder.eager(RelationInfo, RelationInfo[]), but limits eager loading to the given count.
eager(RelationInfo, RelationInfo...) - Method in class io.objectbox.query.QueryBuilder
Specifies relations that should be resolved eagerly.
enableCreationStackTracking() - Static method in class io.objectbox.InternalAccess
Makes creation more expensive, but lets Finalizers show the creation stack for dangling resources.
ENDS_WITH - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
endsWith(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
endsWith(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
endsWith(String) - Method in class io.objectbox.Property
 
entity - Variable in class io.objectbox.Property
 
entity(EntityInfo) - Method in class io.objectbox.BoxStoreBuilder
 
Entity - Annotation Type in io.objectbox.annotation
Annotation for entities ObjectBox only persist objects of classes which are marked with this annotation
EntityInfo<T> - Interface in io.objectbox
 
eq(Object) - Method in class io.objectbox.Property
Creates an "equal ('=')" condition for this property.
equal(Property<T>, boolean) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property<T>, double, double) - Method in class io.objectbox.query.QueryBuilder
Floating point equality is non-trivial; this is just a convenience for QueryBuilder.between(Property, double, double) with parameters(property, value - tolerance, value + tolerance).
equal(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
 
equals(Object) - Method in class io.objectbox.relation.ToOne
 
EQUALS - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
ErrorObserver - Interface in io.objectbox.reactive
Exceptions thrown in DataObserver and @DataTransformer can be observed by an error observer set via SubscriptionBuilder.onError(ErrorObserver).
Experimental - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Experimental are likely to change and may be even removed in a future release.

F

Factory<T> - Interface in io.objectbox
 
failedReadTxAttemptCallback(TxCallback) - Method in class io.objectbox.BoxStoreBuilder
Define a callback for failed read transactions during retires (see also BoxStoreBuilder.queryAttempts(int)).
filter(QueryFilter<T>) - Method in class io.objectbox.query.QueryBuilder
Sets a filter that executes on primary query results (returned from the db core) on a Java level.
finalize() - Method in class io.objectbox.BoxStore
Explicitly call BoxStore.close() instead to avoid expensive finalization.
finalize() - Method in class io.objectbox.query.Query
Explicitly call Query.close() instead to avoid expensive finalization.
finalize() - Method in class io.objectbox.query.QueryBuilder
Explicitly call QueryBuilder.close() instead to avoid expensive finalization.
finalize() - Method in class io.objectbox.sync.server.SyncServerImpl
 
finalize() - Method in class io.objectbox.sync.SyncClientImpl
 
find() - Method in class io.objectbox.query.Query
Find all Objects matching the query.
find(long, long) - Method in class io.objectbox.query.Query
Find all Objects matching the query between the given offset and limit.
findBoolean() - Method in class io.objectbox.query.PropertyQuery
 
findByte() - Method in class io.objectbox.query.PropertyQuery
 
findBytes() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given byte property for objects matching the query.
findChar() - Method in class io.objectbox.query.PropertyQuery
 
findChars() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given int property for objects matching the query.
findDouble() - Method in class io.objectbox.query.PropertyQuery
 
findDoubles() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given int property for objects matching the query.
findFirst() - Method in class io.objectbox.query.Query
Find the first Object matching the query.
findFloat() - Method in class io.objectbox.query.PropertyQuery
 
findFloats() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given int property for objects matching the query.
findIds() - Method in class io.objectbox.query.Query
Very efficient way to get just the IDs without creating any objects.
findIds(long, long) - Method in class io.objectbox.query.Query
Like Query.findIds() but with a offset/limit param, e.g.
findInt() - Method in class io.objectbox.query.PropertyQuery
 
findInts() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given int property for objects matching the query.
findLazy() - Method in class io.objectbox.query.Query
Find all Objects matching the query without actually loading the Objects.
findLazyCached() - Method in class io.objectbox.query.Query
Find all Objects matching the query without actually loading the Objects.
findLong() - Method in class io.objectbox.query.PropertyQuery
 
findLongs() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given long property for objects matching the query.
findShort() - Method in class io.objectbox.query.PropertyQuery
 
findShorts() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given int property for objects matching the query.
findString() - Method in class io.objectbox.query.PropertyQuery
 
findStrings() - Method in class io.objectbox.query.PropertyQuery
Find the values for the given string property for objects matching the query.
findUnique() - Method in class io.objectbox.query.Query
Find the unique Object matching the query.
forEach(QueryConsumer<T>) - Method in class io.objectbox.query.Query
Emits query results one by one to the given consumer (synchronously).

G

get(int) - Method in class io.objectbox.query.LazyList
 
get(int) - Method in class io.objectbox.relation.ToMany
 
get(long) - Method in class io.objectbox.Box
Get the stored object for the given ID.
get(long[]) - Method in class io.objectbox.Box
Get the stored objects for the given IDs.
get(Iterable<Long>) - Method in class io.objectbox.Box
Get the stored objects for the given IDs.
getActiveSubscriptionCount() - Method in class io.objectbox.reactive.DataSubscriptionList
Returns number of active (added) subscriptions (resets to 0 after DataSubscriptionList.cancel()).
getActiveTxCursor(Box<T>) - Static method in class io.objectbox.InternalAccess
 
getActiveTxCursorHandle(Box<T>) - Static method in class io.objectbox.InternalAccess
 
getAddCount() - Method in class io.objectbox.relation.ToMany
 
getAll() - Method in class io.objectbox.Box
Returns all stored Objects in this Box.
getAllEntityClasses() - Method in class io.objectbox.BoxStore
 
getAllProperties() - Method in interface io.objectbox.EntityInfo
 
getById(long) - Method in class io.objectbox.relation.ToMany
Gets an object by its entity ID.
getCachedTarget() - Method in class io.objectbox.relation.ToOne
 
getChangedIds() - Method in class io.objectbox.sync.SyncChange
IDs of objects that have been changed; e.g.
getCursorFactory() - Method in interface io.objectbox.EntityInfo
 
getDbName() - Method in interface io.objectbox.EntityInfo
 
getDefault() - Static method in class io.objectbox.BoxStore
Convenience singleton instance which gets set up using BoxStoreBuilder.buildDefault().
getEntityClass() - Method in class io.objectbox.Box
 
getEntityClass() - Method in interface io.objectbox.EntityInfo
 
getEntityId() - Method in interface io.objectbox.EntityInfo
 
getEntityId() - Method in class io.objectbox.Property
 
getEntityInfo() - Method in class io.objectbox.Box
 
getEntityName() - Method in interface io.objectbox.EntityInfo
 
getEntityTypeId() - Method in class io.objectbox.sync.SyncChange
The entity type ID; use methods like BoxStore.getEntityTypeIdOrThrow(java.lang.Class) to map with classes.
getEntityTypeIdOrThrow(Class) - Method in class io.objectbox.BoxStore
 
getErrorCode() - Method in exception io.objectbox.exception.DbException
0 == no error code available
getHandle(BoxStore) - Static method in class io.objectbox.InternalAccess
 
getHandle(Cursor) - Static method in class io.objectbox.InternalAccess
 
getHandle(Transaction) - Static method in class io.objectbox.InternalAccess
 
getId() - Method in class io.objectbox.Property
 
getId(T) - Method in class io.objectbox.Box
 
getIdGetter() - Method in interface io.objectbox.EntityInfo
 
getIdProperty() - Method in interface io.objectbox.EntityInfo
 
getLastLoginCode() - Method in interface io.objectbox.sync.SyncClient
Response code of last login attempt.
getLastLoginCode() - Method in class io.objectbox.sync.SyncClientImpl
 
getListFactory() - Method in class io.objectbox.relation.ToMany
 
getLoadedCount() - Method in class io.objectbox.query.LazyList
 
getMap(Iterable<Long>) - Method in class io.objectbox.Box
Get the stored objects for the given IDs as a Map with IDs as keys, and entities as values.
getNativeStore() - Method in class io.objectbox.BoxStore
If you want to use the same ObjectBox store using the C API, e.g.
getObjectBrowserPort() - Method in class io.objectbox.BoxStore
 
getObserverDelegate() - Method in interface io.objectbox.reactive.DelegatingObserver
 
getPort() - Method in interface io.objectbox.sync.server.SyncServer
Gets the port the server has bound to.
getPort() - Method in class io.objectbox.sync.server.SyncServerImpl
 
getReader(Box<T>) - Static method in class io.objectbox.InternalAccess
 
getReaderDebugInfo() - Method in class io.objectbox.Box
 
getRelationBacklinkEntities(RelationInfo<T, ?>, long) - Method in class io.objectbox.Box
Given a ToMany relation and the ID of a target entity gets all source entities pointing to this target entity, for example customerBox.getRelationEntities(Customer_.orders, order.getId()).
getRelationBacklinkIds(RelationInfo<T, ?>, long) - Method in class io.objectbox.Box
Like Box.getRelationBacklinkEntities(RelationInfo, long), but only returns the IDs of the source entities.
getRelationEntities(RelationInfo<?, T>, long) - Method in class io.objectbox.Box
Given a ToMany relation and the ID of a source entity gets the target entities of the relation from their box, for example orderBox.getRelationEntities(Customer_.orders, customer.getId()).
getRelationIds(RelationInfo<?, T>, long) - Method in class io.objectbox.Box
Like Box.getRelationEntities(RelationInfo, long), but only returns the IDs of the target entities.
getRemoveCount() - Method in class io.objectbox.relation.ToMany
 
getRemovedIds() - Method in class io.objectbox.sync.SyncChange
IDs of objects that have been removed.
getServerUrl() - Method in interface io.objectbox.sync.SyncClient
Gets the sync server URL this client is connected to.
getServerUrl() - Method in class io.objectbox.sync.SyncClientImpl
 
getStatsString() - Method in interface io.objectbox.sync.server.SyncServer
Gets some statistics from the sync server.
getStatsString() - Method in class io.objectbox.sync.server.SyncServerImpl
 
getStore() - Method in class io.objectbox.Box
 
getTarget() - Method in class io.objectbox.relation.ToOne
 
getTarget(long) - Method in class io.objectbox.relation.ToOne
If property backed, entities can pass the target ID to avoid reflection.
getTargetId() - Method in class io.objectbox.relation.ToOne
 
getTokenBytes() - Method in class io.objectbox.sync.SyncCredentialsToken
 
getTypeId() - Method in class io.objectbox.sync.SyncCredentialsToken
 
getUrl() - Method in interface io.objectbox.sync.server.SyncServer
Gets the URL the server is running at.
getUrl() - Method in class io.objectbox.sync.server.SyncServerImpl
 
getVersion() - Static method in class io.objectbox.BoxStore
Gets the Version of ObjectBox Java.
getVersionNative() - Static method in class io.objectbox.BoxStore
Gets the Version of ObjectBox Core.
getWriter(Box<T>) - Static method in class io.objectbox.InternalAccess
 
google(String) - Static method in class io.objectbox.sync.SyncCredentials
Authenticate with a Google account ID token obtained via Google Sign-In.
GOOGLE - io.objectbox.sync.SyncCredentials.CredentialsType
 
greater(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property<T>, double) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
 
GREATER_THAN - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
gt(Object) - Method in class io.objectbox.Property
Creates an "greater than ('>')" condition for this property.

H

hasA(QueryFilter<TARGET>) - Method in class io.objectbox.relation.ToMany
Returns true if at least one of the entities matches the given filter.
hasAll(QueryFilter<TARGET>) - Method in class io.objectbox.relation.ToMany
Returns true if all of the entities match the given filter.
HASH - io.objectbox.annotation.IndexType
Use a (fast non-cryptographic) hash of the property value to build the index.
HASH64 - io.objectbox.annotation.IndexType
Use a long (fast non-cryptographic) hash of the property value to build the index.
hashCode() - Method in class io.objectbox.relation.ToOne
 
hasNext() - Method in class io.objectbox.query.LazyList.LazyIterator
 
hasPendingDbChanges() - Method in class io.objectbox.relation.ToMany
Returns true if there are pending changes for the DB.
hasPrevious() - Method in class io.objectbox.query.LazyList.LazyIterator
FIXME: before hasPrevious(), next() must be called.

I

id - Variable in class io.objectbox.Property
 
id - Variable in enum io.objectbox.sync.SyncCredentials.CredentialsType
 
Id - Annotation Type in io.objectbox.annotation
Marks the ID property of an @Entity.
in(Property<T>, int[]) - Method in class io.objectbox.query.QueryBuilder
 
in(Property<T>, long[]) - Method in class io.objectbox.query.QueryBuilder
 
in(Property<T>, String[]) - Method in class io.objectbox.query.QueryBuilder
 
in(Property<T>, String[], QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
in(Object...) - Method in class io.objectbox.Property
Creates an "IN (..., ..., ...)" condition for this property.
in(Collection<?>) - Method in class io.objectbox.Property
Creates an "IN (..., ..., ...)" condition for this property.
IN - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
Index - Annotation Type in io.objectbox.annotation
Specifies that the property should be indexed.
indexOf(Object) - Method in class io.objectbox.query.LazyList
 
indexOf(Object) - Method in class io.objectbox.relation.ToMany
 
indexOfId(long) - Method in class io.objectbox.relation.ToMany
Gets the index of the object with the given entity ID.
IndexType - Enum in io.objectbox.annotation
ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see IndexType.DEFAULT).
initialDbFile(Factory<InputStream>) - Method in class io.objectbox.BoxStoreBuilder
Let's you specify a provider for a DB file to be used during initial start of the app (no DB file exists yet).
initialDbFile(File) - Method in class io.objectbox.BoxStoreBuilder
Let's you specify an DB file to be used during initial start of the app (no DB file exists yet).
Internal - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Internal must NOT be used.
InternalAccess - Class in io.objectbox
 
InternalAccess() - Constructor for class io.objectbox.InternalAccess
 
internalApplyToDb(Cursor, Cursor<TARGET>) - Method in class io.objectbox.relation.ToMany
For internal use only; do not use in your app.
internalCallWithReaderHandle(CallWithHandle<RESULT>) - Method in class io.objectbox.Box
 
internalCallWithWriterHandle(CallWithHandle<RESULT>) - Method in class io.objectbox.Box
 
internalCheckApplyToDbRequired() - Method in class io.objectbox.relation.ToMany
For internal use only; do not use in your app.
internalFailedReadTxAttemptCallback() - Method in class io.objectbox.BoxStore
 
internalGetBacklinkEntities(int, Property, long) - Method in class io.objectbox.Box
 
internalGetRelationEntities(int, int, long, boolean) - Method in class io.objectbox.Box
 
internalGetRelationIds(int, int, long, boolean) - Method in class io.objectbox.Box
 
internalPutTarget(Cursor<TARGET>) - Method in class io.objectbox.relation.ToOne
 
internalQueryAttempts() - Method in class io.objectbox.BoxStore
 
internalRequiresPutTarget() - Method in class io.objectbox.relation.ToOne
 
internalScheduleThread(Runnable) - Method in class io.objectbox.BoxStore
 
internalThreadPool() - Method in class io.objectbox.BoxStore
 
io.objectbox - package io.objectbox
ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
io.objectbox.annotation - package 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 - package io.objectbox.annotation.apihint
Annotations to mark APIs as for example @Internal or @Experimental.
io.objectbox.converter - package io.objectbox.converter
For use with @Convert: PropertyConverter to convert custom property types.
io.objectbox.exception - package io.objectbox.exception
Various exceptions thrown by ObjectBox.
io.objectbox.query - package io.objectbox.query
Classes related to building a Query or PropertyQuery.
io.objectbox.reactive - package io.objectbox.reactive
Classes to configure a DataSubscription for observing box or query changes.
io.objectbox.relation - package io.objectbox.relation
Classes to manage ToOne and ToMany relations between entities.
io.objectbox.sync - package io.objectbox.sync
ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g.
io.objectbox.sync.server - package io.objectbox.sync.server
 
IS_NOT_NULL - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
IS_NULL - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
isBacklink() - Method in class io.objectbox.relation.RelationInfo
 
isCanceled() - Method in interface io.objectbox.reactive.DataSubscription
Current cancellation state of the subscription.
isCanceled() - Method in class io.objectbox.reactive.DataSubscriptionList
Returns true if DataSubscriptionList.cancel() was called without any subsequent calls to DataSubscriptionList.add(DataSubscription).
isClosed() - Method in class io.objectbox.BoxStore
 
isDebugRelations() - Method in class io.objectbox.BoxStore
 
isEmpty() - Method in class io.objectbox.Box
Returns true if no objects are in this box.
isEmpty() - Method in class io.objectbox.query.LazyList
 
isEmpty() - Method in class io.objectbox.relation.ToMany
 
isId - Variable in class io.objectbox.Property
 
isLoadedCompletely() - Method in class io.objectbox.query.LazyList
 
isLoggedIn() - Method in interface io.objectbox.sync.SyncClient
Flag indicating if the sync client was started.
isLoggedIn() - Method in class io.objectbox.sync.SyncClientImpl
 
isNotNull() - Method in class io.objectbox.Property
Creates an "IS NOT NULL" condition for this property.
isNull() - Method in class io.objectbox.Property
Creates an "IS NULL" condition for this property.
isNull() - Method in class io.objectbox.relation.ToOne
 
isNull(Property<T>) - Method in class io.objectbox.query.QueryBuilder
 
isObjectBrowserAvailable() - Static method in class io.objectbox.BoxStore
 
isObjectBrowserRunning() - Method in class io.objectbox.BoxStore
 
isResolved() - Method in class io.objectbox.relation.ToMany
 
isResolved() - Method in class io.objectbox.relation.ToOne
 
isResolvedAndNotNull() - Method in class io.objectbox.relation.ToOne
 
isRunning() - Method in interface io.objectbox.sync.server.SyncServer
Returns if the server is up and running.
isRunning() - Method in class io.objectbox.sync.server.SyncServerImpl
 
isStarted() - Method in interface io.objectbox.sync.SyncClient
Flag indicating if the sync client was started.
isStarted() - Method in class io.objectbox.sync.SyncClientImpl
 
isSyncAvailable() - Static method in class io.objectbox.BoxStore
 
isSyncServerAvailable() - Static method in class io.objectbox.BoxStore
 
isVirtual - Variable in class io.objectbox.Property
 
iterator() - Method in class io.objectbox.query.LazyList
 
iterator() - Method in class io.objectbox.relation.ToMany
 

J

JNI_VERSION - Static variable in class io.objectbox.BoxStore
Change so ReLinker will update native library when using workaround loading.

K

keep(T) - Method in interface io.objectbox.query.QueryFilter
 

L

lastIndexOf(Object) - Method in class io.objectbox.query.LazyList
 
lastIndexOf(Object) - Method in class io.objectbox.relation.ToMany
 
LazyIterator(int) - Constructor for class io.objectbox.query.LazyList.LazyIterator
 
LazyList<E> - Class in io.objectbox.query
A thread-safe, unmodifiable list that reads entities lazily once they are accessed.
LazyList.LazyIterator - Class in io.objectbox.query
 
less(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
 
less(Property<T>, double) - Method in class io.objectbox.query.QueryBuilder
 
less(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
 
less(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
less(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
less(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
 
LESS_THAN - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
link(RelationInfo<?, TARGET>) - Method in class io.objectbox.query.QueryBuilder
Creates a link to another entity, for which you also can describe conditions using the returned builder.
listener(SyncClientListener) - Method in class io.objectbox.sync.SyncBuilder
Sets a listener to observe sync events like login or sync completion.
ListFactory - Interface in io.objectbox.relation
 
ListFactory.ArrayListFactory - Class in io.objectbox.relation
 
ListFactory.CopyOnWriteArrayListFactory - Class in io.objectbox.relation
 
listIterator() - Method in class io.objectbox.query.LazyList
 
listIterator() - Method in class io.objectbox.relation.ToMany
 
listIterator(int) - Method in class io.objectbox.query.LazyList
 
listIterator(int) - Method in class io.objectbox.relation.ToMany
The returned iterator does not track any potential calls to Iterator.remove().
loadRemaining() - Method in class io.objectbox.query.LazyList
Loads the remaining entities (if any) that were not loaded before.
LOG_ASYNC_QUEUE - Static variable in class io.objectbox.DebugFlags
 
LOG_CACHE_ALL - Static variable in class io.objectbox.DebugFlags
 
LOG_CACHE_HITS - Static variable in class io.objectbox.DebugFlags
 
LOG_QUERIES - Static variable in class io.objectbox.DebugFlags
 
LOG_QUERY_PARAMETERS - Static variable in class io.objectbox.DebugFlags
 
LOG_TRANSACTIONS_READ - Static variable in class io.objectbox.DebugFlags
 
LOG_TRANSACTIONS_WRITE - Static variable in class io.objectbox.DebugFlags
 
lt(Object) - Method in class io.objectbox.Property
Creates an "less than ('<')" condition for this property.

M

manualStart() - Method in class io.objectbox.sync.server.SyncServerBuilder
Prevents the server from starting automatically.
manualStart() - Method in class io.objectbox.sync.SyncBuilder
Prevents the client from starting (connecting, logging in, syncing) automatically.
manualUpdateRequests() - Method in class io.objectbox.sync.SyncBuilder
Disables automatic sync updates from the server.
max() - Method in class io.objectbox.query.PropertyQuery
Finds the maximum value for the given property over all Objects matching the query.
maxDouble() - Method in class io.objectbox.query.PropertyQuery
Finds the maximum value for the given property over all Objects matching the query.
maxReaders(int) - Method in class io.objectbox.BoxStoreBuilder
Sets the maximum number of concurrent readers.
maxSizeInKByte(long) - Method in class io.objectbox.BoxStoreBuilder
Sets the maximum size the database file can grow to.
min() - Method in class io.objectbox.query.PropertyQuery
Finds the minimum value for the given property over all Objects matching the query.
minDouble() - Method in class io.objectbox.query.PropertyQuery
Finds the minimum value for the given property over all objects matching the query.

N

name - Variable in class io.objectbox.Property
 
name(int) - Static method in class io.objectbox.query.OrderFlags
 
name(String) - Method in class io.objectbox.BoxStoreBuilder
Name of the database, which will be used as a directory for DB files.
NameInDb - Annotation Type in io.objectbox.annotation
Allows to specify a simple name mapping for entities and properties.
names - Static variable in class io.objectbox.query.OrderFlags
 
next() - Method in class io.objectbox.query.LazyList.LazyIterator
 
nextIndex() - Method in class io.objectbox.query.LazyList.LazyIterator
 
none() - Static method in class io.objectbox.sync.SyncCredentials
No authentication, insecure.
NONE - io.objectbox.sync.SyncCredentials.CredentialsType
 
NonUniqueResultException - Exception in io.objectbox.exception
Throw if Query.findUnique() returns more than one result.
NonUniqueResultException(String) - Constructor for exception io.objectbox.exception.NonUniqueResultException
 
NOT_EQUALS - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
notEq(Object) - Method in class io.objectbox.Property
Creates an "not equal ('<>')" condition for this property.
notEqual(Property<T>, boolean) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
 
notIn(Property<T>, int[]) - Method in class io.objectbox.query.QueryBuilder
 
notIn(Property<T>, long[]) - Method in class io.objectbox.query.QueryBuilder
 
notNull(Property<T>) - Method in class io.objectbox.query.QueryBuilder
 
NULLS_LAST - Static variable in class io.objectbox.query.OrderFlags
null values will be put last.
NULLS_LAST - Static variable in class io.objectbox.query.QueryBuilder
null values will be put last.
NULLS_ZERO - Static variable in class io.objectbox.query.OrderFlags
null values should be treated equal to zero (scalars only).
NULLS_ZERO - Static variable in class io.objectbox.query.QueryBuilder
null values should be treated equal to zero (scalars only).
nullValue(Object) - Method in class io.objectbox.query.PropertyQuery
By default, null values are not returned by find methods (primitive arrays cannot contains nulls).
NumericOverflowException - Exception in io.objectbox.exception
Thrown if a property query aggregate function can not compute a result due to a number type overflowing.
NumericOverflowException(String) - Constructor for exception io.objectbox.exception.NumericOverflowException
 

O

observer(DataObserver<T>) - Method in class io.objectbox.reactive.SubscriptionBuilder
The given observer is subscribed to the publisher.
OK - Static variable in class io.objectbox.sync.SyncLoginCodes
 
on(Scheduler) - Method in class io.objectbox.reactive.SubscriptionBuilder
Changes the thread in which the DataObserver (and potentially @ErrorObserver) is called.
onData(T) - Method in interface io.objectbox.reactive.DataObserver
Called when data changed.
onDbException(Exception) - Method in interface io.objectbox.exception.DbExceptionListener
Called when an exception is thrown during a database operation.
onDisconnect() - Method in class io.objectbox.sync.AbstractSyncClientListener
 
onDisconnect() - Method in interface io.objectbox.sync.SyncClientListener
Called when the client is disconnected from the sync server, e.g.
onError(ErrorObserver) - Method in class io.objectbox.reactive.SubscriptionBuilder
onError(Throwable) - Method in interface io.objectbox.reactive.ErrorObserver
Called when an exception was thrown.
onLogin() - Method in class io.objectbox.sync.AbstractSyncClientListener
 
onLogin() - Method in interface io.objectbox.sync.SyncClientListener
Called on a successful login.
onLoginFailure(long) - Method in class io.objectbox.sync.AbstractSyncClientListener
 
onLoginFailure(long) - Method in interface io.objectbox.sync.SyncClientListener
Called on a login failure.
onlyChanges() - Method in class io.objectbox.reactive.SubscriptionBuilder
 
onSyncChanges(SyncChange[]) - Method in interface io.objectbox.sync.SyncChangesListener
Called each time when data from sync was applied locally.
onSyncComplete() - Method in class io.objectbox.sync.AbstractSyncClientListener
 
onSyncComplete() - Method in interface io.objectbox.sync.SyncClientListener
Called each time a sync was "completed", in the sense that the client caught up with the current server state.
or() - Method in class io.objectbox.query.QueryBuilder
Combines the previous condition with the following condition with a logical OR.
order(Property<T>) - Method in class io.objectbox.query.QueryBuilder
Specifies given property to be used for sorting.
order(Property<T>, int) - Method in class io.objectbox.query.QueryBuilder
Defines the order with which the results are ordered (default: none).
orderDesc(Property<T>) - Method in class io.objectbox.query.QueryBuilder
Specifies given property in descending order to be used for sorting.
OrderFlags - Class in io.objectbox.query
Not really an enum, but binary flags to use across languages
ordinal - Variable in class io.objectbox.Property
 

P

panicModeRemoveAll() - Method in class io.objectbox.Box
WARNING: this method should generally be avoided as it is not transactional and thus may leave the DB in an inconsistent state.
parameterAlias(String) - Method in class io.objectbox.query.QueryBuilder
Asigns the given alias to the previous condition.
peek(int) - Method in class io.objectbox.query.LazyList
Like get but does not load the entity if it was not loaded before.
peer(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
Adds a server peer, to which this server should connect to as a client using SyncCredentials.none().
peer(String, SyncCredentials) - Method in class io.objectbox.sync.server.SyncServerBuilder
Adds a server peer, to which this server should connect to as a client using the given credentials.
previous() - Method in class io.objectbox.query.LazyList.LazyIterator
FIXME: before previous(), next() must be called.
previousIndex() - Method in class io.objectbox.query.LazyList.LazyIterator
 
property - Variable in class io.objectbox.query.QueryCondition.PropertyCondition
 
property(Property) - Method in class io.objectbox.query.Query
Creates a PropertyQuery for the given property.
Property<ENTITY> - Class in io.objectbox
Meta data describing a property of an ObjectBox entity.
Property(EntityInfo<ENTITY>, int, int, Class<?>, String) - Constructor for class io.objectbox.Property
 
Property(EntityInfo<ENTITY>, int, int, Class<?>, String, boolean) - Constructor for class io.objectbox.Property
 
Property(EntityInfo<ENTITY>, int, int, Class<?>, String, boolean, boolean, String, Class<? extends PropertyConverter>, Class) - Constructor for class io.objectbox.Property
 
Property(EntityInfo<ENTITY>, int, int, Class<?>, String, boolean, String) - Constructor for class io.objectbox.Property
 
Property(EntityInfo<ENTITY>, int, int, Class<?>, String, boolean, String, Class<? extends PropertyConverter>, Class) - Constructor for class io.objectbox.Property
 
PropertyCondition(Property, QueryCondition.PropertyCondition.Operation, Object) - Constructor for class io.objectbox.query.QueryCondition.PropertyCondition
 
PropertyCondition(Property, QueryCondition.PropertyCondition.Operation, Object[]) - Constructor for class io.objectbox.query.QueryCondition.PropertyCondition
 
PropertyConverter<P,​D> - Interface in io.objectbox.converter
To use custom types in your entity, implement this to convert db values to entity values and back.
PropertyQuery - Class in io.objectbox.query
Query for a specific property; create using Query.property(Property).
provide() - Method in interface io.objectbox.Factory
 
publish() - Method in class io.objectbox.query.Query
Publishes the current data to all subscribed @DataObservers.
publishSingle(DataObserver<T>, Object) - Method in interface io.objectbox.reactive.DataPublisher
 
put(Collection<T>) - Method in class io.objectbox.Box
Puts the given entities in a box using a single transaction.
put(T) - Method in class io.objectbox.Box
Puts the given object in the box (aka persisting it).
put(T...) - Method in class io.objectbox.Box
Puts the given entities in a box using a single transaction.
putBatched(Collection<T>, int) - Method in class io.objectbox.Box
Puts the given entities in a box in batches using a separate transaction for each batch.

Q

query() - Method in class io.objectbox.Box
Returns a builder to create queries for Object matching supplied criteria.
Query<T> - Class in io.objectbox.query
A repeatable query returning entities.
queryAttempts(int) - Method in class io.objectbox.BoxStoreBuilder
For massive concurrent setups (app is using a lot of threads), you can enable automatic retries for queries.
QueryBuilder<T> - Class in io.objectbox.query
With QueryBuilder you define custom queries returning matching entities.
QueryBuilder(Box<T>, long, String) - Constructor for class io.objectbox.query.QueryBuilder
 
QueryBuilder.StringOrder - Enum in io.objectbox.query
 
QueryCondition - Interface in io.objectbox.query
Internal interface to model WHERE conditions used in queries.
QueryCondition.AbstractCondition - Class in io.objectbox.query
 
QueryCondition.PropertyCondition - Class in io.objectbox.query
 
QueryCondition.PropertyCondition.Operation - Enum in io.objectbox.query
 
QueryConsumer<T> - Interface in io.objectbox.query
 
QueryFilter<T> - Interface in io.objectbox.query
Decides which entities to keep as a query result.

R

relationId - Variable in class io.objectbox.relation.RelationInfo
For stand-alone to-many relations (0 otherwise).
RelationInfo<SOURCE,​TARGET> - Class in io.objectbox.relation
Meta info describing a relation including source and target entity.
RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, ToManyGetter, int) - Constructor for class io.objectbox.relation.RelationInfo
Stand-alone ToMany.
RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, ToManyGetter, ToManyGetter, int) - Constructor for class io.objectbox.relation.RelationInfo
ToMany as a ToMany backlink
RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, ToManyGetter, Property, ToOneGetter) - Constructor for class io.objectbox.relation.RelationInfo
ToMany as a ToOne backlink
RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, Property, ToOneGetter) - Constructor for class io.objectbox.relation.RelationInfo
ToOne
releaseReader(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
 
releaseWriter(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
 
relinker - Static variable in class io.objectbox.BoxStore
 
remove() - Method in class io.objectbox.query.LazyList.LazyIterator
 
remove() - Method in class io.objectbox.query.Query
Removes (deletes) all Objects matching the query
remove(int) - Method in class io.objectbox.query.LazyList
 
remove(int) - Method in class io.objectbox.relation.ToMany
 
remove(long) - Method in class io.objectbox.Box
Removes (deletes) the Object by its ID.
remove(long...) - Method in class io.objectbox.Box
Removes (deletes) Objects by their ID in a single transaction.
remove(Object) - Method in class io.objectbox.query.LazyList
 
remove(Object) - Method in class io.objectbox.relation.ToMany
 
remove(Collection<T>) - Method in class io.objectbox.Box
Removes (deletes) the given Objects in a single transaction.
remove(T) - Method in class io.objectbox.Box
Removes (deletes) the given Object.
remove(T...) - Method in class io.objectbox.Box
Removes (deletes) the given Objects in a single transaction.
removeAll() - Method in class io.objectbox.Box
Removes (deletes) ALL Objects in a single transaction.
removeAll(Collection<?>) - Method in class io.objectbox.query.LazyList
 
removeAll(Collection<?>) - Method in class io.objectbox.relation.ToMany
 
removeAllObjects() - Method in class io.objectbox.BoxStore
Removes all objects from all boxes, e.g.
removeById(long) - Method in class io.objectbox.relation.ToMany
Removes an object by its entity ID.
removeByIds(Collection<Long>) - Method in class io.objectbox.Box
Due to type erasure collision, we cannot simply use "remove" as a method name here.
removeByKeys(Collection<Long>) - Method in class io.objectbox.Box
Deprecated.
removeSyncChangesListener() - Method in interface io.objectbox.sync.server.SyncServer
Removes a previously set SyncChangesListener.
removeSyncChangesListener() - Method in class io.objectbox.sync.server.SyncServerImpl
 
removeSyncChangesListener() - Method in interface io.objectbox.sync.SyncClient
Removes a previously set SyncChangesListener.
removeSyncChangesListener() - Method in class io.objectbox.sync.SyncClientImpl
 
removeSyncListener() - Method in interface io.objectbox.sync.SyncClient
Removes a previously set SyncClientListener.
removeSyncListener() - Method in class io.objectbox.sync.SyncClientImpl
 
requestFullSync() - Method in interface io.objectbox.sync.SyncClient
Experimental.
requestFullSync() - Method in class io.objectbox.sync.SyncClientImpl
 
requestFullSyncAndUpdates() - Method in class io.objectbox.sync.SyncClientImpl
 
requestUpdates() - Method in interface io.objectbox.sync.SyncClient
Asks the sync server to resume sync updates.
requestUpdates() - Method in class io.objectbox.sync.SyncClientImpl
 
requestUpdatesOnce() - Method in interface io.objectbox.sync.SyncClient
Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again.
requestUpdatesOnce() - Method in class io.objectbox.sync.SyncClientImpl
 
reset() - Method in class io.objectbox.query.PropertyQuery
Clears all values (e.g.
reset() - Method in class io.objectbox.relation.ToMany
Resets the already loaded entities so they will be re-loaded on their next access.
retainAll(Collection<?>) - Method in class io.objectbox.query.LazyList
 
retainAll(Collection<?>) - Method in class io.objectbox.relation.ToMany
 
run(RunWithParam, T) - Method in interface io.objectbox.reactive.Scheduler
 
run(T) - Method in interface io.objectbox.reactive.RunWithParam
 
runInReadTx(Runnable) - Method in class io.objectbox.BoxStore
Runs the given runnable inside a read(-only) transaction.
runInTx(Runnable) - Method in class io.objectbox.BoxStore
Runs the given runnable inside a transaction.
runInTxAsync(Runnable, TxCallback<Void>) - Method in class io.objectbox.BoxStore
Runs the given Runnable as a transaction in a separate thread.
RunWithParam<T> - Interface in io.objectbox.reactive
 

S

Scheduler - Interface in io.objectbox.reactive
 
server(BoxStore, String, SyncCredentials) - Static method in class io.objectbox.sync.Sync
Start building a sync server.
set(int, E) - Method in class io.objectbox.query.LazyList
 
set(int, TARGET) - Method in class io.objectbox.relation.ToMany
 
set(E) - Method in class io.objectbox.query.LazyList.LazyIterator
 
setAndPutTarget(TARGET) - Method in class io.objectbox.relation.ToOne
Sets or clears the target entity and ID in the source entity, then puts the source entity to persist changes.
setAndPutTargetAlways(TARGET) - Method in class io.objectbox.relation.ToOne
Sets or clears the target entity and ID in the source entity, then puts the target (if not null) and source entity to persist changes.
setComparator(Comparator<TARGET>) - Method in class io.objectbox.relation.ToMany
Set an comparator to define the order of entities.
setDbExceptionListener(DbExceptionListener) - Method in class io.objectbox.BoxStore
The given listener will be called when an exception is thrown.
setListFactory(ListFactory) - Method in class io.objectbox.relation.ToMany
Currently only used for non-persisted entities (id == 0).
setLoginCredentials(SyncCredentials) - Method in interface io.objectbox.sync.SyncClient
Updates the login credentials.
setLoginCredentials(SyncCredentials) - Method in class io.objectbox.sync.SyncClientImpl
 
setParameter(Property, boolean) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(Property, byte[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameter(Property, double) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(Property, long) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(Property, String) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(Property, Date) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(String, boolean) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(String, byte[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameter(String, double) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(String, long) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(String, String) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameter(String, Date) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to a new value.
setParameterFor(Query, Object) - Method in class io.objectbox.query.QueryCondition.PropertyCondition
 
setParameterFor(Query, Object) - Method in interface io.objectbox.query.QueryCondition
 
setParameterFor(Query, Object, Object) - Method in class io.objectbox.query.QueryCondition.PropertyCondition
 
setParameterFor(Query, Object, Object) - Method in interface io.objectbox.query.QueryCondition
 
setParameters(Property, double, double) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(Property, int[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(Property, long[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(Property, long, long) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(Property, String[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(String, double, double) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(String, int[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(String, long[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(String, long, long) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(String, String[]) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setRemoveFromTargetBox(boolean) - Method in class io.objectbox.relation.ToMany
On put, this also deletes removed entities from the target Box.
setSyncChangesListener(SyncChangesListener) - Method in interface io.objectbox.sync.server.SyncServer
setSyncChangesListener(SyncChangesListener) - Method in class io.objectbox.sync.server.SyncServerImpl
 
setSyncChangesListener(SyncChangesListener) - Method in interface io.objectbox.sync.SyncClient
setSyncChangesListener(SyncChangesListener) - Method in class io.objectbox.sync.SyncClientImpl
 
setSyncListener(SyncClientListener) - Method in interface io.objectbox.sync.SyncClient
setSyncListener(SyncClientListener) - Method in class io.objectbox.sync.SyncClientImpl
 
setTarget(TARGET) - Method in class io.objectbox.relation.ToOne
Sets or clears the target entity and ID in the source entity.
setTargetId(long) - Method in class io.objectbox.relation.ToOne
Sets or clears the target ID in the source entity.
single() - Method in class io.objectbox.reactive.SubscriptionBuilder
 
size() - Method in class io.objectbox.query.LazyList
 
size() - Method in class io.objectbox.relation.ToMany
 
sort(Comparator<T>) - Method in class io.objectbox.query.QueryBuilder
 
sortById() - Method in class io.objectbox.relation.ToMany
Sorts the list by the "natural" ObjectBox order for to-many list (by entity ID).
sourceInfo - Variable in class io.objectbox.relation.RelationInfo
 
start() - Method in interface io.objectbox.sync.server.SyncServer
Starts the server (e.g.
start() - Method in class io.objectbox.sync.server.SyncServerImpl
 
start() - Method in interface io.objectbox.sync.SyncClient
Starts the client.
start() - Method in class io.objectbox.sync.SyncClientImpl
 
startObjectBrowser() - Method in class io.objectbox.BoxStore
 
startObjectBrowser(int) - Method in class io.objectbox.BoxStore
 
startObjectBrowser(String) - Method in class io.objectbox.BoxStore
 
STARTS_WITH - io.objectbox.query.QueryCondition.PropertyCondition.Operation
 
startsWith(Property<T>, String) - Method in class io.objectbox.query.QueryBuilder
 
startsWith(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
startsWith(String) - Method in class io.objectbox.Property
 
stop() - Method in interface io.objectbox.sync.server.SyncServer
Stops the server.
stop() - Method in class io.objectbox.sync.server.SyncServerImpl
 
stop() - Method in interface io.objectbox.sync.SyncClient
Stops the client.
stop() - Method in class io.objectbox.sync.SyncClientImpl
 
stopObjectBrowser() - Method in class io.objectbox.BoxStore
 
subList(int, int) - Method in class io.objectbox.query.LazyList
 
subList(int, int) - Method in class io.objectbox.relation.ToMany
The returned sub list does not do any change tracking.
subscribe() - Method in class io.objectbox.BoxStore
A DataObserver can be subscribed to data changes using the returned builder.
subscribe() - Method in class io.objectbox.query.Query
A DataObserver can be subscribed to data changes using the returned builder.
subscribe(DataObserver<T>, Object) - Method in interface io.objectbox.reactive.DataPublisher
 
subscribe(DataSubscriptionList) - Method in class io.objectbox.query.Query
subscribe(Class<T>) - Method in class io.objectbox.BoxStore
Like BoxStore.subscribe(), but wires the supplied @DataObserver only to the given object class for notifications.
SubscriptionBuilder<T> - Class in io.objectbox.reactive
SubscriptionBuilder(DataPublisher<T>, Object, ExecutorService) - Constructor for class io.objectbox.reactive.SubscriptionBuilder
 
sum() - Method in class io.objectbox.query.PropertyQuery
Sums up all values for the given property over all Objects matching the query.
sumDouble() - Method in class io.objectbox.query.PropertyQuery
Sums up all values for the given property over all Objects matching the query.
Sync - Class in io.objectbox.sync
Start building a sync client using Sync.Sync.client(BoxStore, String, SyncCredentials) or a server using Sync.Sync.server(BoxStore, String, SyncCredentials).
SyncBuilder - Class in io.objectbox.sync
A builder to create a SyncClient; the builder itself should be created via Sync.client(BoxStore, String, SyncCredentials).
SyncBuilder(BoxStore, String, SyncCredentials) - Constructor for class io.objectbox.sync.SyncBuilder
 
SyncChange - Class in io.objectbox.sync
A collection of changes made to one entity type during a sync transaction.
SyncChange(long, long[], long[]) - Constructor for class io.objectbox.sync.SyncChange
 
SyncChangesListener - Interface in io.objectbox.sync
Notifies of fine granular changes on the object level happening during sync.
SyncClient - Interface in io.objectbox.sync
ObjectBox sync client.
SyncClientImpl - Class in io.objectbox.sync
Internal sync client implementation.
SyncClientListener - Interface in io.objectbox.sync
This listener has callback methods invoked by fundamental synchronization events.
SyncCredentials - Class in io.objectbox.sync
Use the static helper methods to build sync credentials, for example SyncCredentials.apiKey("key").
SyncCredentials.CredentialsType - Enum in io.objectbox.sync
 
SyncCredentialsToken - Class in io.objectbox.sync
Internal credentials implementation.
SyncLoginCodes - Class in io.objectbox.sync
SyncServer - Interface in io.objectbox.sync.server
ObjectBox sync server.
SyncServerBuilder - Class in io.objectbox.sync.server
Creates a SyncServer and allows to set additional configuration.
SyncServerBuilder(BoxStore, String, SyncCredentials) - Constructor for class io.objectbox.sync.server.SyncServerBuilder
 
SyncServerImpl - Class in io.objectbox.sync.server
Internal sync server implementation.

T

targetIdProperty - Variable in class io.objectbox.relation.RelationInfo
For relations based on a target ID property (null otherwise).
TargetIdProperty - Annotation Type in io.objectbox.annotation
Defines the property serving as the target ID of a ToOne.
targetInfo - Variable in class io.objectbox.relation.RelationInfo
 
targetRelationId - Variable in class io.objectbox.relation.RelationInfo
For ToMany relations based on ToMany backlinks (0 otherwise).
Temporary - Annotation Type in io.objectbox.annotation.apihint
APIs annotated with @Temporary will most likely be replaced with another API in a future release.
testUnalignedMemoryAccess() - Static method in class io.objectbox.BoxStore
Diagnostics: If this method crashes on a device, please send us the logcat output.
to() - Method in annotation type io.objectbox.annotation.Backlink
Name of the relation the backlink should be based on (e.g.
toArray() - Method in class io.objectbox.query.LazyList
 
toArray() - Method in class io.objectbox.relation.ToMany
 
toArray(T[]) - Method in class io.objectbox.query.LazyList
 
toArray(T[]) - Method in class io.objectbox.relation.ToMany
 
ToMany<TARGET> - Class in io.objectbox.relation
A List representing a to-many relation.
ToMany(Object, RelationInfo<? extends Object, TARGET>) - Constructor for class io.objectbox.relation.ToMany
 
toManyGetter - Variable in class io.objectbox.relation.RelationInfo
Only set for ToMany relations
ToOne<TARGET> - Class in io.objectbox.relation
Manages a to-one relation: resolves the target object, keeps the target Id in sync, etc.
ToOne(Object, RelationInfo) - Constructor for class io.objectbox.relation.ToOne
In Java, the constructor call is generated by the ObjectBox plugin.
toOneGetter - Variable in class io.objectbox.relation.RelationInfo
Only set for ToOne relations
toString() - Method in exception io.objectbox.exception.DbException
 
toString() - Method in class io.objectbox.Property
 
toString() - Method in class io.objectbox.relation.RelationInfo
 
transform(FROM) - Method in interface io.objectbox.reactive.DataTransformer
Transforms/processes the given data.
transform(DataTransformer<T, TO>) - Method in class io.objectbox.reactive.SubscriptionBuilder
Transforms the original data from the publisher to something that is more helpful to your application.
Transient - Annotation Type in io.objectbox.annotation
Transient fields are not persisted in the database.
TxCallback<T> - Interface in io.objectbox
txFinished(T, Throwable) - Method in interface io.objectbox.TxCallback
Called when an asynchronous transaction finished.
type - Variable in class io.objectbox.Property
One of the supported types to be mapped to the DB.
type() - Method in annotation type io.objectbox.annotation.Index
Sets the IndexType, defaults to IndexType.DEFAULT.

U

Uid - Annotation Type in io.objectbox.annotation
UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
unique() - Method in class io.objectbox.query.PropertyQuery
For find methods returning single values, e.g.
Unique - Annotation Type in io.objectbox.annotation
Enforces that the value of a property is unique among all objects in a box before an object can be put.
UniqueViolationException - Exception in io.objectbox.exception
Thrown when a @Unique constraint would be violated during a put operation.
UniqueViolationException(String) - Constructor for exception io.objectbox.exception.UniqueViolationException
 
UNKNOWN - Static variable in class io.objectbox.sync.SyncLoginCodes
 
unregisterTransaction(Transaction) - Method in class io.objectbox.BoxStore
 
UNSIGNED - Static variable in class io.objectbox.query.OrderFlags
For scalars only: changes the comparison to unsigned (default is signed).
UNSIGNED - Static variable in class io.objectbox.query.QueryBuilder
For scalars only: changes the comparison to unsigned (default is signed).
unsubscribe(DataObserver<T>, Object) - Method in interface io.objectbox.reactive.DataPublisher
 
useNoArgConstructor() - Method in annotation type io.objectbox.annotation.Entity
Use a no-arg constructor instead of an all properties constructor (generated).

V

value - Variable in class io.objectbox.query.QueryCondition.AbstractCondition
 
value() - Method in annotation type io.objectbox.annotation.NameInDb
Name used in the database.
value() - Method in annotation type io.objectbox.annotation.TargetIdProperty
Name used in the database.
value() - Method in annotation type io.objectbox.annotation.Uid
The UID associated with an entity/property.
VALUE - io.objectbox.annotation.IndexType
Use the property value to build the index.
valueOf(String) - Static method in enum io.objectbox.annotation.IndexType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.objectbox.query.QueryBuilder.StringOrder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.objectbox.query.QueryCondition.PropertyCondition.Operation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.objectbox.sync.SyncCredentials.CredentialsType
Returns the enum constant of this type with the specified name.
values - Variable in class io.objectbox.query.QueryCondition.AbstractCondition
 
values() - Static method in enum io.objectbox.annotation.IndexType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.objectbox.query.QueryBuilder.StringOrder
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.objectbox.query.QueryCondition.PropertyCondition.Operation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.objectbox.sync.SyncCredentials.CredentialsType
Returns an array containing the constants of this enum type, in the order they are declared.

W

weak() - Method in class io.objectbox.reactive.SubscriptionBuilder
Uses a weak reference for the observer.
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes All Packages