Skip navigation links
A B C D E F G H I K L M N O P Q R S T U V W 

A

AbstractCondition(Object) - Constructor for class io.objectbox.query.QueryCondition.AbstractCondition
 
AbstractCondition(Object[]) - Constructor for class io.objectbox.query.QueryCondition.AbstractCondition
 
accept(T) - Method in interface io.objectbox.query.QueryConsumer
 
add(E) - Method in class io.objectbox.query.LazyList
 
add(int, E) - Method in class io.objectbox.query.LazyList
 
add(E) - Method in class io.objectbox.query.LazyList.LazyIterator
 
add(TARGET) - Method in class io.objectbox.relation.ToMany
 
add(int, TARGET) - Method in class io.objectbox.relation.ToMany
 
addAll(Collection<? extends E>) - Method in class io.objectbox.query.LazyList
 
addAll(int, Collection<? extends E>) - Method in class io.objectbox.query.LazyList
 
addAll(Collection<? extends TARGET>) - Method in class io.objectbox.relation.ToMany
 
addAll(int, Collection<? extends TARGET>) - Method in class io.objectbox.relation.ToMany
 
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.
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
 
attach(T) - Method in class io.objectbox.Box
 
avg(Property) - Method in class io.objectbox.query.Query
Calculates the average of all values for the given property over all Objects matching the query.

B

Backlink - Annotation Type in io.objectbox.annotation
Defines a backlink relation, which is based on another relation reversing the direction.
backlinkToOneGetter - Variable in class io.objectbox.relation.RelationInfo
For ToMany relations based on backlinks (null otherwise).
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.
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(Object, Object) - Method in class io.objectbox.Property
Creates an "BETWEEN ...
between(Property, long, long) - Method in class io.objectbox.query.QueryBuilder
 
between(Property, Date, Date) - Method in class io.objectbox.query.QueryBuilder
 
between(Property, double, double) - Method in class io.objectbox.query.QueryBuilder
 
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.
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.
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.
cancel() - Method in interface io.objectbox.reactive.DataSubscription
The Observer shall not receive anymore updates.
CASE_SENSITIVE - Static variable in class io.objectbox.query.QueryBuilder
Makes upper case letters (e.g.
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
 
clearDefaultStore() - Static method in class io.objectbox.BoxStore
Clears the convenience instance.
close() - Method in class io.objectbox.BoxStore
 
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
 
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. readers).
commitWriter(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
 
contains(String) - Method in class io.objectbox.Property
 
contains(Object) - Method in class io.objectbox.query.LazyList
 
contains(Property, String) - Method in class io.objectbox.query.QueryBuilder
 
contains(Property, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
contains(Object) - Method in class io.objectbox.relation.ToMany
 
containsAll(Collection<?>) - Method in class io.objectbox.query.LazyList
 
containsAll(Collection<?>) - Method in class io.objectbox.relation.ToMany
 
Convert - Annotation Type in io.objectbox.annotation
Specifies PropertyConverter for the field to support custom types
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.Query
Returns the count of Objects matching the query.
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
 
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).
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, Throwable) - Constructor for exception io.objectbox.exception.DbException
 
DbException(String, int) - Constructor for exception io.objectbox.exception.DbException
 
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
 
debugRelations() - Method in class io.objectbox.BoxStoreBuilder
Enables some debug logging for relations.
debugTransactions() - Method in class io.objectbox.BoxStoreBuilder
Enables some debug logging for transactions.
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
 
deleteAllFiles(File) - Static method in class io.objectbox.BoxStore
 
DESCENDING - Static variable in class io.objectbox.query.QueryBuilder
Reverts the order from ascending (default) to descending.
diagnose() - Method in class io.objectbox.BoxStore
 
directory(File) - Method in class io.objectbox.BoxStoreBuilder
The directory where all DB files should be placed in.
dropAllData() - Method in class io.objectbox.BoxStore
 

E

eager(RelationInfo, RelationInfo...) - Method in class io.objectbox.query.QueryBuilder
Specifies relations that should be resolved eagerly.
eager(int, RelationInfo, RelationInfo...) - Method in class io.objectbox.query.QueryBuilder
Like QueryBuilder.eager(RelationInfo, RelationInfo[]), but limits eager loading to the given count.
endsWith(String) - Method in class io.objectbox.Property
 
endsWith(Property, String) - Method in class io.objectbox.query.QueryBuilder
 
endsWith(Property, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
Entity - Annotation Type in io.objectbox.annotation
Annotation for entities ObjectBox only persist objects of classes which are marked with this annotation
entity(EntityInfo) - Method in class io.objectbox.BoxStoreBuilder
 
EntityInfo<T> - Interface in io.objectbox
 
eq(Object) - Method in class io.objectbox.Property
Creates an "equal ('=')" condition for this property.
equal(Property, long) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property, boolean) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property, Date) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property, String) - Method in class io.objectbox.query.QueryBuilder
 
equal(Property, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
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

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
 
finalize() - Method in class io.objectbox.query.Query
 
finalize() - Method in class io.objectbox.query.QueryBuilder
 
find(String, String) - Method in class io.objectbox.Box
 
find(String, long) - Method in class io.objectbox.Box
 
find(int, long) - Method in class io.objectbox.Box
 
find(int, String) - Method in class io.objectbox.Box
 
find(Property, String) - Method in class io.objectbox.Box
 
find(Property, long) - Method in class io.objectbox.Box
 
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.
findFirst() - Method in class io.objectbox.query.Query
Find the first Object matching the query.
findIds() - Method in class io.objectbox.query.Query
Very efficient way to get just the IDs without creating any objects.
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.
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

Generated - Annotation Type in io.objectbox.annotation
Deprecated.
get(long) - Method in class io.objectbox.Box
Get the stored object for the given ID.
get(Iterable<Long>) - Method in class io.objectbox.Box
Get the stored objects for the given IDs.
get(long[]) - Method in class io.objectbox.Box
Get the stored objects for the given IDs.
get(int) - Method in class io.objectbox.query.LazyList
 
get(int) - Method in class io.objectbox.relation.ToMany
 
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.
getAll2() - Method in class io.objectbox.Box
Does not work yet, also probably won't be faster than Box.getAll().
getAllEntityClasses() - Method in class io.objectbox.BoxStore
 
getAllProperties() - Method in interface io.objectbox.EntityInfo
 
getCachedTarget() - Method in class io.objectbox.relation.ToOne
 
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
 
getEntityInfo() - Method in class io.objectbox.Box
 
getEntityName() - Method in interface io.objectbox.EntityInfo
 
getEntityTypeIdOrThrow(Class) - Method in class io.objectbox.BoxStore
 
getErrorCode() - Method in exception io.objectbox.exception.DbException
0 == no error code available
getHandle(Cursor) - Static method in class io.objectbox.InternalAccess
 
getId(T) - Method in class io.objectbox.Box
 
getId() - Method in class io.objectbox.Property
 
getIdGetter() - Method in interface io.objectbox.EntityInfo
 
getIdProperty() - Method in interface io.objectbox.EntityInfo
 
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.
getObserverDelegate() - Method in interface io.objectbox.reactive.DelegatingObserver
 
getReader(Box<T>) - Static method in class io.objectbox.InternalAccess
 
getReaderDebugInfo() - Method in class io.objectbox.Box
 
getRemoveCount() - Method in class io.objectbox.relation.ToMany
 
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
 
getVersion() - Static method in class io.objectbox.BoxStore
 
getVersionNative() - Static method in class io.objectbox.BoxStore
 
getWriter(Box<T>) - Static method in class io.objectbox.InternalAccess
 
greater(Property, long) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property, Date) - Method in class io.objectbox.query.QueryBuilder
 
greater(Property, double) - Method in class io.objectbox.query.QueryBuilder
 
gt(Object) - Method in class io.objectbox.Property
Creates an "greater than ('>')" condition for this property.

H

hasNext() - Method in class io.objectbox.query.LazyList.LazyIterator
 
hasPrevious() - Method in class io.objectbox.query.LazyList.LazyIterator
FIXME: before hasPrevious(), next() must be called.

I

Id - Annotation Type in io.objectbox.annotation
Marks field is the primary key of the entity's table
id - Variable in class io.objectbox.Property
 
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(Property, long[]) - Method in class io.objectbox.query.QueryBuilder
 
in(Property, int[]) - Method in class io.objectbox.query.QueryBuilder
 
Index - Annotation Type in io.objectbox.annotation
Specifies that the property should be indexed, which is highly recommended if you do queries using this property.
indexOf(Object) - Method in class io.objectbox.query.LazyList
 
indexOf(Object) - Method in class io.objectbox.relation.ToMany
 
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.
internalGetBacklinkEntities(int, Property, long) - Method in class io.objectbox.Box
 
internalGetRelationEntities(int, int, long) - Method in class io.objectbox.Box
 
internalPutTarget(Cursor<TARGET>) - Method in class io.objectbox.relation.ToOne
 
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
 
io.objectbox.annotation - package io.objectbox.annotation
 
io.objectbox.annotation.apihint - package io.objectbox.annotation.apihint
 
io.objectbox.converter - package io.objectbox.converter
 
io.objectbox.exception - package io.objectbox.exception
 
io.objectbox.query - package io.objectbox.query
 
io.objectbox.reactive - package io.objectbox.reactive
 
io.objectbox.relation - package io.objectbox.relation
 
isCanceled() - Method in interface io.objectbox.reactive.DataSubscription
Current cancellation state of the subscription.
isClosed() - Method in class io.objectbox.BoxStore
 
isDebugRelations() - Method in class io.objectbox.BoxStore
 
isEmpty() - Method in class io.objectbox.query.LazyList
 
isEmpty() - Method in class io.objectbox.relation.ToMany
 
isLoadedCompletely() - Method in class io.objectbox.query.LazyList
 
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(Property) - Method in class io.objectbox.query.QueryBuilder
 
isNull() - Method in class io.objectbox.relation.ToOne
 
isResolved() - Method in class io.objectbox.relation.ToMany
 
isResolved() - Method in class io.objectbox.relation.ToOne
 
isResolvedAndNotNull() - Method in class io.objectbox.relation.ToOne
 
iterator() - Method in class io.objectbox.query.LazyList
 
iterator() - Method in class io.objectbox.relation.ToMany
 

K

Keep - Annotation Type in io.objectbox.annotation
Deprecated.
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, long) - Method in class io.objectbox.query.QueryBuilder
 
less(Property, Date) - Method in class io.objectbox.query.QueryBuilder
 
less(Property, double) - Method in class io.objectbox.query.QueryBuilder
 
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(int) - Method in class io.objectbox.query.LazyList
 
listIterator() - Method in class io.objectbox.relation.ToMany
 
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.
lt(Object) - Method in class io.objectbox.Property
Creates an "less than ('<')" condition for this property.

M

max(Property) - Method in class io.objectbox.query.Query
Finds the maximum value for the given property over all Objects matching the query.
maxDouble(Property) - Method in class io.objectbox.query.Query
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(Property) - Method in class io.objectbox.query.Query
Finds the minimum value for the given property over all Objects matching the query.
minDouble(Property) - Method in class io.objectbox.query.Query
Finds the minimum value for the given property over all Objects matching the query.

N

name(String) - Method in class io.objectbox.BoxStoreBuilder
Name of the database, which will be used as a directory for DB files.
name - Variable in class io.objectbox.Property
 
NameInDb - Annotation Type in io.objectbox.annotation
Allows to specify a simple name mapping for entities and properties.
next() - Method in class io.objectbox.query.LazyList.LazyIterator
 
nextIndex() - Method in class io.objectbox.query.LazyList.LazyIterator
 
notEq(Object) - Method in class io.objectbox.Property
Creates an "not equal ('<>')" condition for this property.
notEqual(Property, long) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property, boolean) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property, Date) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property, String) - Method in class io.objectbox.query.QueryBuilder
 
notEqual(Property, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
notIn(Property, long[]) - Method in class io.objectbox.query.QueryBuilder
 
notIn(Property, int[]) - Method in class io.objectbox.query.QueryBuilder
 
notNull(Property) - Method in class io.objectbox.query.QueryBuilder
 
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.QueryBuilder
null values should be treated equal to zero (scalars only).

O

observer(DataObserver<T>) - Method in class io.objectbox.reactive.SubscriptionBuilder
The given observer is subscribed to the publisher.
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.
onError(Throwable) - Method in interface io.objectbox.reactive.ErrorObserver
Called when an exception was thrown.
onError(ErrorObserver) - Method in class io.objectbox.reactive.SubscriptionBuilder
onlyChanges() - Method in class io.objectbox.reactive.SubscriptionBuilder
 
or() - Method in class io.objectbox.query.QueryBuilder
Combines the previous condition with the following condition with a logical OR.
order(Property) - Method in class io.objectbox.query.QueryBuilder
Specifies given property to be used for sorting.
order(Property, int) - Method in class io.objectbox.query.QueryBuilder
Defines the order with which the results are ordered (default: none).
orderDesc(Property) - Method in class io.objectbox.query.QueryBuilder
Specifies given property in descending order to be used for sorting.
ordinal - Variable in class io.objectbox.Property
 

P

peek(int) - Method in class io.objectbox.query.LazyList
Like get but does not load the entity if it was not loaded before.
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
 
primaryKey - Variable in class io.objectbox.Property
 
Property - Class in io.objectbox
Meta data describing a property
Property(int, int, Class<?>, String, boolean, String) - Constructor for class io.objectbox.Property
 
Property(int, int, Class<?>, String) - Constructor for class io.objectbox.Property
 
Property(int, int, Class<?>, String, boolean, String, Class<? extends PropertyConverter>, Class) - Constructor for class io.objectbox.Property
 
property - Variable in class io.objectbox.query.QueryCondition.PropertyCondition
 
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.
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(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.
put(Collection<T>) - Method in class io.objectbox.Box
Puts the given entities in a box using a single transaction.

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

Relation - Annotation Type in io.objectbox.annotation
Deprecated.
relationId - Variable in class io.objectbox.relation.RelationInfo
For stand-alone to-many relations (0 otherwise).
RelationInfo<TARGET> - Class in io.objectbox.relation
 
RelationInfo(EntityInfo, EntityInfo<TARGET>, Property, ToOneGetter) - Constructor for class io.objectbox.relation.RelationInfo
ToOne
RelationInfo(EntityInfo, EntityInfo<TARGET>, ToManyGetter, Property, ToOneGetter) - Constructor for class io.objectbox.relation.RelationInfo
ToMany as a ToOne backlink
RelationInfo(EntityInfo, EntityInfo<TARGET>, ToManyGetter, int) - Constructor for class io.objectbox.relation.RelationInfo
Stand-alone ToMany.
releaseReader(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
 
releaseWriter(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
 
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(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.
remove(Collection<T>) - Method in class io.objectbox.Box
Removes (deletes) the given Objects in a single transaction.
remove() - Method in class io.objectbox.query.LazyList.LazyIterator
 
remove(int) - Method in class io.objectbox.query.LazyList
 
remove(Object) - Method in class io.objectbox.query.LazyList
 
remove() - Method in class io.objectbox.query.Query
Removes (deletes) all Objects matching the query
remove(int) - Method in class io.objectbox.relation.ToMany
 
remove(Object) - Method in class io.objectbox.relation.ToMany
 
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
 
removeByKeys(Collection<Long>) - Method in class io.objectbox.Box
Due to type erasure collision, we cannot simply use "remove" as a method name here.
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(T) - Method in interface io.objectbox.reactive.RunWithParam
 
run(RunWithParam, T) - Method in interface io.objectbox.reactive.Scheduler
 
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
 
set(E) - Method in class io.objectbox.query.LazyList.LazyIterator
 
set(int, E) - Method in class io.objectbox.query.LazyList
 
set(int, TARGET) - Method in class io.objectbox.relation.ToMany
 
setAndPutTarget(TARGET) - Method in class io.objectbox.relation.ToOne
Sets the relation ID in the enclosed entity to the ID of the given target entity and puts the enclosed entity.
setAndPutTargetAlways(TARGET) - Method in class io.objectbox.relation.ToOne
Sets the relation ID in the enclosed entity to the ID of the given target entity and puts both entities.
setCrashReportLogger(CrashReportLogger) - Static method in class io.objectbox.BoxStore
 
setListFactory(ListFactory) - Method in class io.objectbox.relation.ToMany
Currently only used for non-persisted entities (id == 0).
setParameter(Property, String) - 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, double) - 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(Property, boolean) - 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, 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 interface io.objectbox.query.QueryCondition
 
setParameters(Property, long, long) - Method in class io.objectbox.query.Query
Sets a parameter previously given to the QueryBuilder to new values.
setParameters(Property, double, double) - 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.
setTarget(TARGET) - Method in class io.objectbox.relation.ToOne
Sets the relation ID in the enclosed entity to the ID of the given target entity.
setTargetId(long) - Method in class io.objectbox.relation.ToOne
 
single() - Method in class io.objectbox.reactive.SubscriptionBuilder
 
size() - Method in class io.objectbox.query.LazyList
 
size() - Method in class io.objectbox.relation.ToMany
 
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
 
startsWith(String) - Method in class io.objectbox.Property
 
startsWith(Property, String) - Method in class io.objectbox.query.QueryBuilder
 
startsWith(Property, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
 
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(Class<T>) - Method in class io.objectbox.BoxStore
Like BoxStore.subscribe(), but wires the supplied @DataObserver only to the given object class for notifications.
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
 
SubscriptionBuilder<T> - Class in io.objectbox.reactive
SubscriptionBuilder(DataPublisher<T>, Object, ExecutorService) - Constructor for class io.objectbox.reactive.SubscriptionBuilder
 
sum(Property) - Method in class io.objectbox.query.Query
Sums up all values for the given property over all Objects matching the query.
sumDouble(Property) - Method in class io.objectbox.query.Query
Sums up all values for the given property over all Objects matching the query.

T

TargetIdProperty - Annotation Type in io.objectbox.annotation
Defines the property serving as the target ID of a ToOne.
targetIdProperty - Variable in class io.objectbox.relation.RelationInfo
For relations based on a target ID property (null for stand-alone relations).
targetInfo - Variable in class io.objectbox.relation.RelationInfo
 
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.
toArray() - Method in class io.objectbox.query.LazyList
 
toArray(T[]) - Method in class io.objectbox.query.LazyList
 
toArray() - Method in class io.objectbox.relation.ToMany
 
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<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.

U

Uid - Annotation Type in io.objectbox.annotation
UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
unregisterTransaction(Transaction) - Method in class io.objectbox.BoxStore
 
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
 

V

value - Variable in class io.objectbox.query.QueryCondition.AbstractCondition
 
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.
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 - Variable in class io.objectbox.query.QueryCondition.AbstractCondition
 
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.

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 K L M N O P Q R S T U V W 
Skip navigation links

Available under the Apache License, Version 2.0 - Copyright © 2017 ObjectBox Ltd. All Rights Reserved.