Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort() - Method in class io.objectbox.Transaction
- AbstractSyncListener - Class in io.objectbox.sync.listener
-
A
SyncListenerwith empty implementations of all interface methods. - AbstractSyncListener() - Constructor for class io.objectbox.sync.listener.AbstractSyncListener
- accept(T) - Method in interface io.objectbox.query.QueryConsumer
- ActionObserver(DataSubscriptionImpl) - Constructor for class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- activeTx - Variable in class io.objectbox.BoxStore
-
Set when running inside TX
- activeTxCursor - Variable in class io.objectbox.Box
-
Set when running inside TX
- 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
-
Prepares to add the given target object to this relation.
- addAdminThreads(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addAdminUrl(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- 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. - addAuthenticationMethods(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addBackupFile(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- addBackupRestoreFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addBoolean(boolean) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `boolean` to the buffer, properly aligned, and grows the buffer (if necessary).
- addBoolean(int, boolean, boolean) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `boolean` to a table at `o` into its vtable, with value `x` and default `d`.
- addByte(byte) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `byte` to the buffer, properly aligned, and grows the buffer (if necessary).
- addByte(int, byte, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `byte` to a table at `o` into its vtable, with value `x` and default `d`.
- addBytes(long, byte[], boolean) - Method in interface io.objectbox.sync.ObjectsMessageBuilder
- addBytes(long, byte[], boolean) - Method in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- addBytes(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.Credentials
- addCertificatePath(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addClaimAud(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.JwtConfig
- addClaimIss(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.JwtConfig
- addClusterFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addClusterId(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addClusterPeers(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addCredentials(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- addDebugFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addDimensions(FlatBufferBuilder, long) - Static method in class io.objectbox.model.HnswParams
- addDirectoryPath(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- addDistanceType(FlatBufferBuilder, int) - Static method in class io.objectbox.model.HnswParams
- addDouble(double) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `double` to the buffer, properly aligned, and grows the buffer (if necessary).
- addDouble(int, double, double) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `double` to a table at `o` into its vtable, with value `x` and default `d`.
- addEntities(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addFileMode(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.model.HnswParams
- addFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.model.ModelEntity
- addFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.model.ModelProperty
- addFloat(float) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `float` to the buffer, properly aligned, and grows the buffer (if necessary).
- addFloat(int, float, double) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `float` to a table at `o` into its vtable, with value `x` and default `d`.
- addHash(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addHistorySizeMaxKb(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addHistorySizeTargetKb(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addHnswParams(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- addId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelRelation
- addIndexId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addIndexingSearchCount(FlatBufferBuilder, long) - Static method in class io.objectbox.model.HnswParams
- addInt(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add an `int` to the buffer, properly aligned, and grows the buffer (if necessary).
- addInt(int, int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add an `int` to a table at `o` into its vtable, with value `x` and default `d`.
- addJwtConfig(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addLastEntityId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addLastIndexId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addLastPropertyId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- addLastRelationId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addLastSequenceId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addLong(int, long, long) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `long` to a table at `o` into its vtable, with value `x` and default `d`.
- addLong(long) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `long` to the buffer, properly aligned, and grows the buffer (if necessary).
- addMap(FlexBuffersBuilder, String, Map<Object, Object>) - Method in class io.objectbox.converter.FlexObjectConverter
- addMaxDataSizeInKbyte(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addMaxDbSizeInKbyte(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addMaxIndexValueLength(FlatBufferBuilder, long) - Static method in class io.objectbox.model.ModelProperty
- addMaxReaders(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addModelBytes(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- addModelVersion(FlatBufferBuilder, long) - Static method in class io.objectbox.model.Model
- addName(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- addName(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- addName(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addName(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelRelation
- addNameSecondary(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- addNameSecondary(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addNeighborsPerNode(FlatBufferBuilder, long) - Static method in class io.objectbox.model.HnswParams
- addNoReaderThreadLocals(FlatBufferBuilder, boolean) - Static method in class io.objectbox.config.FlatStoreOptions
- addOffset(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Adds on offset, relative to where it will be written.
- addOffset(int, int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add an `offset` to a table at `o` into its vtable, with value `x` and default `d`.
- addProperties(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- addPublicKey(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.JwtConfig
- addPublicKeyCacheExpirationSeconds(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.JwtConfig
- addPublicKeyUrl(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.JwtConfig
- addPutPaddingMode(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- addReadOnly(FlatBufferBuilder, boolean) - Static method in class io.objectbox.config.FlatStoreOptions
- addRelations(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- addReparationBacklinkProbability(FlatBufferBuilder, float) - Static method in class io.objectbox.model.HnswParams
- addRequiredCredentials(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addShort(int, short, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `short` to a table at `o` into its vtable, with value `x` and default `d`.
- addShort(short) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `short` to the buffer, properly aligned, and grows the buffer (if necessary).
- addSkipReadSchema(FlatBufferBuilder, boolean) - Static method in class io.objectbox.config.FlatStoreOptions
- addStandaloneRelations(Cursor<?>, long, TARGET[], IdGetter<TARGET>) - Method in class io.objectbox.relation.ToMany
-
The target array may not contain non-persisted entities.
- addString(long, String) - Method in interface io.objectbox.sync.ObjectsMessageBuilder
- addString(long, String) - Method in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- addStrings(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.Credentials
- addStruct(int, int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a struct to the table.
- addSyncFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addSyncServerFlags(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addTargetEntity(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addTargetEntityId(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelRelation
- addType(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addType(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.Credentials
- addUrl(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- addUrl(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- addUsePreviousCommit(FlatBufferBuilder, boolean) - Static method in class io.objectbox.config.FlatStoreOptions
- addUsePreviousCommitOnValidationFailure(FlatBufferBuilder, boolean) - Static method in class io.objectbox.config.FlatStoreOptions
- addValidateOnOpenKv(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- addValidateOnOpenPageLimit(FlatBufferBuilder, long) - Static method in class io.objectbox.config.FlatStoreOptions
- addValidateOnOpenPages(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- addValue(FlexBuffersBuilder, Object) - Method in class io.objectbox.converter.FlexObjectConverter
- addVector(FlexBuffersBuilder, String, List<Object>) - Method in class io.objectbox.converter.FlexObjectConverter
- addVectorCacheHintSizeKb(FlatBufferBuilder, long) - Static method in class io.objectbox.model.HnswParams
- addVersion(FlatBufferBuilder, long) - Static method in class io.objectbox.model.Model
- addVirtualTarget(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelProperty
- addWorkerThreads(FlatBufferBuilder, long) - Static method in class io.objectbox.sync.server.SyncServerOptions
- ADMIN - Enum constant in enum class io.objectbox.internal.Feature
-
HTTP server with a database browser.
- AdminDisabled - Static variable in class io.objectbox.sync.server.SyncServerFlags
-
By default, the Admin server is enabled; this flag disables it.
- adminThreads() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Number of worker threads used by the Admin web server.
- adminUrl() - Method in class io.objectbox.sync.server.SyncServerOptions
-
URL of the Admin (web server) to bind to.
- adminUrlAsByteBuffer() - Method in class io.objectbox.sync.server.SyncServerOptions
- adminUrlInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- afterExecute(Runnable, Throwable) - Method in class io.objectbox.internal.ObjectBoxThreadPool
- alias - Variable in class io.objectbox.query.PropertyQueryConditionImpl
- alias(String) - Method in interface io.objectbox.query.PropertyQueryCondition
-
Assigns an alias to this condition that can later be used with the
QuerysetParameter methods. - alias(String) - Method in class io.objectbox.query.PropertyQueryConditionImpl
- align(int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- AllBranches - Static variable in class io.objectbox.config.ValidateOnOpenModePages
-
Performs a unlimited number of checks on the most important database structures (e.g.
- AllBranches - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.Performs a unlimited number of checks on the most important database structures (e.g.
- allEntityTypeIds - Variable in class io.objectbox.BoxStore
- AllowNonUniqueNodes - Static variable in class io.objectbox.config.TreeOptionFlags
-
In some scenarios, e.g.
- and() - Method in class io.objectbox.query.QueryBuilder
-
And AND changes how conditions are combined using a following OR.
- and(QueryCondition<T>) - Method in interface io.objectbox.query.QueryCondition
-
Combines this condition using AND with the given condition.
- and(QueryCondition<T>) - Method in class io.objectbox.query.QueryConditionImpl
- AND - Enum constant in enum class io.objectbox.query.QueryBuilder.Operator
- AndCondition(QueryConditionImpl<T>, QueryConditionImpl<T>) - Constructor for class io.objectbox.query.LogicQueryCondition.AndCondition
- androidContext(Object) - Method in class io.objectbox.BoxStoreBuilder
-
Use on Android to pass a Context for loading the native library and, if not an
BoxStoreBuilder.inMemory(String)database, for creating the base directory for database files in the files directory of the app. - 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. - apply(QueryBuilder<T>) - Method in class io.objectbox.query.LogicQueryCondition
- apply(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl
- apply(QueryBuilder<T>) - Method in class io.objectbox.query.QueryConditionImpl
- apply(QueryBuilder<T>) - Method in class io.objectbox.query.RelationCountCondition
- apply(QueryCondition<T>) - Method in class io.objectbox.query.QueryBuilder
-
Applies the given query conditions and returns the builder for further customization, such as result order.
- applyChangesToDb() - Method in class io.objectbox.relation.ToMany
-
Saves changes (added and removed objects) made to this relation to the database.
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.LongCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.NearestNeighborCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.NullCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.StringCondition
- applyCondition(QueryBuilder<T>) - Method in class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition
- applyOperator(QueryBuilder<T>, long, long) - Method in class io.objectbox.query.LogicQueryCondition.AndCondition
- applyOperator(QueryBuilder<T>, long, long) - Method in class io.objectbox.query.LogicQueryCondition
- applyOperator(QueryBuilder<T>, long, long) - Method in class io.objectbox.query.LogicQueryCondition.OrCondition
- ArrayListFactory() - Constructor for class io.objectbox.relation.ListFactory.ArrayListFactory
- ArrayReadWriteBuf - Class in io.objectbox.flatbuffers
-
Implements
ReadBufusing an array of bytes as a backing storage. - ArrayReadWriteBuf() - Constructor for class io.objectbox.flatbuffers.ArrayReadWriteBuf
- ArrayReadWriteBuf(byte[]) - Constructor for class io.objectbox.flatbuffers.ArrayReadWriteBuf
- ArrayReadWriteBuf(byte[], int) - Constructor for class io.objectbox.flatbuffers.ArrayReadWriteBuf
- ArrayReadWriteBuf(int) - Constructor for class io.objectbox.flatbuffers.ArrayReadWriteBuf
- asBlob() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as a
FlexBuffers.Blob - asBoolean() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as a boolean
- asDouble() - Method in class io.objectbox.tree.Leaf
- asFloat() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as 64-bit integer.
- asInt() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as 32-bit integer.
- asInt() - Method in class io.objectbox.tree.Leaf
- asKey() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as a
FlexBuffers.Key - asLong() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as 64-bit integer.
- asMap() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as a
FlexBuffers.Map - assignable() - Element in annotation interface io.objectbox.annotation.Id
-
Allows IDs of new entities to be assigned manually.
- asString() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as a `String`
- asString() - Method in class io.objectbox.tree.Leaf
- asStringArray() - Method in class io.objectbox.tree.Leaf
- asUInt() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as unsigned 64-bit integer.
- asVector() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns element as a
FlexBuffers.Vector - async() - Static method in class io.objectbox.reactive.Schedulers
- attach(T) - Method in class io.objectbox.Box
- AUTH_UNREACHABLE - Static variable in class io.objectbox.sync.SyncLoginCodes
- authenticationMethods(int) - Method in class io.objectbox.sync.server.SyncServerOptions
-
A list of enabled authentication methods available to Sync Clients to login.
- authenticationMethods(Credentials, int) - Method in class io.objectbox.sync.server.SyncServerOptions
- authenticationMethodsLength() - Method in class io.objectbox.sync.server.SyncServerOptions
- authenticationMethodsVector() - Method in class io.objectbox.sync.server.SyncServerOptions
- authenticationMethodsVector(Credentials.Vector) - Method in class io.objectbox.sync.server.SyncServerOptions
- AuthenticationNoneLogInfo - Static variable in class io.objectbox.sync.server.SyncServerFlags
-
By default, if the Sync Server allows logins without credentials, it logs a warning message.
- authenticatorCredentials(SyncCredentials) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Adds additional authenticator credentials to authenticate clients or peers with.
- authenticatorCredentials(SyncCredentials[]) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Adds additional authenticator credentials to authenticate clients or peers with.
- AUTO - Enum constant in enum class io.objectbox.sync.SyncBuilder.RequestUpdatesMode
-
Once logged in, requests sync updates automatically including subsequent pushes for data changes.
- AUTO_NO_PUSHES - Enum constant in enum class io.objectbox.sync.SyncBuilder.RequestUpdatesMode
-
Once logged in, requests updates automatically once without subsequent pushes for data changes.
- AutoConsolidateNonUniqueNodes - Static variable in class io.objectbox.config.TreeOptionFlags
-
Nodes described in AllowNonUniqueNodes will be automatically consolidated to make them unique.
- 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
- awaitFirstLogin(long) - Method in class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
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 Interface 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).
- backupFile() - Method in class io.objectbox.config.FlatStoreOptions
-
Restores the database content from the given backup file (note: backup is a server-only feature).
- backupFileAsByteBuffer() - Method in class io.objectbox.config.FlatStoreOptions
- backupFileInByteBuffer(ByteBuffer) - Method in class io.objectbox.config.FlatStoreOptions
- backupRestoreFlags() - Method in class io.objectbox.config.FlatStoreOptions
-
Flags to change the default behavior for restoring backups, e.g.
- BAD_VERSION - Static variable in class io.objectbox.sync.SyncLoginCodes
- baseDirectory - Variable in class io.objectbox.BoxStoreBuilder
-
Ignored by BoxStore
- 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 Interface in io.objectbox.annotation
-
Marks a class as an ObjectBox Entity super class.
- BaseVector - Class in io.objectbox.flatbuffers
-
All vector access objects derive from this class, and add their own accessors.
- BaseVector() - Constructor for class io.objectbox.flatbuffers.BaseVector
- bb - Variable in class io.objectbox.flatbuffers.BaseVector
-
The underlying ByteBuffer to hold the data of the vector.
- bb - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- bb - Variable in class io.objectbox.flatbuffers.FlexBuffers.Object
- bb - Variable in class io.objectbox.flatbuffers.FlexBuffers.Reference
- bb - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- bb - Variable in class io.objectbox.flatbuffers.Struct
-
The underlying ByteBuffer to hold the data of the Struct.
- bb - Variable in class io.objectbox.flatbuffers.Table
-
The underlying ByteBuffer to hold the data of the Table.
- bb_factory - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- bb_pos - Variable in class io.objectbox.flatbuffers.Struct
-
Used to hold the position of the `bb` buffer.
- bb_pos - Variable in class io.objectbox.flatbuffers.Table
-
Used to hold the position of the `bb` buffer.
- 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 Interface 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(double, double) - Method in class io.objectbox.Property
-
Creates a "BETWEEN ...
- between(int, int) - Method in class io.objectbox.Property
-
Creates a "BETWEEN ...
- between(long, long) - Method in class io.objectbox.Property
-
Creates a "BETWEEN ...
- between(short, short) - Method in class io.objectbox.Property
-
Creates a "BETWEEN ...
- between(Property<T>, double, double) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - between(Property<T>, long, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - between(Property<T>, Date, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - between(Date, Date) - Method in class io.objectbox.Property
-
Creates a "BETWEEN ...
- BETWEEN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition.Operation
- BETWEEN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition.Operation
- binarySearch(byte[]) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- binarySearch(CharSequence) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- blob(int, int, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- Blob(ReadBuf, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Blob
- bool(int, boolean) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- Bool - Static variable in class io.objectbox.model.PropertyType
-
A boolean (flag)
- BooleanVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of booleans.
- BooleanVector() - Constructor for class io.objectbox.flatbuffers.BooleanVector
- BoolVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Bool values (boolean; note: each value is represented as one byte)
- box - Variable in class io.objectbox.query.LazyList
- box - Variable in class io.objectbox.query.Query
- box - Variable in class io.objectbox.query.QueryBuilder
- box - Variable in class io.objectbox.query.QueryPublisher
- Box<T> - Class in io.objectbox
-
A Box to put and get Objects of a specific Entity class.
- Box(BoxStore, Class<T>) - Constructor for class io.objectbox.Box
- boxes - Variable in class io.objectbox.BoxStore
- boxFor(Class<T>) - Method in class io.objectbox.BoxStore
-
Returns a Box for the given type.
- boxStore - Variable in class io.objectbox.internal.ObjectBoxThreadPool
- boxStore - Variable in class io.objectbox.ObjectClassPublisher
- boxStore - Variable in class io.objectbox.relation.ToMany
- boxStore - Variable in class io.objectbox.relation.ToOne
- boxStore - Variable in class io.objectbox.sync.server.SyncServerBuilder
- boxStore - Variable in class io.objectbox.sync.SyncBuilder
- boxStore - Variable in class io.objectbox.sync.SyncClientImpl
- boxStore - Variable in class io.objectbox.sync.SyncHybridBuilder
- BoxStore - Class in io.objectbox
-
An ObjectBox database that provides
Boxesto put and get objects of specific entity classes (seeBoxStore.boxFor(Class)). - BoxStore(BoxStoreBuilder) - Constructor for class io.objectbox.BoxStore
- BoxStoreBuilder - Class in io.objectbox
-
Configures and builds a
BoxStorewith reasonable defaults. - BoxStoreBuilder() - Constructor for class io.objectbox.BoxStoreBuilder
- BoxStoreBuilder(byte[]) - Constructor for class io.objectbox.BoxStoreBuilder
-
Called internally from the generated class "MyObjectBox".
- boxStoreField - Variable in class io.objectbox.Box
- boxStoreForEntities - Variable in class io.objectbox.Cursor
- boxStoreServer - Variable in class io.objectbox.sync.SyncHybridBuilder
- branch(String) - Method in class io.objectbox.tree.Branch
-
Get the branch following the given path of child branches from this branch.
- branch(String[]) - Method in class io.objectbox.tree.Branch
-
Get the branch following the given path of child branches from this branch.
- Branch - Class in io.objectbox.tree
-
A branch within a
Tree. - Branch(Tree, long) - Constructor for class io.objectbox.tree.Branch
- branchChild(String) - Method in class io.objectbox.tree.Branch
-
Get the child branch directly attached to this branch with the given name.
- branchId - Variable in class io.objectbox.tree.LeafNode
- BreakForEach - Exception Class in io.objectbox.query
-
You can throw this inside a
QueryConsumerto signalQuery.forEach(QueryConsumer)should "break". - BreakForEach() - Constructor for exception class io.objectbox.query.BreakForEach
- buf - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder.ByteBufferBackedInputStream
- buffer - Variable in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- buffer - Variable in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- build() - Method in class io.objectbox.BoxStoreBuilder
-
Builds a
BoxStoreusing the current configuration of this builder. - build() - Method in class io.objectbox.ModelBuilder
- build() - Method in class io.objectbox.query.QueryBuilder
-
Builds the query and closes this QueryBuilder.
- build() - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Builds and returns a Sync server ready to
SyncServer.start(). - build() - Method in class io.objectbox.sync.SyncBuilder
-
Builds and returns a Sync client ready to
SyncClient.start(). - buildAndStart() - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Builds,
startsand returns a Sync server. - buildAndStart() - Method in class io.objectbox.sync.SyncBuilder
-
Builds,
startsand returns a Sync client. - buildAndStart() - Method in class io.objectbox.sync.SyncHybridBuilder
-
Builds, starts and returns the hybrid.
- buildAuthenticationMethods(FlatBufferBuilder) - Method in class io.objectbox.sync.server.SyncServerBuilder
- buildClusterPeers(FlatBufferBuilder) - Method in class io.objectbox.sync.server.SyncServerBuilder
- buildCredentials(FlatBufferBuilder, SyncCredentialsToken) - Method in class io.objectbox.sync.server.SyncServerBuilder
- buildDefault() - Method in class io.objectbox.BoxStoreBuilder
-
Builds the default
BoxStoreinstance, which can be acquired usingBoxStore.getDefault(). - BUILDER_FLAG_NONE - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
No keys or strings will be shared
- BUILDER_FLAG_SHARE_ALL - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Reserved for the future.
- BUILDER_FLAG_SHARE_KEY_VECTORS - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Reserved for the future.
- BUILDER_FLAG_SHARE_KEYS - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Keys will be shared between elements.
- BUILDER_FLAG_SHARE_KEYS_AND_STRINGS - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Strings and keys will be shared between elements.
- BUILDER_FLAG_SHARE_STRINGS - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Strings will be shared between elements.
- builderHandle - Variable in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- buildFlatStoreOptions(String) - Method in class io.objectbox.BoxStoreBuilder
- buildJwtConfig(FlatBufferBuilder, String, String, String, String) - Method in class io.objectbox.sync.server.SyncServerBuilder
- buildList(FlexBuffers.Vector) - Method in class io.objectbox.converter.FlexObjectConverter
- buildMap(FlexBuffers.Map) - Method in class io.objectbox.converter.FlexObjectConverter
- buildSyncServerOptions() - Method in class io.objectbox.sync.server.SyncServerBuilder
-
From this configuration, builds a
SyncServerOptionsFlatBuffer and returns it as bytes. - Byte - Static variable in class io.objectbox.model.PropertyType
-
8-bit integer
- ByteArrayCondition(Property<T>, PropertyQueryConditionImpl.ByteArrayCondition.Operation, byte[]) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition
- ByteBufferBackedInputStream(ByteBuffer) - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder.ByteBufferBackedInputStream
- ByteBufferFactory() - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder.ByteBufferFactory
- ByteBufferReadWriteBuf - Class in io.objectbox.flatbuffers
- ByteBufferReadWriteBuf(ByteBuffer) - Constructor for class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- ByteBufferUtil - Class in io.objectbox.flatbuffers
-
Class that collects utility functions around `ByteBuffer`.
- ByteBufferUtil() - Constructor for class io.objectbox.flatbuffers.ByteBufferUtil
- bytes(int) - Method in class io.objectbox.sync.Credentials
-
Credentials provided by plain bytes.
- bytesAsByteBuffer() - Method in class io.objectbox.sync.Credentials
- bytesInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.Credentials
- bytesLength() - Method in class io.objectbox.sync.Credentials
- bytesVector() - Method in class io.objectbox.sync.Credentials
- bytesVector(ByteVector) - Method in class io.objectbox.sync.Credentials
- byteToUnsignedInt(byte) - Static method in class io.objectbox.flatbuffers.FlexBuffers.Unsigned
- ByteVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of signed or unsigned 8-bit values.
- ByteVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Byte values (8-bit integers)
- ByteVector() - Constructor for class io.objectbox.flatbuffers.ByteVector
- byteWidth - Variable in class io.objectbox.flatbuffers.FlexBuffers.Object
- byteWidth - Variable in class io.objectbox.flatbuffers.FlexBuffers.Reference
C
- Cache() - Constructor for class io.objectbox.flatbuffers.Utf8Old.Cache
- CACHE - Static variable in class io.objectbox.flatbuffers.Utf8Old
- cachedBuilder - Static variable in class io.objectbox.converter.FlexObjectConverter
- cachedBuilder - Static variable in class io.objectbox.converter.StringMapConverter
- call(long) - Method in interface io.objectbox.internal.CallWithHandle
- callInReadTx(Callable<R>) - Method in class io.objectbox.query.Query
- callInReadTx(Callable<T>) - Method in class io.objectbox.BoxStore
-
Calls the given callable inside a read(-only) transaction.
- callInReadTx(Callable<T>) - Method in class io.objectbox.tree.Tree
-
Similar to
BoxStore.callInReadTx(Callable), but allows Tree functions. - 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. - callInTx(Callable<T>) - Method in class io.objectbox.tree.Tree
-
Similar to
BoxStore.callInReadTx(Callable), but allows Tree functions. - 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. - callInTxNoThrow(Callable<T>) - Method in class io.objectbox.tree.Tree
-
Wraps any Exception thrown by the callable into a RuntimeException.
- callOnData(T) - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- callOnError(Throwable, String) - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- CallWithHandle<RESULT> - Interface in io.objectbox.internal
- cancel() - Method in interface io.objectbox.reactive.DataSubscription
-
The Observer shall not receive anymore updates.
- cancel() - Method in class io.objectbox.reactive.DataSubscriptionImpl
- cancel() - Method in class io.objectbox.reactive.DataSubscriptionList
-
Cancels all tracked subscriptions and removes all references to them.
- cancelCurrentException() - Static method in interface io.objectbox.exception.DbExceptionListener
-
WARNING/DISCLAIMER: Please avoid this method and handle exceptions "properly" instead.
- canceled - Variable in class io.objectbox.reactive.DataSubscriptionImpl
- canceled - Variable in class io.objectbox.reactive.DataSubscriptionList
- cancelUpdates() - Method in interface io.objectbox.sync.SyncClient
-
Asks the server to pause sync updates.
- cancelUpdates() - Method in class io.objectbox.sync.SyncClientImpl
- canonicalPath - Variable in class io.objectbox.BoxStore
- CASE_INSENSITIVE - Enum constant in enum class io.objectbox.query.QueryBuilder.StringOrder
-
Ignores case of ASCII characters when matching results, e.g.
- CASE_SENSITIVE - Enum constant in enum class io.objectbox.query.QueryBuilder.StringOrder
-
Checks case of ASCII characters when matching results, e.g.
- 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 - Variable in class io.objectbox.sync.server.SyncServerBuilder
- certificatePath() - Method in class io.objectbox.sync.server.SyncServerOptions
-
The SSL certificate directory; SSL will be enabled if not empty.
- certificatePath(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets the path to a directory that contains a cert.pem and key.pem file to use to establish encrypted connections.
- certificatePathAsByteBuffer() - Method in class io.objectbox.sync.server.SyncServerOptions
- certificatePathInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- changedIds - Variable in class io.objectbox.sync.SyncChange
- changeListener - Variable in class io.objectbox.sync.server.SyncServerBuilder
- changeListener - Variable in class io.objectbox.sync.SyncBuilder
- changeListener(SyncChangeListener) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets a listener to observe fine granular changes happening during sync.
- changeListener(SyncChangeListener) - Method in class io.objectbox.sync.SyncBuilder
-
Sets a listener to observe fine granular changes happening during sync.
- changePublisherRunning - Variable in class io.objectbox.ObjectClassPublisher
- changesQueue - Variable in class io.objectbox.ObjectClassPublisher
- Char - Static variable in class io.objectbox.model.PropertyType
-
16-bit character
- CharVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Char values (16-bit characters)
- checkApplyToManyToDb(List<TARGET>, Class<TARGET>) - Method in class io.objectbox.Cursor
- checkCached() - Method in class io.objectbox.query.LazyList
- checkCombineCondition(long) - Method in class io.objectbox.query.QueryBuilder
- checkFeatureSyncServerAvailable() - Static method in class io.objectbox.sync.server.SyncServerBuilder
- checkFinishProperty() - Method in class io.objectbox.ModelBuilder.EntityBuilder
- checkIdOfTargetForPut - Variable in class io.objectbox.relation.ToOne
-
To avoid calls to
ToOne.getTargetId(), which may involve expensive reflection. - checkIsNull(Object, String) - Static method in class io.objectbox.BoxStoreBuilder
-
Use to check conflicting properties are not set.
- checkMapKeyType(Object) - Method in class io.objectbox.converter.FlexObjectConverter
-
Checks Java map key is of the expected type, otherwise throws.
- checkMapKeyType(Object) - Method in class io.objectbox.converter.IntegerFlexMapConverter
- checkMapKeyType(Object) - Method in class io.objectbox.converter.LongFlexMapConverter
- checkNameOrPath(String) - Method in class io.objectbox.tree.Branch
- checkNoOperatorPending() - Method in class io.objectbox.query.QueryBuilder
- checkNotFinished() - Method in class io.objectbox.ModelBuilder.EntityBuilder
- checkNotFinished() - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- checkNotNull(Object, String) - Method in class io.objectbox.sync.server.SyncServerBuilder
- checkNotNull(Object, String) - Method in class io.objectbox.sync.SyncBuilder
- checkNotSent() - Method in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- checkNotStringArray() - Method in class io.objectbox.Property
- checkOpen() - Method in class io.objectbox.BoxStore
-
Verifies this has not been
closed. - checkOpen() - Method in class io.objectbox.query.Query
-
Throws if
Query.close()has been called for this. - checkOpen() - Method in class io.objectbox.Transaction
- checkPath(String[]) - Method in class io.objectbox.tree.Branch
- checkProvisionInitialDbFile() - Method in class io.objectbox.BoxStoreBuilder
- checkSyncFeatureAvailable() - Static method in class io.objectbox.sync.SyncBuilder
- checkThreadTermination() - Method in class io.objectbox.BoxStore
-
dump thread stacks if pool does not terminate promptly.
- checkUnpackLib(String) - Static method in class io.objectbox.internal.NativeLibraryLoader
- claimAud - Variable in class io.objectbox.sync.server.SyncServerBuilder
- claimAud() - Method in class io.objectbox.sync.server.JwtConfig
-
JWT claim "aud" (audience) used to verify JWT tokens.
- claimAudAsByteBuffer() - Method in class io.objectbox.sync.server.JwtConfig
- claimAudInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig
- claimIss - Variable in class io.objectbox.sync.server.SyncServerBuilder
- claimIss() - Method in class io.objectbox.sync.server.JwtConfig
-
JWT claim "iss" (issuer) used to verify JWT tokens.
- claimIssAsByteBuffer() - Method in class io.objectbox.sync.server.JwtConfig
- claimIssInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig
- classByEntityTypeId - Variable in class io.objectbox.BoxStore
- cleanStaleReadTransactions() - Method in class io.objectbox.BoxStore
- clear() - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- clear() - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- clear() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Reset the FlatBufferBuilder by purging all data that it holds.
- clear() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Reset the FlexBuffersBuilder by purging all data that it holds.
- clear() - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Clears (resets) the buffer so that it can be reused.
- 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.
- cleared - Variable in class io.objectbox.sync.SyncCredentialsToken
- clearResolved() - Method in class io.objectbox.relation.ToOne
-
Clears the target.
- client - Variable in class io.objectbox.sync.SyncHybrid
- client(BoxStore, String, SyncCredentials) - Static method in class io.objectbox.sync.Sync
-
Starts building a
SyncClient. - client(BoxStore, String, SyncCredentials[]) - Static method in class io.objectbox.sync.Sync
-
Starts building a
SyncClient. - CLIENT_ID_TAKEN - Static variable in class io.objectbox.sync.SyncLoginCodes
- clientBuilder - Variable in class io.objectbox.sync.SyncHybridBuilder
- clientBuilder() - Method in class io.objectbox.sync.SyncHybridBuilder
-
Returns the builder of the client of the hybrid for additional configuration.
- ClientKeepDataOnSyncError - Static variable in class io.objectbox.sync.SyncFlags
-
If the client gets in a state that does not allow any further synchronization, this flag instructs Sync to keep local data nevertheless.
- clone(BoxStoreBuilder, String) - Static method in class io.objectbox.InternalAccess
- close() - Method in class io.objectbox.BoxStore
-
Closes this BoxStore and releases associated resources.
- close() - Method in class io.objectbox.Cursor
- close() - Method in class io.objectbox.internal.DebugCursor
- close() - Method in class io.objectbox.KeyValueCursor
- close() - Method in class io.objectbox.query.Query
-
Closes this query and frees used resources.
- close() - Method in class io.objectbox.query.QueryBuilder
-
Close this query builder and free used resources.
- 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
- close() - Method in class io.objectbox.sync.SyncHybrid
-
Closes and cleans up all resources used by this Sync hybrid.
- close() - Method in class io.objectbox.Transaction
- close() - Method in class io.objectbox.tree.Tree
-
Cleans up any (native) resources associated with this tree.
- closed - Variable in class io.objectbox.BoxStore
- closed - Variable in class io.objectbox.Cursor
- closed - Variable in class io.objectbox.internal.DebugCursor
- closed - Variable in class io.objectbox.Transaction
-
volatile because finalizer thread may interfere with "one thread, one TX" rule
- 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.
- clusterFlags - Variable in class io.objectbox.sync.server.SyncServerBuilder
- clusterFlags() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Bit flags to configure the cluster behavior of this sync server (aka cluster peer).
- clusterFlags(int) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets bit flags to configure the cluster behavior of the Sync server (aka cluster peer).
- ClusterFlags - Class in io.objectbox.sync.server
-
Special bit flags used in cluster mode only.
- ClusterFlags() - Constructor for class io.objectbox.sync.server.ClusterFlags
- clusterId - Variable in class io.objectbox.sync.server.SyncServerBuilder
- clusterId() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Enables cluster mode (requires the Cluster feature) and associates this cluster peer with the given ID.
- clusterId(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Enables cluster mode (requires the Cluster feature) and associates this cluster peer with the given ID.
- clusterIdAsByteBuffer() - Method in class io.objectbox.sync.server.SyncServerOptions
- clusterIdInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- clusterPeer(String, SyncCredentials) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Adds a (remote) cluster peer, to which this server should connect to as a client using the given credentials.
- ClusterPeerConfig - Class in io.objectbox.sync.server
-
Configuration to connect to another (remote) cluster peer.
- ClusterPeerConfig() - Constructor for class io.objectbox.sync.server.ClusterPeerConfig
- ClusterPeerConfig.Vector - Class in io.objectbox.sync.server
- ClusterPeerInfo - Class in io.objectbox.sync.server
-
Internal class to keep configuration for a cluster peer.
- ClusterPeerInfo(String, SyncCredentialsToken) - Constructor for class io.objectbox.sync.server.ClusterPeerInfo
- clusterPeers - Variable in class io.objectbox.sync.server.SyncServerBuilder
- clusterPeers(int) - Method in class io.objectbox.sync.server.SyncServerOptions
-
List of other (remote) cluster peers to connect to.
- clusterPeers(ClusterPeerConfig, int) - Method in class io.objectbox.sync.server.SyncServerOptions
- clusterPeersLength() - Method in class io.objectbox.sync.server.SyncServerOptions
- clusterPeersVector() - Method in class io.objectbox.sync.server.SyncServerOptions
- clusterPeersVector(ClusterPeerConfig.Vector) - Method in class io.objectbox.sync.server.SyncServerOptions
- collect002033(long, long, int, int, long, int, long, int, float, int, float, int, float, int, double, int, double, int, double) - Static method in class io.objectbox.Cursor
- collect004000(long, long, int, int, long, int, long, int, long, int, long) - Static method in class io.objectbox.Cursor
- collect313311(long, long, int, int, String, int, String, int, String, int, byte[], int, long, int, long, int, long, int, int, int, int, int, int, int, float, int, double) - Static method in class io.objectbox.Cursor
- collect400000(long, long, int, int, String, int, String, int, String, int, String) - Static method in class io.objectbox.Cursor
- collect430000(long, long, int, int, String, int, String, int, String, int, String, int, byte[], int, byte[], int, byte[]) - Static method in class io.objectbox.Cursor
- collectCharArray(long, long, int, int, char[]) - Static method in class io.objectbox.Cursor
- collectDoubleArray(long, long, int, int, double[]) - Static method in class io.objectbox.Cursor
- collectFloatArray(long, long, int, int, float[]) - Static method in class io.objectbox.Cursor
- collectIntArray(long, long, int, int, int[]) - Static method in class io.objectbox.Cursor
- collectLongArray(long, long, int, int, long[]) - Static method in class io.objectbox.Cursor
- collectShortArray(long, long, int, int, short[]) - Static method in class io.objectbox.Cursor
- collectStringArray(long, long, int, int, String[]) - Static method in class io.objectbox.Cursor
- collectStringList(long, long, int, int, List<String>) - Static method in class io.objectbox.Cursor
- combineNextWith - Variable in class io.objectbox.query.QueryBuilder
- combineOperator(QueryBuilder.Operator) - Method in class io.objectbox.query.QueryBuilder
- commit() - Method in class io.objectbox.Transaction
- commitAndClose() - Method in class io.objectbox.Transaction
- commitCount - Variable in class io.objectbox.BoxStore
- commitWriter(Box<T>, Cursor<T>) - Static method in class io.objectbox.InternalAccess
- commitWriter(Cursor<T>) - Method in class io.objectbox.Box
- comparator - Variable in class io.objectbox.query.Query
- comparator - Variable in class io.objectbox.query.QueryBuilder
- comparator - Variable in class io.objectbox.relation.ToMany
- compareBytes(ReadBuf, int, byte[]) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- compareCharSequence(int, CharSequence) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- compareStrings(int, byte[], ByteBuffer) - Static method in class io.objectbox.flatbuffers.Table
-
Compare string from the buffer with the 'String' object.
- compareStrings(int, int, ByteBuffer) - Static method in class io.objectbox.flatbuffers.Table
-
Compare two strings in the buffer.
- compareTo(byte[]) - Method in class io.objectbox.flatbuffers.FlexBuffers.Key
- comparisonBuffer - Variable in class io.objectbox.flatbuffers.FlexBuffers.Map
- completedListener - Variable in class io.objectbox.sync.SyncBuilder
- completedListener - Variable in class io.objectbox.sync.SyncClientImpl
- completedListener(SyncCompletedListener) - Method in class io.objectbox.sync.SyncBuilder
-
Sets a listener to only observe Sync completed events.
- computeEncodedLength(CharSequence) - Static method in class io.objectbox.flatbuffers.Utf8Safe
-
Returns the number of bytes in the UTF-8-encoded form of
sequence. - ConflictStrategy - Enum Class in io.objectbox.annotation
-
Used with
Uniqueto specify the conflict resolution strategy. - ConflictStrategy() - Constructor for enum class io.objectbox.annotation.ConflictStrategy
- CONNECTED - Enum constant in enum class io.objectbox.sync.SyncState
- connectionListener - Variable in class io.objectbox.sync.SyncBuilder
- connectionListener - Variable in class io.objectbox.sync.SyncClientImpl
- connectionListener(SyncConnectionListener) - Method in class io.objectbox.sync.SyncBuilder
-
Sets a listener to only observe Sync connection events.
- connectivityMonitor - Variable in class io.objectbox.sync.SyncClientImpl
- ConnectivityMonitor - Class in io.objectbox.sync
-
Used by
SyncClientto observe connectivity changes. - ConnectivityMonitor() - Constructor for class io.objectbox.sync.ConnectivityMonitor
- Constants - Class in io.objectbox.flatbuffers
-
Class that holds shared constants
- Constants() - Constructor for class io.objectbox.flatbuffers.Constants
- ConstraintViolationException - Exception Class in io.objectbox.exception
-
Base class for exceptions thrown when a constraint would be violated during a put operation.
- ConstraintViolationException(String) - Constructor for exception class io.objectbox.exception.ConstraintViolationException
- contains(long) - Method in class io.objectbox.Box
-
Check if an object with the given ID exists in the database.
- contains(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - 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
-
Creates a contains condition for this property using
StringOrder#CASE_SENSITIVE. - contains(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
- CONTAINS - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- CONTAINS_ELEMENT - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- CONTAINS_KEY_VALUE - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition.Operation
- containsAll(Collection<?>) - Method in class io.objectbox.query.LazyList
- containsAll(Collection<?>) - Method in class io.objectbox.relation.ToMany
- containsElement(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - containsElement(String) - Method in class io.objectbox.Property
-
For a String array, list or String-key map property, matches if at least one element equals the given value using
StringOrder#CASE_SENSITIVE. - containsElement(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
- containsKeyValue(Property<T>, String, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - containsKeyValue(String, String) - Method in class io.objectbox.Property
-
For a String-key map property, matches if at least one key and value combination equals the given values using
StringOrder#CASE_SENSITIVE. - containsKeyValue(String, String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
- context - Static variable in class io.objectbox.BoxStore
-
On Android used for native library loading.
- context - Variable in class io.objectbox.BoxStoreBuilder
-
On Android used for native library loading.
- Convert - Annotation Interface in io.objectbox.annotation
-
Supplies a
converterto store custom Property types as a supportedConvert.dbType(). - converter() - Element in annotation interface io.objectbox.annotation.Convert
-
The converter class that ObjectBox should use.
- converterClass - Variable in class io.objectbox.Property
- convertToDatabaseValue(Object) - Method in class io.objectbox.converter.FlexObjectConverter
- convertToDatabaseValue(String) - Method in class io.objectbox.converter.NullToEmptyStringConverter
- convertToDatabaseValue(Map<String, String>) - Method in class io.objectbox.converter.StringMapConverter
- convertToDatabaseValue(P) - Method in interface io.objectbox.converter.PropertyConverter
- convertToEntityProperty(byte[]) - Method in class io.objectbox.converter.FlexObjectConverter
- convertToEntityProperty(byte[]) - Method in class io.objectbox.converter.StringMapConverter
- convertToEntityProperty(D) - Method in interface io.objectbox.converter.PropertyConverter
- convertToEntityProperty(String) - Method in class io.objectbox.converter.NullToEmptyStringConverter
- convertToKey(String) - Method in class io.objectbox.converter.FlexObjectConverter
-
Converts a FlexBuffers string map key to the Java map key (e.g.
- convertToKey(String) - Method in class io.objectbox.converter.IntegerFlexMapConverter
- convertToKey(String) - Method in class io.objectbox.converter.LongFlexMapConverter
- copy() - Method in class io.objectbox.query.Query
-
Creates a copy of this for use in another thread.
- CopyOnWriteArrayListFactory() - Constructor for class io.objectbox.relation.ListFactory.CopyOnWriteArrayListFactory
- Cosine - Static variable in class io.objectbox.model.HnswDistanceType
-
Cosine similarity compares two vectors irrespective of their magnitude (compares the angle of two vectors).
- COSINE - Enum constant in enum class io.objectbox.annotation.VectorDistanceType
-
Cosine similarity compares two vectors irrespective of their magnitude (compares the angle of two vectors).
- 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.
- count(long) - Method in class io.objectbox.Cursor
- create(Transaction) - Static method in class io.objectbox.internal.DebugCursor
- createAndDeleteIntArray() - Static method in class io.objectbox.internal.JniTest
- createAuthenticationMethodsVector(FlatBufferBuilder, int[]) - Static method in class io.objectbox.sync.server.SyncServerOptions
- createBytesVector(FlatBufferBuilder, byte[]) - Static method in class io.objectbox.sync.Credentials
- createBytesVector(FlatBufferBuilder, ByteBuffer) - Static method in class io.objectbox.sync.Credentials
- createByteVector(byte[]) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a byte array in the buffer.
- createByteVector(byte[], int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a byte array in the buffer.
- createByteVector(ByteBuffer) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a byte array in the buffer.
- createClone() - Method in class io.objectbox.sync.SyncCredentials
-
Creates a copy of these credentials.
- createClone() - Method in class io.objectbox.sync.SyncCredentialsToken
- createClone() - Method in class io.objectbox.sync.SyncCredentialsUserPassword
- createClone(String) - Method in class io.objectbox.BoxStoreBuilder
- createClusterPeerConfig(FlatBufferBuilder, int, int) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- createClusterPeersVector(FlatBufferBuilder, int[]) - Static method in class io.objectbox.sync.server.SyncServerOptions
- createCredentials(FlatBufferBuilder, long, int, int) - Static method in class io.objectbox.sync.Credentials
- createCursor(Transaction, long, BoxStore) - Method in interface io.objectbox.internal.CursorFactory
- createCursor(Class<T>) - Method in class io.objectbox.Transaction
- CREATED - Enum constant in enum class io.objectbox.sync.SyncState
- createDebugWithoutModel() - Static method in class io.objectbox.BoxStoreBuilder
-
Not for application use, for DebugCursor.
- createEntitiesVector(FlatBufferBuilder, int[]) - Static method in class io.objectbox.model.Model
- createFlatStoreOptions(FlatBufferBuilder, int, int, long, long, long, int, long, int, boolean, boolean, boolean, boolean, long, boolean, long, int, int, long) - Static method in class io.objectbox.config.FlatStoreOptions
- createHashVector(FlatBufferBuilder, byte[]) - Static method in class io.objectbox.model.Model
- createHashVector(FlatBufferBuilder, ByteBuffer) - Static method in class io.objectbox.model.Model
- createHnswParams(FlatBufferBuilder, long, long, long, long, int, float, long) - Static method in class io.objectbox.model.HnswParams
- createIdUid(FlatBufferBuilder, long, long) - Static method in class io.objectbox.model.IdUid
- createJwtConfig(FlatBufferBuilder, int, int, long, int, int) - Static method in class io.objectbox.sync.server.JwtConfig
- createKeyValueCursor() - Method in class io.objectbox.Transaction
- createKeyVector(int, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- 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
- createListItemEmitter(Query<T>, FlowableEmitter<T>) - Static method in class io.objectbox.rx3.RxQuery
- createModelBytesVector(FlatBufferBuilder, byte[]) - Static method in class io.objectbox.config.FlatStoreOptions
- createModelBytesVector(FlatBufferBuilder, ByteBuffer) - Static method in class io.objectbox.config.FlatStoreOptions
- createPropertiesVector(FlatBufferBuilder, int[]) - Static method in class io.objectbox.model.ModelEntity
- createRelationsVector(FlatBufferBuilder, int[]) - Static method in class io.objectbox.model.ModelEntity
- createRequiredCredentialsVector(FlatBufferBuilder, long[]) - Static method in class io.objectbox.sync.server.SyncServerOptions
- createSharedString(String) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Encode the String `s` in the buffer using UTF-8.
- createSortedVectorOfTables(T, int[]) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a vector of sorted by the key tables.
- createString(CharSequence) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Encode the string `s` in the buffer using UTF-8.
- createString(ByteBuffer) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a string in the buffer from an already encoded UTF-8 string in a ByteBuffer.
- createStringsVector(FlatBufferBuilder, int[]) - Static method in class io.objectbox.sync.Credentials
- createSyncServerOptions(FlatBufferBuilder, int, int, long, long, int, long, long, long, int, long, int, int, long, int, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- createTxCallable(Callable<T>) - Method in class io.objectbox.tree.Tree
- createTxRunnable(Runnable) - Method in class io.objectbox.tree.Tree
- createUnintializedVector(int, int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a new array/vector and return a ByteBuffer to be filled later.
- createVector(int, int, int, boolean, boolean, FlexBuffersBuilder.Value) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- createVector(List<Integer>) - Method in class io.objectbox.ModelBuilder
- createVectorOfTables(int[]) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Create a vector of tables.
- creationThrowable - Variable in class io.objectbox.Cursor
- creationThrowable - Variable in class io.objectbox.Transaction
- credentials - Variable in class io.objectbox.sync.server.ClusterPeerInfo
- credentials - Variable in class io.objectbox.sync.server.SyncServerBuilder
- credentials - Variable in class io.objectbox.sync.SyncBuilder
- credentials() - Method in class io.objectbox.sync.server.ClusterPeerConfig
- credentials(Credentials) - Method in class io.objectbox.sync.server.ClusterPeerConfig
- Credentials - Class in io.objectbox.sync
-
Credentials consist of a type and the credentials data to perform authentication checks.
- Credentials() - Constructor for class io.objectbox.sync.Credentials
- CREDENTIALS_REJECTED - Static variable in class io.objectbox.sync.SyncLoginCodes
- Credentials.Vector - Class in io.objectbox.sync
- CredentialsType - Class in io.objectbox.sync
-
Credentials types for login at a sync server.
- CredentialsType() - Constructor for class io.objectbox.sync.CredentialsType
- CredentialsType(long) - Constructor for enum class io.objectbox.sync.SyncCredentials.CredentialsType
- cursor - Variable in class io.objectbox.Cursor
- cursor - Variable in class io.objectbox.KeyValueCursor
- Cursor<T> - Class in io.objectbox
- Cursor(Transaction, long, EntityInfo<T>, BoxStore) - Constructor for class io.objectbox.Cursor
- CursorFactory<T> - Interface in io.objectbox.internal
- cursorHandle() - Method in class io.objectbox.query.Query
-
To be called inside a read TX
- customType - Variable in class io.objectbox.Property
-
Type, which is converted to a type supported by the DB.
D
- data() - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- data() - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- data() - Method in class io.objectbox.flatbuffers.FlexBuffers.Blob
-
Return
FlexBuffers.Blobas `ReadBuf` - data() - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Expose ReadBuf as an array of bytes.
- DatabaseType - Enum Class in io.objectbox.annotation
-
Use with
@Typeto override how a property value is stored and interpreted in the database. - DatabaseType() - Constructor for enum class io.objectbox.annotation.DatabaseType
- dataBuffer() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Get the ByteBuffer representing the FlatBuffer.
- DataObserver<T> - Interface in io.objectbox.reactive
-
Observer that can be subscribed to publishers (e.g.
- DataPublisher<T> - Interface in io.objectbox.reactive
- DataPublisherUtils - Class in io.objectbox.reactive
- DataPublisherUtils() - Constructor for class io.objectbox.reactive.DataPublisherUtils
- dataStart() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Deprecated.This method should not be needed anymore, but is left here for the moment to document this API change. It will be removed in the future.
- DataSubscription - Interface in io.objectbox.reactive
-
The result of subscribing an @
DataObserverusing @SubscriptionBuilder.observer(DataObserver). - DataSubscriptionImpl<T> - Class in io.objectbox.reactive
- DataSubscriptionImpl(DataPublisher<T>, Object, DataObserver<T>) - Constructor for class io.objectbox.reactive.DataSubscriptionImpl
- dataSubscriptionList - Variable in class io.objectbox.reactive.SubscriptionBuilder
- dataSubscriptionList(DataSubscriptionList) - Method in class io.objectbox.reactive.SubscriptionBuilder
- DataSubscriptionList - Class in io.objectbox.reactive
-
Tracks any number of
DataSubscriptionobjects, which can be canceled with a singleDataSubscriptionList.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. - Date - Static variable in class io.objectbox.model.PropertyType
-
Date/time stored as a 64-bit (integer) timestamp representing milliseconds since 1970-01-01 (unix epoch)
- DateNano - Enum constant in enum class io.objectbox.annotation.DatabaseType
-
Use with 64-bit long properties to store them as high precision time representing nanoseconds since 1970-01-01 (unix epoch).
- DateNano - Static variable in class io.objectbox.model.PropertyType
-
High precision date/time stored as a 64-bit timestamp representing nanoseconds since 1970-01-01 (unix epoch)
- DateNanoVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Date values (high precision 64-bit timestamp).
- DateVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Date values (64-bit timestamp).
- DbDetachedException - Exception Class in io.objectbox.exception
- DbDetachedException() - Constructor for exception class io.objectbox.exception.DbDetachedException
- DbDetachedException(String) - Constructor for exception class io.objectbox.exception.DbDetachedException
- DbException - Exception Class in io.objectbox.exception
-
General exception for things that may go wrong with the database.
- DbException(String) - Constructor for exception class io.objectbox.exception.DbException
- DbException(String, int) - Constructor for exception class io.objectbox.exception.DbException
- DbException(String, Throwable) - Constructor for exception class io.objectbox.exception.DbException
- DbExceptionListener - Interface in io.objectbox.exception
-
Listener for exceptions occurring during database operations.
- DbExceptionListenerJni - Class in io.objectbox.exception
-
Interface cannot have native methods.
- DbExceptionListenerJni() - Constructor for class io.objectbox.exception.DbExceptionListenerJni
- DbFullException - Exception Class in io.objectbox.exception
-
Thrown when applying a database operation would exceed the (default)
maxSizeInKByteconfigured for the Store. - DbFullException(String) - Constructor for exception class io.objectbox.exception.DbFullException
- DbFullException(String, int) - Constructor for exception class io.objectbox.exception.DbFullException
- DbMaxDataSizeExceededException - Exception Class in io.objectbox.exception
-
Thrown when applying a transaction would exceed the
maxDataSizeInKByteconfigured for the store. - DbMaxDataSizeExceededException(String) - Constructor for exception class io.objectbox.exception.DbMaxDataSizeExceededException
- DbMaxReadersExceededException - Exception Class in io.objectbox.exception
-
Thrown when the maximum of readers (read transactions) was exceeded.
- DbMaxReadersExceededException(String) - Constructor for exception class io.objectbox.exception.DbMaxReadersExceededException
- DbMaxReadersExceededException(String, int) - Constructor for exception class io.objectbox.exception.DbMaxReadersExceededException
- dbName - Variable in class io.objectbox.Property
- dbName(String) - Static method in class io.objectbox.BoxStoreBuilder
- dbNameByClass - Variable in class io.objectbox.BoxStore
- DbSchemaException - Exception Class in io.objectbox.exception
-
Thrown when there is an error with the data schema (data model).
- DbSchemaException(String) - Constructor for exception class io.objectbox.exception.DbSchemaException
- DbShutdownException - Exception Class in io.objectbox.exception
-
Thrown when an error occurred that requires the store to be closed.
- DbShutdownException(String) - Constructor for exception class io.objectbox.exception.DbShutdownException
- DbShutdownException(String, int) - Constructor for exception class io.objectbox.exception.DbShutdownException
- dbType() - Element in annotation interface io.objectbox.annotation.Convert
-
The Property type the Java field value is converted to/from.
- DEAD - Enum constant in enum class io.objectbox.sync.SyncState
- DEBUG_LOG - Enum constant in enum class io.objectbox.internal.Feature
-
Check whether debug log can be enabled during runtime.
- DebugCursor - Class in io.objectbox.internal
-
Not intended for normal use.
- DebugCursor(Transaction, long) - Constructor for class io.objectbox.internal.DebugCursor
- debugFlags - Variable in class io.objectbox.BoxStoreBuilder
- debugFlags() - Method in class io.objectbox.config.FlatStoreOptions
-
For debugging purposes you may want enable specific logging.
- debugFlags(int) - Method in class io.objectbox.BoxStoreBuilder
-
Debug flags typically enable additional logging, see
DebugFlagsfor valid values. - DebugFlags - Class in io.objectbox.config
-
Debug flags typically enable additional "debug logging" that can be helpful to better understand what is going on internally.
- DebugFlags - Class in io.objectbox
-
Deprecated.DebugFlags moved to config package: use
DebugFlagsinstead. - DebugFlags() - Constructor for class io.objectbox.config.DebugFlags
- DebugFlags() - Constructor for class io.objectbox.DebugFlags
-
Deprecated.
- DebugLogIdMapping - Static variable in class io.objectbox.sync.SyncFlags
-
Enable (rather extensive) logging on how IDs are mapped (local invalid input: '<'-> global)
- debugLogs() - Element in annotation interface io.objectbox.annotation.HnswFlags
-
Enables debug logs.
- DebugLogs - Static variable in class io.objectbox.model.HnswFlags
-
Enables debug logs.
- debugLogsDetailed() - Element in annotation interface io.objectbox.annotation.HnswFlags
-
Enables "high volume" debug logs, e.g.
- DebugLogsDetailed - Static variable in class io.objectbox.model.HnswFlags
-
Enables "high volume" debug logs, e.g.
- DebugLogsDisable - Static variable in class io.objectbox.config.TreeOptionFlags
-
If true, debug logs are always disabled for this tree regardless of the store's debug flags.
- DebugLogsEnable - Static variable in class io.objectbox.config.TreeOptionFlags
-
If true, debug logs are always enabled for this tree regardless of the store's debug flags.
- debugRelations - Variable in class io.objectbox.BoxStore
- debugRelations - Variable in class io.objectbox.BoxStoreBuilder
- debugRelations - Variable in class io.objectbox.relation.ToOne
- debugRelations() - Method in class io.objectbox.BoxStoreBuilder
-
Enables some debug logging for relations.
- debugTransactions() - Method in class io.objectbox.BoxStoreBuilder
-
Deprecated.Use
BoxStoreBuilder.debugFlagsinstead. - debugTxRead - Variable in class io.objectbox.BoxStore
- debugTxWrite - Variable in class io.objectbox.BoxStore
- decoder - Variable in class io.objectbox.flatbuffers.Utf8Old.Cache
- decodeUtf8(ByteBuffer, int, int) - Method in class io.objectbox.flatbuffers.Utf8
-
Decodes the given UTF-8 portion of the
ByteBufferinto aString. - decodeUtf8(ByteBuffer, int, int) - Method in class io.objectbox.flatbuffers.Utf8Old
- decodeUtf8(ByteBuffer, int, int) - Method in class io.objectbox.flatbuffers.Utf8Safe
-
Decodes the given UTF-8 portion of the
ByteBufferinto aString. - decodeUtf8Array(byte[], int, int) - Static method in class io.objectbox.flatbuffers.Utf8Safe
- decodeUtf8Buffer(ByteBuffer, int, int) - Static method in class io.objectbox.flatbuffers.Utf8Safe
- DecodeUtil() - Constructor for class io.objectbox.flatbuffers.Utf8.DecodeUtil
- DEFAULT - Enum constant in enum class io.objectbox.annotation.IndexType
-
Use the default index type depending on the property type:
IndexType.VALUEfor scalars andIndexType.HASHfor Strings. - DEFAULT - Enum constant in enum class io.objectbox.annotation.VectorDistanceType
-
The default; currently
VectorDistanceType.EUCLIDEAN. - DEFAULT - Static variable in class io.objectbox.flatbuffers.Utf8
- DEFAULT_BUFFER_SIZE - Static variable in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Default buffer size that is allocated if an initial size is not given, or is non positive.
- 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). - defaultStore - Static variable in class io.objectbox.BoxStore
- DefaultValue - Annotation Interface in io.objectbox.annotation
-
Defines the Java code of the default value to use for a property, when getting an existing entity and the database value for the property is null.
- DelegatingObserver<T> - Interface in io.objectbox.reactive
- deleteAll() - Method in class io.objectbox.Cursor
- 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!
- deleteEntity(long) - Method in class io.objectbox.Cursor
- 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)".
- DetectNonUniqueNodes - Static variable in class io.objectbox.config.TreeOptionFlags
-
Nodes described in AllowNonUniqueNodes will be automatically detected to consolidate them (manually).
- diagnose() - Method in class io.objectbox.BoxStore
-
Gives info that can be useful for debugging.
- dimensions() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
Dimensions of vectors; vector data with fewer dimensions are ignored.
- dimensions() - Method in class io.objectbox.model.HnswParams
-
Dimensions of vectors; vector data with less dimensions are ignored.
- directory - Variable in class io.objectbox.BoxStore
- directory - Variable in class io.objectbox.BoxStoreBuilder
-
BoxStore uses this (not baseDirectory/name)
- directory(File) - Method in class io.objectbox.BoxStoreBuilder
-
The directory where all database files should be placed in.
- directoryPath() - Method in class io.objectbox.config.FlatStoreOptions
-
Location of the database on disk; this will be a directory containing files.
- directoryPathAsByteBuffer() - Method in class io.objectbox.config.FlatStoreOptions
- directoryPathInByteBuffer(ByteBuffer) - Method in class io.objectbox.config.FlatStoreOptions
- DISCONNECTED - Enum constant in enum class io.objectbox.sync.SyncState
- distanceType() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
The distance type used for the HNSW index.
- distanceType() - Method in class io.objectbox.model.HnswParams
-
The distance type used for the HNSW index; if none is given, the default Euclidean is used.
- distinct - Variable in class io.objectbox.query.PropertyQuery
- 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_SENSITIVEif you want to have case sensitive distinct values (e.g. - DOT_PRODUCT - Enum constant in enum class io.objectbox.annotation.VectorDistanceType
-
For normalized vectors (vector length == 1.0), the dot product is equivalent to the cosine similarity.
- DOT_PRODUCT_NON_NORMALIZED - Enum constant in enum class io.objectbox.annotation.VectorDistanceType
-
A custom dot product similarity measure that does not require the vectors to be normalized.
- DotProduct - Static variable in class io.objectbox.model.HnswDistanceType
-
For normalized vectors (vector length == 1.0), the dot product is equivalent to the cosine similarity.
- DotProductNonNormalized - Static variable in class io.objectbox.model.HnswDistanceType
-
A custom dot product similarity measure that does not require the vectors to be normalized.
- Double - Static variable in class io.objectbox.model.PropertyType
-
64-bit floating point number
- DoubleCondition(Property<T>, PropertyQueryConditionImpl.DoubleCondition.Operation, double) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition
- DoubleDoubleCondition(Property<T>, PropertyQueryConditionImpl.DoubleDoubleCondition.Operation, double, double) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition
- DoubleVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of double values.
- DoubleVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Double values (64-bit floating point numbers)
- DoubleVector() - Constructor for class io.objectbox.flatbuffers.DoubleVector
- dValue - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
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.
- EagerRelation<S,
T> - Class in io.objectbox.query - EagerRelation(int, RelationInfo<S, T>) - Constructor for class io.objectbox.query.EagerRelation
- eagerRelations - Variable in class io.objectbox.query.Query
- eagerRelations - Variable in class io.objectbox.query.QueryBuilder
- element_size - Variable in class io.objectbox.flatbuffers.BaseVector
-
Used to hold the vector element size in table.
- elemType - Variable in class io.objectbox.flatbuffers.FlexBuffers.TypedVector
- elemWidth(int, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- elemWidth(int, int, long, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- empty() - Static method in class io.objectbox.flatbuffers.FlexBuffers.Blob
-
Return an empty
FlexBuffers.Blob - empty() - Static method in class io.objectbox.flatbuffers.FlexBuffers.Key
-
Return an empty
FlexBuffers.Key - empty() - Static method in class io.objectbox.flatbuffers.FlexBuffers.Map
-
Returns an empty
FlexBuffers.Map - empty() - Static method in class io.objectbox.flatbuffers.FlexBuffers.TypedVector
- empty() - Static method in class io.objectbox.flatbuffers.FlexBuffers.Vector
-
Returns an empty
FlexBuffers.Map - EMPTY - Static variable in class io.objectbox.flatbuffers.FlexBuffers.Blob
- EMPTY - Static variable in class io.objectbox.flatbuffers.FlexBuffers.Key
- EMPTY_BB - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- EMPTY_MAP - Static variable in class io.objectbox.flatbuffers.FlexBuffers.Map
- EMPTY_VECTOR - Static variable in class io.objectbox.flatbuffers.FlexBuffers.TypedVector
- EMPTY_VECTOR - Static variable in class io.objectbox.flatbuffers.FlexBuffers.Vector
- enableCreationStackTracking() - Static method in class io.objectbox.InternalAccess
-
Makes creation more expensive, but lets Finalizers show the creation stack for dangling resources.
- enableNull - Variable in class io.objectbox.query.PropertyQuery
- encodedLength(CharSequence) - Method in class io.objectbox.flatbuffers.Utf8
-
Returns the number of bytes in the UTF-8-encoded form of
sequence. - encodedLength(CharSequence) - Method in class io.objectbox.flatbuffers.Utf8Old
- encodedLength(CharSequence) - Method in class io.objectbox.flatbuffers.Utf8Safe
- encodedLengthGeneral(CharSequence, int) - Static method in class io.objectbox.flatbuffers.Utf8Safe
- encoder - Variable in class io.objectbox.flatbuffers.Utf8Old.Cache
- encodeUtf8(CharSequence, ByteBuffer) - Method in class io.objectbox.flatbuffers.Utf8
-
Encodes the given characters to the target
ByteBufferusing UTF-8 encoding. - encodeUtf8(CharSequence, ByteBuffer) - Method in class io.objectbox.flatbuffers.Utf8Old
- encodeUtf8(CharSequence, ByteBuffer) - Method in class io.objectbox.flatbuffers.Utf8Safe
-
Encodes the given characters to the target
ByteBufferusing UTF-8 encoding. - encodeUtf8Array(CharSequence, byte[], int, int) - Static method in class io.objectbox.flatbuffers.Utf8Safe
- encodeUtf8Buffer(CharSequence, ByteBuffer) - Static method in class io.objectbox.flatbuffers.Utf8Safe
- encodeUtf8CodePoint(CharSequence, int, byte[]) - Static method in class io.objectbox.flatbuffers.Utf8
-
Encode a Java's CharSequence UTF8 codepoint into a byte array.
- end - Variable in class io.objectbox.flatbuffers.FlexBuffers.Object
- end - Variable in class io.objectbox.flatbuffers.FlexBuffers.Reference
- endClusterPeerConfig(FlatBufferBuilder) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- endCredentials(FlatBufferBuilder) - Static method in class io.objectbox.sync.Credentials
- endFlatStoreOptions(FlatBufferBuilder) - Static method in class io.objectbox.config.FlatStoreOptions
- endHnswParams(FlatBufferBuilder) - Static method in class io.objectbox.model.HnswParams
- endJwtConfig(FlatBufferBuilder) - Static method in class io.objectbox.sync.server.JwtConfig
- endMap(String, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Finishes a map, but writing the information in the buffer
- endModel(FlatBufferBuilder) - Static method in class io.objectbox.model.Model
- endModelEntity(FlatBufferBuilder) - Static method in class io.objectbox.model.ModelEntity
- endModelProperty(FlatBufferBuilder) - Static method in class io.objectbox.model.ModelProperty
- endModelRelation(FlatBufferBuilder) - Static method in class io.objectbox.model.ModelRelation
- ENDS_WITH - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- endsWith(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - endsWith(String) - Method in class io.objectbox.Property
-
Creates an ends with condition using
StringOrder#CASE_SENSITIVE. - endsWith(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
- endSyncServerOptions(FlatBufferBuilder) - Static method in class io.objectbox.sync.server.SyncServerOptions
- endTable() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finish off writing the object that is under construction.
- endVector() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finish off the creation of an array and all its elements.
- endVector(String, int, boolean, boolean) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Finishes a vector, but writing the information in the buffer
- EnforceUniquePath - Static variable in class io.objectbox.config.TreeOptionFlags
-
By default, a path such as "a/b/c" can address a branch and a leaf at the same time.
- ensureBoxes() - Method in class io.objectbox.relation.ToMany
- ensureBoxes(TARGET) - Method in class io.objectbox.relation.ToOne
- ensureEntities() - Method in class io.objectbox.relation.ToMany
- ensureEntitiesWithTrackingLists() - Method in class io.objectbox.relation.ToMany
- ensureLoaded() - Static method in class io.objectbox.internal.NativeLibraryLoader
- ensureNoComparator() - Method in class io.objectbox.query.Query
- ensureNoFilter() - Method in class io.objectbox.query.Query
- ensureNoFilterNoComparator() - Method in class io.objectbox.query.Query
- entities - Variable in class io.objectbox.query.LazyList
- entities - Variable in class io.objectbox.relation.ToMany
- entities(int) - Method in class io.objectbox.model.Model
- entities(ModelEntity, int) - Method in class io.objectbox.model.Model
- entitiesAdded - Variable in class io.objectbox.relation.ToMany
-
Entities added since last put/sync.
- entitiesLength() - Method in class io.objectbox.model.Model
- entitiesRemoved - Variable in class io.objectbox.relation.ToMany
-
Entities removed since last put/sync.
- entitiesToPut - Variable in class io.objectbox.relation.ToMany
- entitiesToRemoveFromDb - Variable in class io.objectbox.relation.ToMany
- entitiesVector() - Method in class io.objectbox.model.Model
- entitiesVector(ModelEntity.Vector) - Method in class io.objectbox.model.Model
- entity - Variable in class io.objectbox.Property
- entity - Variable in class io.objectbox.relation.ToMany
- entity - Variable in class io.objectbox.relation.ToOne
- entity(EntityInfo<?>) - Method in class io.objectbox.BoxStoreBuilder
- entity(String) - Method in class io.objectbox.ideasonly.ModelModifier
- entity(String) - Method in class io.objectbox.ModelBuilder
- Entity - Annotation Interface in io.objectbox.annotation
-
Marks a class as an ObjectBox Entity.
- entityBox - Variable in class io.objectbox.relation.ToMany
- entityBox - Variable in class io.objectbox.relation.ToOne
- EntityBuilder(String) - Constructor for class io.objectbox.ModelBuilder.EntityBuilder
- entityClass - Variable in class io.objectbox.Box
- entityCounts - Variable in class io.objectbox.relation.ToMany
-
Counts of all entities in the list (
ToMany.entities). - entityDone() - Method in class io.objectbox.ModelBuilder.EntityBuilder
- EntityFlags - Class in io.objectbox.model
-
Not really an enum, but binary flags to use across languages
- EntityFlags() - Constructor for class io.objectbox.model.EntityFlags
- entityInfo - Variable in class io.objectbox.Box
- entityInfo - Variable in class io.objectbox.Cursor
- EntityInfo<T> - Interface in io.objectbox
- entityInfoList - Variable in class io.objectbox.BoxStoreBuilder
- entityModifier - Variable in class io.objectbox.ideasonly.ModelModifier.PropertyModifier
- EntityModifier(String, String) - Constructor for class io.objectbox.ideasonly.ModelModifier.EntityModifier
- entityOffsets - Variable in class io.objectbox.ModelBuilder
- entityTypeId - Variable in class io.objectbox.sync.SyncChange
- entityTypeIdByClass - Variable in class io.objectbox.BoxStore
- entityTypeIds - Variable in class io.objectbox.ObjectClassPublisher.PublishRequest
- eq(Object) - Method in class io.objectbox.Property
-
Deprecated.Use
Property.equal(boolean)instead. - equal(boolean) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- equal(byte[]) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- equal(double, double) - Method in class io.objectbox.Property
-
Calls
Property.between(double, double)withvalue - toleranceas lower bound andvalue + toleranceas upper bound. - equal(int) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- equal(long) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- equal(short) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- equal(Property<T>, boolean) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - equal(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - equal(Property<T>, double, double) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - equal(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - equal(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - equal(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - equal(String) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property using
StringOrder#CASE_SENSITIVE. - equal(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- equal(Date) - Method in class io.objectbox.Property
-
Creates an "equal ('=')" condition for this property.
- EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
- EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- equals(Object) - Method in class io.objectbox.flatbuffers.FlexBuffers.Key
-
Compare keys
- equals(Object) - Method in class io.objectbox.reactive.WeakDataObserver
- equals(Object) - Method in class io.objectbox.relation.ToOne
- errorCode - Variable in exception class io.objectbox.exception.DbException
- errorObserver - Variable in class io.objectbox.reactive.SubscriptionBuilder
- ErrorObserver - Interface in io.objectbox.reactive
-
Exceptions thrown in
DataObserverand @DataTransformercan be observed by an error observer set viaSubscriptionBuilder.onError(ErrorObserver). - Euclidean - Static variable in class io.objectbox.model.HnswDistanceType
-
The default; typically "Euclidean squared" internally.
- EUCLIDEAN - Enum constant in enum class io.objectbox.annotation.VectorDistanceType
-
Typically "Euclidean squared" internally.
- Experimental - Annotation Interface in io.objectbox.annotation.apihint
-
APIs annotated with @Experimental are likely to change and may be even removed in a future release.
- EXPIRATION_TIME - Static variable in class io.objectbox.model.PropertyFlags
-
If a date property has this flag (max.
F
- Factory<T> - Interface in io.objectbox
-
Generic Factory that provides a resource on demand (if and when it is required).
- FAIL - Enum constant in enum class io.objectbox.annotation.ConflictStrategy
-
Throws UniqueViolationException if any property violates a
Uniqueconstraint. - failedReadTxAttemptCallback - Variable in class io.objectbox.BoxStore
- failedReadTxAttemptCallback - Variable in class io.objectbox.BoxStoreBuilder
- failedReadTxAttemptCallback(TxCallback<?>) - Method in class io.objectbox.BoxStoreBuilder
-
Define a callback for failed read transactions during retires (see also
BoxStoreBuilder.queryAttempts(int)). - fbb - Variable in class io.objectbox.ModelBuilder
- FBT_BLOB - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a blob type
- FBT_BOOL - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a boolean type
- FBT_FLOAT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a float type
- FBT_INDIRECT_FLOAT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a indirect float type
- FBT_INDIRECT_INT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a indirect signed integer type
- FBT_INDIRECT_UINT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a indirect unsigned integer type
- FBT_INT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a signed integer type
- FBT_KEY - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a key to a map type
- FBT_MAP - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a map type
- FBT_NULL - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a null type
- FBT_STRING - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a string type
- FBT_UINT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a unsigned type
- FBT_VECTOR - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector type
- FBT_VECTOR_BOOL - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector of booleans type
- FBT_VECTOR_FLOAT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector of floats type
- FBT_VECTOR_FLOAT2 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_FLOAT3 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_FLOAT4 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_INT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector of signed integers type
- FBT_VECTOR_INT2 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_INT3 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_INT4 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_KEY - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector of keys type
- FBT_VECTOR_STRING_DEPRECATED - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector of strings type
- FBT_VECTOR_UINT - Static variable in class io.objectbox.flatbuffers.FlexBuffers
-
Represent a vector of unsigned integers type
- FBT_VECTOR_UINT2 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_UINT3 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- FBT_VECTOR_UINT4 - Static variable in class io.objectbox.flatbuffers.FlexBuffers
- Feature - Enum Class in io.objectbox.internal
-
Use with
BoxStore.hasFeature(Feature). - Feature(int) - Constructor for enum class io.objectbox.internal.Feature
- FeatureNotAvailableException - Exception Class in io.objectbox.exception
-
Thrown when a special feature was used, which is not part of the native library.
- FeatureNotAvailableException(String) - Constructor for exception class io.objectbox.exception.FeatureNotAvailableException
- fields - Variable in class io.objectbox.internal.ReflectionCache
- FILE_IDENTIFIER_LENGTH - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in a file identifier.
- FileCorruptException - Exception Class in io.objectbox.exception
-
Errors were detected in a database file, e.g.
- FileCorruptException(String) - Constructor for exception class io.objectbox.exception.FileCorruptException
- FileCorruptException(String, int) - Constructor for exception class io.objectbox.exception.FileCorruptException
- fileMode - Variable in class io.objectbox.BoxStoreBuilder
- fileMode() - Method in class io.objectbox.config.FlatStoreOptions
-
File permissions given in Unix style octal bit flags (e.g.
- fileMode(int) - Method in class io.objectbox.BoxStoreBuilder
-
Specify unix-style file permissions for database files.
- filter - Variable in class io.objectbox.query.Query
- filter - Variable in class io.objectbox.query.QueryBuilder
- 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
-
Closes this if this is finalized.
- finalize() - Method in class io.objectbox.Cursor
-
Explicitly call
Cursor.close()instead to avoid expensive finalization. - finalize() - Method in class io.objectbox.internal.DebugCursor
-
Explicitly call
DebugCursor.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
-
Typically
QueryBuilder.build()is called on this which callsQueryBuilder.close()and avoids expensive finalization here. - finalize() - Method in class io.objectbox.sync.server.SyncServerImpl
-
Users of this class should explicitly call
SyncServerImpl.close()instead to avoid expensive finalization. - finalize() - Method in class io.objectbox.sync.SyncClientImpl
-
Users of this class should explicitly call
SyncClientImpl.close()instead to avoid expensive finalization. - finalize() - Method in class io.objectbox.sync.SyncHybrid
-
Users of this class should explicitly call
SyncHybrid.close()instead to avoid expensive finalization. - finalize() - Method in class io.objectbox.Transaction
-
Explicitly call
Transaction.close()instead to avoid expensive finalization. - find() - Method in class io.objectbox.query.Query
-
Finds objects matching the query.
- find(long, long) - Method in class io.objectbox.query.Query
-
Like
Query.find(), but can skip and limit results. - 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
-
Finds the first object matching this query.
- findFirstId() - Method in class io.objectbox.query.Query
-
Like
Query.findFirst(), but returns just the ID of the object. - 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
-
Like
Query.find(), but returns just the IDs of the objects. - findIds(long, long) - Method in class io.objectbox.query.Query
-
Like
Query.findIds(), but can skip and limit results. - findIdsWithScores() - Method in class io.objectbox.query.Query
-
Finds IDs of objects matching the query associated to their query score (e.g.
- findIdsWithScores(long, long) - Method in class io.objectbox.query.Query
-
Like
Query.findIdsWithScores(), but can skip and limit results. - 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
-
Like
Query.findIds(), but wraps the Object IDs in an unmodifiableLazyListso Objects can be retrieved on demand. - findLazyCached() - Method in class io.objectbox.query.Query
-
Like
Query.findIds(), but wraps the Object IDs in an unmodifiable, cachingLazyListso Objects can be retrieved on demand. - 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.
- findNumber() - Method in class io.objectbox.query.PropertyQuery
- findPlatform() - Static method in class io.objectbox.sync.internal.Platform
- 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
-
Finds the only object matching this query.
- findUniqueId() - Method in class io.objectbox.query.Query
-
Like
Query.findUnique(), but returns just the ID of the object. - findWithScores() - Method in class io.objectbox.query.Query
-
Finds objects matching the query associated to their query score (e.g.
- findWithScores(long, long) - Method in class io.objectbox.query.Query
-
Like
Query.findWithScores(), but can skip and limit results. - finish() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Finish writing the message into the buffer.
- finish() - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- finish(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finalize a buffer, pointing to the given `root_table`.
- finish(int, boolean) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finalize a buffer, pointing to the given `root_table`.
- finish(int, String) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finalize a buffer, pointing to the given `root_table`.
- finish(int, String, boolean) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finalize a buffer, pointing to the given `root_table`.
- finished - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- finished - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- finished - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- finished - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- finished() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Should not be accessing the final buffer before it is finished.
- finishFlatStoreOptionsBuffer(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- finishModelBuffer(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- finishSizePrefixed(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finalize a buffer, pointing to the given `root_table`, with the size prefixed.
- finishSizePrefixed(int, String) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Finalize a buffer, pointing to the given `root_table`, with the size prefixed.
- finishSizePrefixedFlatStoreOptionsBuffer(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- finishSizePrefixedModelBuffer(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- finishSizePrefixedSyncServerOptionsBuffer(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- finishSyncServerOptionsBuffer(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- first() - Method in class io.objectbox.Cursor
- firstLoginLatch - Variable in class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
- FixedFollower - Static variable in class io.objectbox.sync.server.ClusterFlags
-
Indicates that this cluster always stays in the "follower" cluster role.
- flags - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- flags - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- flags - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- flags() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
See
HnswFlags. - flags() - Method in class io.objectbox.model.HnswParams
- flags() - Method in class io.objectbox.model.ModelEntity
-
Can be language specific, e.g.
- flags() - Method in class io.objectbox.model.ModelProperty
-
bit flags: e.g.
- flags(int) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- flags(int) - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- FlatBufferBuilder - Class in io.objectbox.flatbuffers
-
Class that helps you build a FlatBuffer.
- FlatBufferBuilder() - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder
-
Start with a buffer of 1KiB, then grow as required.
- FlatBufferBuilder(int) - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder
-
Start with a buffer of size `initial_size`, then grow as required.
- FlatBufferBuilder(int, FlatBufferBuilder.ByteBufferFactory) - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder
-
Start with a buffer of size `initial_size`, then grow as required.
- FlatBufferBuilder(int, FlatBufferBuilder.ByteBufferFactory, ByteBuffer, Utf8) - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder
-
Start with a buffer of size `initial_size`, then grow as required.
- FlatBufferBuilder(ByteBuffer) - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder
-
Alternative constructor allowing reuse of
ByteBuffers. - FlatBufferBuilder(ByteBuffer, FlatBufferBuilder.ByteBufferFactory) - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder
-
Alternative constructor allowing reuse of
ByteBuffers. - FlatBufferBuilder.ByteBufferBackedInputStream - Class in io.objectbox.flatbuffers
-
A class that allows a user to create an InputStream from a ByteBuffer.
- FlatBufferBuilder.ByteBufferFactory - Class in io.objectbox.flatbuffers
-
An interface that provides a user of the FlatBufferBuilder class the ability to specify the method in which the internal buffer gets allocated.
- FlatBufferBuilder.HeapByteBufferFactory - Class in io.objectbox.flatbuffers
-
An implementation of the ByteBufferFactory interface that is used when one is not provided by the user.
- FLATBUFFERS_23_5_26() - Static method in class io.objectbox.flatbuffers.Constants
-
A version identifier to force a compile error if someone accidentally tries to build generated code with a runtime of two mismatched version.
- FlatStoreOptions - Class in io.objectbox.config
-
Options to open a store with.
- FlatStoreOptions() - Constructor for class io.objectbox.config.FlatStoreOptions
- FlatStoreOptions.Vector - Class in io.objectbox.config
- Flex - Static variable in class io.objectbox.model.PropertyType
-
"Flexible" type, which may contain scalars (integers, floating points), strings or containers (lists and maps).
- FlexBufferException(String) - Constructor for exception class io.objectbox.flatbuffers.FlexBuffers.FlexBufferException
- FlexBuffers - Class in io.objectbox.flatbuffers
-
This class can be used to parse FlexBuffer messages.
- FlexBuffers() - Constructor for class io.objectbox.flatbuffers.FlexBuffers
- FlexBuffers.Blob - Class in io.objectbox.flatbuffers
-
Represents a array of bytes element in the buffer
- FlexBuffers.FlexBufferException - Exception Class in io.objectbox.flatbuffers
- FlexBuffers.Key - Class in io.objectbox.flatbuffers
-
Represents a key element in the buffer.
- FlexBuffers.KeyVector - Class in io.objectbox.flatbuffers
-
Represent a vector of keys in a map
- FlexBuffers.Map - Class in io.objectbox.flatbuffers
-
Map object representing a set of key-value pairs.
- FlexBuffers.Object - Class in io.objectbox.flatbuffers
-
Base class of all types below.
- FlexBuffers.Reference - Class in io.objectbox.flatbuffers
-
Represents an generic element in the buffer.
- FlexBuffers.Sized - Class in io.objectbox.flatbuffers
- FlexBuffers.TypedVector - Class in io.objectbox.flatbuffers
-
Object that represents a set of elements with the same type
- FlexBuffers.Unsigned - Class in io.objectbox.flatbuffers
- FlexBuffers.Vector - Class in io.objectbox.flatbuffers
-
Object that represents a set of elements in the buffer
- FlexBuffersBuilder - Class in io.objectbox.flatbuffers
-
Helper class that builds FlexBuffers
- FlexBuffersBuilder() - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Constructs a newly allocated
FlexBuffersBuilderwithFlexBuffersBuilder.BUILDER_FLAG_SHARE_KEYSset. - FlexBuffersBuilder(int) - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Constructs a newly allocated
FlexBuffersBuilderwithFlexBuffersBuilder.BUILDER_FLAG_SHARE_KEYSset. - FlexBuffersBuilder(ReadWriteBuf, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder
- FlexBuffersBuilder(ByteBuffer) - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Constructs a newly allocated
FlexBuffersBuilder. - FlexBuffersBuilder(ByteBuffer, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Deprecated.
- FlexBuffersBuilder.Value - Class in io.objectbox.flatbuffers
- FlexObjectConverter - Class in io.objectbox.converter
-
Converts between
Objectproperties and byte arrays using FlexBuffers. - FlexObjectConverter() - Constructor for class io.objectbox.converter.FlexObjectConverter
- Float - Static variable in class io.objectbox.model.PropertyType
-
32-bit floating point number
- float32(int, float) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- float64(int, double) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- floatingValue - Variable in class io.objectbox.tree.LeafNode
- FloatVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of float values.
- FloatVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Float values (32-bit floating point numbers)
- FloatVector() - Constructor for class io.objectbox.flatbuffers.FloatVector
- flowableOneByOne(Query<T>) - Static method in class io.objectbox.rx3.RxQuery
-
The returned Flowable emits Query results one by one.
- flowableOneByOne(Query<T>, BackpressureStrategy) - Static method in class io.objectbox.rx3.RxQuery
-
The returned Flowable emits Query results one by one.
- force_defaults - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- forceDefaults(boolean) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
In order to save space, fields that are set to their default value don't get serialized into the buffer.
- forEach(QueryConsumer<T>) - Method in class io.objectbox.query.Query
-
Emits query results one by one to the given consumer (synchronously).
- fromId(int) - Static method in enum class io.objectbox.sync.SyncState
- Full - Static variable in class io.objectbox.config.ValidateOnOpenModePages
-
Performs a unlimited number of checks on database structures including "data leaves".
- Full - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.Performs a unlimited number of checks on database structures including "data leaves".
G
- Geo - Static variable in class io.objectbox.model.HnswDistanceType
-
For geospatial coordinates aka latitude/longitude pairs.
- GEO - Enum constant in enum class io.objectbox.annotation.VectorDistanceType
-
For geospatial coordinates, more specifically latitude and longitude pairs.
- get() - Method in class io.objectbox.query.ObjectWithScore
-
Returns the matching object.
- get(byte[]) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- get(byte[]) - Method in class io.objectbox.internal.DebugCursor
- get(int) - Method in class io.objectbox.config.FlatStoreOptions.Vector
- get(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- get(int) - Method in class io.objectbox.flatbuffers.BooleanVector
-
Reads the boolean at the given index.
- get(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- get(int) - Method in class io.objectbox.flatbuffers.ByteVector
-
Reads the byte at the given index.
- get(int) - Method in class io.objectbox.flatbuffers.DoubleVector
-
Reads the double value at the given index.
- get(int) - Method in class io.objectbox.flatbuffers.FlexBuffers.Blob
-
Return individual byte at a given position
- get(int) - Method in class io.objectbox.flatbuffers.FlexBuffers.KeyVector
-
Return key
- get(int) - Method in class io.objectbox.flatbuffers.FlexBuffers.TypedVector
-
Get reference to an object in the
Vector - get(int) - Method in class io.objectbox.flatbuffers.FlexBuffers.Vector
-
Get a element in a vector by index
- get(int) - Method in class io.objectbox.flatbuffers.FloatVector
-
Reads the float value at the given index.
- get(int) - Method in class io.objectbox.flatbuffers.IntVector
-
Reads the integer at the given index.
- get(int) - Method in class io.objectbox.flatbuffers.LongVector
-
Reads the long value at the given index.
- get(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read a byte from data.
- get(int) - Method in class io.objectbox.flatbuffers.ShortVector
-
Reads the short value at the given index.
- get(int) - Method in class io.objectbox.flatbuffers.StringVector
-
Reads the String at the given index.
- get(int) - Method in class io.objectbox.model.HnswParams.Vector
- get(int) - Method in class io.objectbox.model.IdUid.Vector
- get(int) - Method in class io.objectbox.model.Model.Vector
- get(int) - Method in class io.objectbox.model.ModelEntity.Vector
- get(int) - Method in class io.objectbox.model.ModelProperty.Vector
- get(int) - Method in class io.objectbox.model.ModelRelation.Vector
- get(int) - Method in class io.objectbox.query.LazyList
-
Gets and returns the Object at the specified position in this list from its Box.
- get(int) - Method in class io.objectbox.relation.ToMany
-
Gets the target object at the given index.
- get(int) - Method in class io.objectbox.sync.Credentials.Vector
- get(int) - Method in class io.objectbox.sync.server.ClusterPeerConfig.Vector
- get(int) - Method in class io.objectbox.sync.server.JwtConfig.Vector
- get(int) - Method in class io.objectbox.sync.server.SyncServerOptions.Vector
- get(long) - Method in class io.objectbox.Box
-
Get the stored object for the given ID.
- get(long) - Method in class io.objectbox.Cursor
- get(long) - Method in class io.objectbox.KeyValueCursor
- get(long[]) - Method in class io.objectbox.Box
-
Get the stored objects for the given IDs.
- get(FlatStoreOptions, int) - Method in class io.objectbox.config.FlatStoreOptions.Vector
- get(Table, int) - Method in class io.objectbox.flatbuffers.UnionVector
-
Initialize any Table-derived type to point to the union at the given `index`.
- get(HnswParams, int) - Method in class io.objectbox.model.HnswParams.Vector
- get(IdUid, int) - Method in class io.objectbox.model.IdUid.Vector
- get(ModelEntity, int) - Method in class io.objectbox.model.ModelEntity.Vector
- get(Model, int) - Method in class io.objectbox.model.Model.Vector
- get(ModelProperty, int) - Method in class io.objectbox.model.ModelProperty.Vector
- get(ModelRelation, int) - Method in class io.objectbox.model.ModelRelation.Vector
- get(Credentials, int) - Method in class io.objectbox.sync.Credentials.Vector
- get(ClusterPeerConfig, int) - Method in class io.objectbox.sync.server.ClusterPeerConfig.Vector
- get(JwtConfig, int) - Method in class io.objectbox.sync.server.JwtConfig.Vector
- get(SyncServerOptions, int) - Method in class io.objectbox.sync.server.SyncServerOptions.Vector
- get(Iterable<Long>) - Method in class io.objectbox.Box
-
Get the stored objects for the given IDs.
- get(String) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- getActiveSubscriptionCount() - Method in class io.objectbox.reactive.DataSubscriptionList
-
Returns number of active (added) subscriptions (resets to 0 after
DataSubscriptionList.cancel()). - getActiveTx(BoxStore) - Static method in class io.objectbox.InternalAccess
- getActiveTxCursor() - Method in class io.objectbox.Box
- 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.
- getAll() - Method in class io.objectbox.Cursor
- getAllEntityClasses() - Method in class io.objectbox.BoxStore
- getAllEntityTypeIds() - Method in class io.objectbox.BoxStore
- getAllProperties() - Method in interface io.objectbox.EntityInfo
- getAndroidBaseDir(Object) - Static method in class io.objectbox.BoxStoreBuilder
- getAndroidDbDir(Object, String) - Static method in class io.objectbox.BoxStoreBuilder
- getAndroidFilesDir(Object) - Static method in class io.objectbox.BoxStoreBuilder
- getApplicationContext(Object) - Method in class io.objectbox.BoxStoreBuilder
- getAsUnsigned(int) - Method in class io.objectbox.flatbuffers.ByteVector
-
Reads the byte at the given index, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
- getAsUnsigned(int) - Method in class io.objectbox.flatbuffers.IntVector
-
Reads the integer at the given index, zero-extends it to type long, and returns the result, which is therefore in the range 0 through 4294967295.
- getAsUnsigned(int) - Method in class io.objectbox.flatbuffers.ShortVector
-
Reads the short at the given index, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 65535.
- getBacklinkEntities(int, Property<?>, long) - Method in class io.objectbox.Cursor
- getBacklinkIds(int, Property<?>, long) - Method in class io.objectbox.Cursor
- getBoolean(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getBoolean(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getBoolean(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read boolean from data.
- getBuffer() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Return `ByteBuffer` containing FlexBuffer message.
- getById(long) - Method in class io.objectbox.relation.ToMany
-
Gets an object by its ID.
- getByteBuffer() - Method in class io.objectbox.flatbuffers.Table
-
Get the underlying ByteBuffer.
- getBytes() - Method in class io.objectbox.flatbuffers.FlexBuffers.Blob
-
Copy blob into a byte[]
- getCachedTarget() - Method in class io.objectbox.relation.ToOne
- getCanonicalPath(File) - Static method in class io.objectbox.BoxStore
- getChangedIds() - Method in class io.objectbox.sync.SyncChange
-
IDs of objects that have been changed; e.g.
- getClient() - Method in class io.objectbox.sync.SyncHybrid
-
Returns the
SyncClientof this hybrid, typically only to set Sync listeners. - getConnectivityMonitor() - Method in class io.objectbox.sync.internal.Platform
- getContext() - Static method in class io.objectbox.BoxStore
- getCpuArch() - Static method in class io.objectbox.internal.NativeLibraryLoader
-
Get CPU architecture of the JVM (Note: this can not be used for Android, Android decides arch on its own and looks for library in appropriately named folder).
- getCpuArchOSOrNull() - Static method in class io.objectbox.internal.NativeLibraryLoader
-
Get architecture using operating system tools.
- getCurrent() - Method in class io.objectbox.KeyValueCursor
- getCursorFactory() - Method in interface io.objectbox.EntityInfo
- getDbDir(File, String) - Static method in class io.objectbox.BoxStoreBuilder
- getDbName() - Method in interface io.objectbox.EntityInfo
- getDbName(Class<?>) - Method in class io.objectbox.BoxStore
- getDbSize() - Method in class io.objectbox.BoxStore
-
Get the size of this store.
- getDbSizeOnDisk() - Method in class io.objectbox.BoxStore
-
The size in bytes occupied by the database on disk (if any).
- getDefault() - Static method in class io.objectbox.BoxStore
-
Convenience singleton instance which gets set up using
BoxStoreBuilder.buildDefault(). - getDefault() - Static method in class io.objectbox.flatbuffers.Utf8
-
Get the default UTF-8 processor.
- getDouble() - Method in class io.objectbox.tree.Leaf
- getDouble(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getDouble(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getDouble(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read a 64-bit float from data.
- getDouble(long) - Method in class io.objectbox.tree.Tree
-
Get data value for the given ID or null if no data leaf exists with that ID.
- getElemType() - Method in class io.objectbox.flatbuffers.FlexBuffers.TypedVector
-
Return element type for all elements in the vector
- getEntity() - Method in class io.objectbox.relation.ToMany
-
For tests
- getEntity() - Method in class io.objectbox.relation.ToOne
-
For tests
- getEntityClass() - Method in class io.objectbox.Box
- getEntityClass() - Method in interface io.objectbox.EntityInfo
- getEntityClassOrThrow(int) - Method in class io.objectbox.BoxStore
- getEntityId() - Method in interface io.objectbox.EntityInfo
- getEntityId() - Method in class io.objectbox.Property
- getEntityInfo() - Method in class io.objectbox.Box
- getEntityInfo() - Method in class io.objectbox.Cursor
- getEntityInfo(Class<T>) - Method in class io.objectbox.BoxStore
- 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. - getEntityTypeId(Class<?>) - Method in class io.objectbox.BoxStore
- getEntityTypeIdOrThrow(Class<?>) - Method in class io.objectbox.BoxStore
- getEqualOrGreater(long) - Method in class io.objectbox.KeyValueCursor
- getErrorCode() - Method in exception class io.objectbox.exception.DbException
-
0 == no error code available
- getField(Class<?>, String) - Method in class io.objectbox.internal.ReflectionCache
- getFirst() - Method in class io.objectbox.KeyValueCursor
- getFloat(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getFloat(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getFloat(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read a 32-bit float from data.
- getHandle() - Method in class io.objectbox.sync.server.SyncServerImpl
- getHandle() - Method in class io.objectbox.sync.SyncClientImpl
- getHandle() - Method in class io.objectbox.tree.Tree
- getHandle(Transaction) - Static method in class io.objectbox.InternalAccess
- getId() - Method in class io.objectbox.Property
- getId() - Method in class io.objectbox.query.IdWithScore
-
Returns the object ID.
- getId() - Method in class io.objectbox.tree.Branch
- getId() - Method in class io.objectbox.tree.Leaf
- getId(T) - Method in class io.objectbox.Box
- getId(T) - Method in class io.objectbox.Cursor
- getId(T) - Method in interface io.objectbox.internal.IdGetter
-
Given object must be non-null and have a non-null ID.
- getIdGetter() - Method in interface io.objectbox.EntityInfo
- getIdProperty() - Method in interface io.objectbox.EntityInfo
- getInstance() - Static method in class io.objectbox.internal.ReflectionCache
- getInt() - Method in class io.objectbox.tree.Leaf
- getInt(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getInt(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getInt(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read a 32-bit int from data.
- getInteger(long) - Method in class io.objectbox.tree.Tree
-
Get data value for the given ID or null if no data leaf exists with that ID.
- getKey() - Method in class io.objectbox.KeyValueCursor
- getLast() - Method in class io.objectbox.KeyValueCursor
- getLastLoginCode() - Method in interface io.objectbox.sync.SyncClient
-
Response code of last login attempt.
- getLastLoginCode() - Method in class io.objectbox.sync.SyncClientImpl
- getLeaf(long) - Method in class io.objectbox.tree.Tree
-
Get the leaf for the given ID or null if no leaf exists with that ID.
- getListFactory() - Method in class io.objectbox.relation.ToMany
- getLoadedCount() - Method in class io.objectbox.query.LazyList
- getLong(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getLong(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getLong(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read a 64-bit long from data.
- 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.
- getMetaId() - Method in class io.objectbox.tree.Leaf
- getNativeStore() - Method in class io.objectbox.BoxStore
-
Gets the reference to the native store.
- getNext() - Method in class io.objectbox.KeyValueCursor
- getObjectBrowserPort() - Method in class io.objectbox.BoxStore
- getObserverDelegate() - Method in interface io.objectbox.reactive.DelegatingObserver
- getObserverDelegate() - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- getObserverDelegate() - Method in class io.objectbox.reactive.WeakDataObserver
- getParentBranchId() - Method in class io.objectbox.tree.Leaf
- getPassword() - Method in class io.objectbox.sync.SyncCredentialsUserPassword
- getPathSeparatorRegex() - Method in class io.objectbox.tree.Tree
-
The path separator regex is used to split a string path into individual path names.
- getPort() - Method in interface io.objectbox.sync.server.SyncServer
-
Returns the port this server listens on, or 0 if the server was not yet started.
- getPort() - Method in class io.objectbox.sync.server.SyncServerImpl
- getPrev() - Method in class io.objectbox.KeyValueCursor
- getPropertyId(String) - Method in class io.objectbox.Box
-
Used by tests
- getPropertyId(String) - Method in class io.objectbox.Cursor
- getReader() - Method in class io.objectbox.Box
- 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(int, int, long, boolean) - Method in class io.objectbox.Cursor
- 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(int, int, long, boolean) - Method in class io.objectbox.Cursor
- getRelationIds(RelationInfo<?, T>, long) - Method in class io.objectbox.Box
-
Like
Box.getRelationEntities(RelationInfo, long), but only returns the IDs of the target entities. - getRelationTargetCursor(Class<TARGET>) - Method in class io.objectbox.Cursor
-
Note: this returns a secondary cursor, which does not survive standalone.
- getRelinker() - Static method in class io.objectbox.BoxStore
- getRemoveCount() - Method in class io.objectbox.relation.ToMany
- getRemovedIds() - Method in class io.objectbox.sync.SyncChange
-
IDs of objects that have been removed.
- getRoot() - Method in class io.objectbox.tree.Tree
-
Gets the root of the data tree.
- getRoot(ReadBuf) - Static method in class io.objectbox.flatbuffers.FlexBuffers
-
Reads a FlexBuffer message in ReadBuf and returns
FlexBuffers.Referenceto the root element. - getRoot(ByteBuffer) - Static method in class io.objectbox.flatbuffers.FlexBuffers
-
Deprecated.
- getRootAsClusterPeerConfig(ByteBuffer) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- getRootAsClusterPeerConfig(ByteBuffer, ClusterPeerConfig) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- getRootAsCredentials(ByteBuffer) - Static method in class io.objectbox.sync.Credentials
- getRootAsCredentials(ByteBuffer, Credentials) - Static method in class io.objectbox.sync.Credentials
- getRootAsFlatStoreOptions(ByteBuffer) - Static method in class io.objectbox.config.FlatStoreOptions
- getRootAsFlatStoreOptions(ByteBuffer, FlatStoreOptions) - Static method in class io.objectbox.config.FlatStoreOptions
- getRootAsHnswParams(ByteBuffer) - Static method in class io.objectbox.model.HnswParams
- getRootAsHnswParams(ByteBuffer, HnswParams) - Static method in class io.objectbox.model.HnswParams
- getRootAsJwtConfig(ByteBuffer) - Static method in class io.objectbox.sync.server.JwtConfig
- getRootAsJwtConfig(ByteBuffer, JwtConfig) - Static method in class io.objectbox.sync.server.JwtConfig
- getRootAsModel(ByteBuffer) - Static method in class io.objectbox.model.Model
- getRootAsModel(ByteBuffer, Model) - Static method in class io.objectbox.model.Model
- getRootAsModelEntity(ByteBuffer) - Static method in class io.objectbox.model.ModelEntity
- getRootAsModelEntity(ByteBuffer, ModelEntity) - Static method in class io.objectbox.model.ModelEntity
- getRootAsModelProperty(ByteBuffer) - Static method in class io.objectbox.model.ModelProperty
- getRootAsModelProperty(ByteBuffer, ModelProperty) - Static method in class io.objectbox.model.ModelProperty
- getRootAsModelRelation(ByteBuffer) - Static method in class io.objectbox.model.ModelRelation
- getRootAsModelRelation(ByteBuffer, ModelRelation) - Static method in class io.objectbox.model.ModelRelation
- getRootAsSyncServerOptions(ByteBuffer) - Static method in class io.objectbox.sync.server.SyncServerOptions
- getRootAsSyncServerOptions(ByteBuffer, SyncServerOptions) - Static method in class io.objectbox.sync.server.SyncServerOptions
- getRootId() - Method in class io.objectbox.tree.Tree
-
The root ID, which the tree was constructed with.
- getRoundtripTimeNanos() - Method in interface io.objectbox.sync.SyncClient
-
Returns the estimated roundtrip time in nanoseconds to the server and back.
- getRoundtripTimeNanos() - Method in class io.objectbox.sync.SyncClientImpl
- getScore() - Method in class io.objectbox.query.IdWithScore
-
Returns the query score for the
id. - getScore() - Method in class io.objectbox.query.ObjectWithScore
-
Returns the query score for the
object. - getServer() - Method in class io.objectbox.sync.SyncHybrid
-
Returns the
SyncServerof this hybrid. - getServerTimeDiffNanos() - Method in interface io.objectbox.sync.SyncClient
-
Returns the estimated difference in nanoseconds between the server time and the local timestamp.
- getServerTimeDiffNanos() - Method in class io.objectbox.sync.SyncClientImpl
- getServerTimeNanos() - Method in interface io.objectbox.sync.SyncClient
-
Estimates the current server timestamp in nanoseconds based on the last known server time.
- getServerTimeNanos() - Method in class io.objectbox.sync.SyncClientImpl
- 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
- getShort(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getShort(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getShort(int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read a short from data.
- getSizePrefix(ByteBuffer) - Static method in class io.objectbox.flatbuffers.ByteBufferUtil
-
Extract the size prefix from a `ByteBuffer`.
- 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
- getStore() - Method in class io.objectbox.sync.SyncHybrid
- getStore() - Method in class io.objectbox.Transaction
- getStore() - Method in class io.objectbox.tree.Tree
- getString() - Method in class io.objectbox.tree.Leaf
- getString(int, int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- getString(int, int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- getString(int, int) - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Read an UTF-8 string from data.
- getString(long) - Method in class io.objectbox.tree.Tree
-
Get data value for the given ID or null if no data leaf exists with that ID.
- getStringArray() - Method in class io.objectbox.tree.Leaf
- getSupportedABIsAndroid() - Static method in class io.objectbox.internal.NativeLibraryLoader
-
Return a string containing a list of ABIs that are supported by the current Android device.
- getSyncClient() - Method in class io.objectbox.BoxStore
-
Returns the
SyncClientassociated with this store. - getSyncState() - Method in class io.objectbox.sync.SyncClientImpl
-
Gets the current state of this sync client.
- getTarget() - Method in class io.objectbox.relation.ToOne
-
Returns the target object or
nullif there is none. - 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
- getTargetIdField() - Method in class io.objectbox.relation.ToOne
- getTokenBytes() - Method in class io.objectbox.sync.SyncCredentialsToken
- getToMany(SOURCE) - Method in interface io.objectbox.internal.ToManyGetter
- getToOne(SOURCE) - Method in interface io.objectbox.internal.ToOneGetter
- getTree() - Method in class io.objectbox.tree.Branch
- getTx() - Method in class io.objectbox.Cursor
- getType() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Return element type
- getType() - Method in class io.objectbox.sync.SyncCredentials
- getTypeId() - Method in class io.objectbox.sync.SyncCredentials
- getUrl() - Method in interface io.objectbox.sync.server.SyncServer
-
Returns the URL this server is listening on, including the bound port (see
SyncServer.getPort()). - getUrl() - Method in class io.objectbox.sync.server.SyncServerImpl
- getUsername() - Method in class io.objectbox.sync.SyncCredentialsUserPassword
- getValueType() - Method in class io.objectbox.tree.Leaf
-
See
PropertyTypefor possible types (not all are used here). - 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() - Method in class io.objectbox.Box
- 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 - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- GoogleAuth - Static variable in class io.objectbox.sync.CredentialsType
-
Google Auth ID token
- greater(byte[]) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- greater(double) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- greater(int) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- greater(long) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- greater(short) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- greater(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greater(Property<T>, double) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greater(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greater(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greater(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greater(String) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property using
StringOrder#CASE_SENSITIVE. - greater(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- greater(Date) - Method in class io.objectbox.Property
-
Creates a "greater than ('>')" condition for this property.
- GREATER - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
- GREATER - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
- GREATER - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- GREATER - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- GREATER_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
- GREATER_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
- GREATER_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- GREATER_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- greaterOrEqual(byte[]) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- greaterOrEqual(double) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- greaterOrEqual(int) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- greaterOrEqual(long) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- greaterOrEqual(short) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- greaterOrEqual(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greaterOrEqual(Property<T>, double) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greaterOrEqual(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greaterOrEqual(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greaterOrEqual(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - greaterOrEqual(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- greaterOrEqual(Date) - Method in class io.objectbox.Property
-
Creates a "greater or equal ('>=')" condition for this property.
- group - Variable in class io.objectbox.internal.ObjectBoxThreadPool.ObjectBoxThreadFactory
- growByteBuffer(ByteBuffer, FlatBufferBuilder.ByteBufferFactory) - Static method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Doubles the size of the backing
ByteBufferand copies the old data towards the end of the new buffer (since we build the buffer backwards). - gt(Object) - Method in class io.objectbox.Property
-
Deprecated.Use
Property.greater(short)instead.
H
- handle - Variable in class io.objectbox.BoxStore
-
Reference to the native store.
- handle - Variable in class io.objectbox.internal.DebugCursor
- handle - Variable in class io.objectbox.query.Query
- handle - Variable in class io.objectbox.query.QueryBuilder
- handle - Variable in class io.objectbox.sync.server.SyncServerImpl
- handle - Variable in class io.objectbox.sync.SyncClientImpl
- handle - Variable in class io.objectbox.tree.Tree
- handleFourBytes(byte, byte, byte, byte, char[], int) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
- handleObserverException(Class) - Method in class io.objectbox.ObjectClassPublisher
- handleOneByte(byte, char[], int) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
- handleThreeBytes(byte, byte, byte, char[], int) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
- handleTwoBytes(byte, byte, char[], int) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
- hasA(QueryFilter<TARGET>) - Method in class io.objectbox.relation.ToMany
-
Returns true if at least one of the target objects matches the given filter.
- hasActiveTransaction() - Method in class io.objectbox.BoxStore
-
Returns if
BoxStore.transactionshas a single transaction thatisActive(). - hasAll(QueryFilter<TARGET>) - Method in class io.objectbox.relation.ToMany
-
Returns true if all of the target objects match the given filter.
- hasFeature(Feature) - Static method in class io.objectbox.BoxStore
- hash(int) - Method in class io.objectbox.model.Model
-
Hash of the model/schema; usually want to check hashes before even creating a model and thus avoiding creating the model altogether.
- HASH - Enum constant in enum class io.objectbox.annotation.IndexType
-
Use a (fast non-cryptographic) hash of the property value to build the index.
- HASH64 - Enum constant in enum class io.objectbox.annotation.IndexType
-
Use a long (fast non-cryptographic) hash of the property value to build the index.
- hashAsByteBuffer() - Method in class io.objectbox.model.Model
- hashCode() - Method in class io.objectbox.flatbuffers.FlexBuffers.Key
- hashCode() - Method in class io.objectbox.reactive.WeakDataObserver
- hashCode() - Method in class io.objectbox.relation.ToOne
- hashInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.Model
- hashLength() - Method in class io.objectbox.model.Model
- hashVector() - Method in class io.objectbox.model.Model
- hashVector(ByteVector) - Method in class io.objectbox.model.Model
- 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.
- HeapByteBufferFactory() - Constructor for class io.objectbox.flatbuffers.FlatBufferBuilder.HeapByteBufferFactory
- highSurrogate(int) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
- historySizeMaxKb - Variable in class io.objectbox.sync.server.SyncServerBuilder
- historySizeMaxKb() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Once the maximum size is reached, old TX logs are deleted to stay below this limit.
- historySizeMaxKb(long) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets the maximum transaction history size.
- historySizeTargetKb - Variable in class io.objectbox.sync.server.SyncServerBuilder
- historySizeTargetKb() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Once the maximum size (historySizeMaxKb) is reached, old TX logs are deleted until this size target is reached (lower than the maximum size).
- historySizeTargetKb(long) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets the target transaction history size.
- HnswDistanceType - Class in io.objectbox.model
-
The distance algorithm used by an HNSW index (vector search).
- HnswDistanceType() - Constructor for class io.objectbox.model.HnswDistanceType
- HnswFlags - Class in io.objectbox.model
-
Flags as a part of the HNSW configuration.
- HnswFlags - Annotation Interface in io.objectbox.annotation
-
Flags as a part of the
HnswIndexconfiguration. - HnswFlags() - Constructor for class io.objectbox.model.HnswFlags
- HnswIndex - Annotation Interface in io.objectbox.annotation
-
Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
- hnswParams() - Method in class io.objectbox.model.ModelProperty
-
For float vectors properties and nearest neighbor search, you can index the property with HNSW.
- hnswParams(long, Long, Long, Integer, Short, Float, Long) - Method in class io.objectbox.ModelBuilder.PropertyBuilder
-
Set parameters for
HnswIndex. - hnswParams(HnswParams) - Method in class io.objectbox.model.ModelProperty
- HnswParams - Class in io.objectbox.model
-
Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
- HnswParams() - Constructor for class io.objectbox.model.HnswParams
- HnswParams.Vector - Class in io.objectbox.model
- hnswParamsOffset - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- hybrid(BoxStoreBuilder, String, SyncCredentials) - Static method in class io.objectbox.sync.Sync
-
Starts building a
SyncHybrid, a client/server hybrid typically used for embedded cluster setups.
I
- id - Variable in enum class io.objectbox.internal.Feature
- id - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- id - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- id - Variable in class io.objectbox.Property
- id - Variable in class io.objectbox.query.IdWithScore
- id - Variable in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- id - Variable in enum class io.objectbox.sync.SyncState
- id - Variable in class io.objectbox.tree.Branch
- id - Variable in class io.objectbox.tree.LeafNode
- id() - Method in class io.objectbox.model.IdUid
- id() - Method in class io.objectbox.model.ModelEntity
- id() - Method in class io.objectbox.model.ModelProperty
- id() - Method in class io.objectbox.model.ModelRelation
- id(int, long) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- id(int, long) - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- id(IdUid) - Method in class io.objectbox.model.ModelEntity
- id(IdUid) - Method in class io.objectbox.model.ModelProperty
- id(IdUid) - Method in class io.objectbox.model.ModelRelation
- Id - Annotation Interface in io.objectbox.annotation
-
Marks the ID property of an
@Entity. - ID - Static variable in class io.objectbox.model.PropertyFlags
-
64 bit long property (internally unsigned) representing the ID of the entity.
- ID_COMPANION - Static variable in class io.objectbox.model.PropertyFlags
-
By defining an ID companion property, a special ID encoding scheme is activated involving this property.
- ID_MONOTONIC_SEQUENCE - Static variable in class io.objectbox.model.PropertyFlags
-
Unused yet: Use a persisted sequence to enforce ID to rise monotonic (no ID reuse)
- ID_SELF_ASSIGNABLE - Static variable in class io.objectbox.model.PropertyFlags
-
Allow IDs to be assigned by the developer
- IdCompanion - Annotation Interface in io.objectbox.annotation
-
Marks a property as a companion to an @Id property.
- idGetter - Variable in class io.objectbox.Box
- IdGetter<T> - Interface in io.objectbox.internal
- IdUid - Class in io.objectbox.model
-
ID tuple: besides the main ID there is also a UID for verification
- IdUid() - Constructor for class io.objectbox.model.IdUid
- IdUid.Vector - Class in io.objectbox.model
- idVerified - Variable in class io.objectbox.Property
- IdWithScore - Class in io.objectbox.query
-
Wraps the ID of a matching object and a score when using
Query.findIdsWithScores(long, long). - IdWithScore(long, double) - Constructor for class io.objectbox.query.IdWithScore
- in(Property<T>, int[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - in(Property<T>, long[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - in(Property<T>, String[], QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - in(Object...) - Method in class io.objectbox.Property
-
Deprecated.Use
Property.oneOf(int[])instead. - in(Collection<?>) - Method in class io.objectbox.Property
-
Deprecated.Use
Property.oneOf(int[])instead. - IN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition.Operation
- IN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition.Operation
- IN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition.Operation
- IN_MEMORY_PREFIX - Static variable in class io.objectbox.BoxStore
-
Prefix supplied with database directory to signal a file-less and in-memory database should be used.
- index - Variable in class io.objectbox.query.LazyList.LazyIterator
- Index - Annotation Interface in io.objectbox.annotation
-
Specifies that the property should be indexed.
- INDEX_HASH - Static variable in class io.objectbox.model.PropertyFlags
-
Index uses a 32 bit hash instead of the value.
- INDEX_HASH64 - Static variable in class io.objectbox.model.PropertyFlags
-
Index uses a 64 bit hash instead of the value.
- INDEX_PARTIAL_SKIP_NULL - Static variable in class io.objectbox.model.PropertyFlags
-
Unused yet
- INDEX_PARTIAL_SKIP_ZERO - Static variable in class io.objectbox.model.PropertyFlags
-
Unused yet in user land.
- INDEXED - Static variable in class io.objectbox.model.PropertyFlags
- indexId - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- indexId() - Method in class io.objectbox.model.ModelProperty
- indexId(int, long) - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- indexId(IdUid) - Method in class io.objectbox.model.ModelProperty
- indexingSearchCount() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
Aka "efConstruction": the number of neighbor searched for while indexing (default: 100).
- indexingSearchCount() - Method in class io.objectbox.model.HnswParams
-
Aka "efConstruction": the number of neighbor searched for while indexing (default: 100).
- indexMaxValueLength - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- indexMaxValueLength(int) - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- 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 ID.
- IndexType - Enum Class in io.objectbox.annotation
-
ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see
IndexType.DEFAULT). - IndexType() - Constructor for enum class io.objectbox.annotation.IndexType
- indexUid - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- indirect(ReadBuf, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- init(ByteBuffer, FlatBufferBuilder.ByteBufferFactory) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Alternative initializer that allows reusing this object on an existing `ByteBuffer`.
- INITIAL_RETRY_BACK_OFF_IN_MS - Static variable in class io.objectbox.query.Query
- initialCommitCount - Variable in class io.objectbox.Transaction
- 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).
- initialDbFileFactory - Variable in class io.objectbox.BoxStoreBuilder
- initialValue() - Method in class io.objectbox.query.QueryThreadLocal
- inMemory - Variable in class io.objectbox.BoxStoreBuilder
-
If non-null, using an in-memory database with this identifier.
- inMemory(String) - Method in class io.objectbox.BoxStoreBuilder
-
Switches to an in-memory database using the given name as its identifier.
- instance - Static variable in class io.objectbox.internal.ReflectionCache
- INSTANCE - Static variable in class io.objectbox.flatbuffers.FlatBufferBuilder.HeapByteBufferFactory
- Int - Static variable in class io.objectbox.model.PropertyType
-
32-bit integer
- int16(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- int32(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- int64(int, long) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- int8(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- IntArrayCondition(Property<T>, PropertyQueryConditionImpl.IntArrayCondition.Operation, int[]) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition
- IntegerFlexMapConverter - Class in io.objectbox.converter
-
A
FlexObjectConverterthat usesIntegeras map keys. - IntegerFlexMapConverter() - Constructor for class io.objectbox.converter.IntegerFlexMapConverter
- IntegerLongMapConverter - Class in io.objectbox.converter
-
Like
IntegerFlexMapConverter, but always restores integer map values asLong. - IntegerLongMapConverter() - Constructor for class io.objectbox.converter.IntegerLongMapConverter
- integerValue - Variable in class io.objectbox.tree.LeafNode
- Internal - Annotation Interface in io.objectbox.annotation.apihint
-
APIs annotated with @Internal must NOT be used.
- InternalAccess - Class in io.objectbox
-
Exposes internal APIs to tests and code in other packages.
- InternalAccess - Class in io.objectbox.query
-
Exposes internal APIs to tests and code in other packages.
- InternalAccess() - Constructor for class io.objectbox.InternalAccess
- InternalAccess() - Constructor for class io.objectbox.query.InternalAccess
- internalAnd(long, long) - Method in class io.objectbox.query.QueryBuilder
- 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
- internalGetLastCondition() - Method in class io.objectbox.query.QueryBuilder
- internalGetRelationEntities(int, int, long, boolean) - Method in class io.objectbox.Box
- internalGetRelationIds(int, int, long, boolean) - Method in class io.objectbox.Box
- internalHandle() - Method in class io.objectbox.Cursor
- internalHandle() - Method in class io.objectbox.Transaction
- internalListener - Variable in class io.objectbox.sync.SyncClientImpl
- internalOr(long, long) - Method in class io.objectbox.query.QueryBuilder
- 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
- InternalSyncClientListener() - Constructor for class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
- internalThreadPool() - Method in class io.objectbox.BoxStore
- intToUnsignedLong(int) - Static method in class io.objectbox.flatbuffers.FlexBuffers.Unsigned
- IntVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of signed or unsigned 32-bit values.
- IntVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Int values (32-bit integers)
- IntVector() - Constructor for class io.objectbox.flatbuffers.IntVector
- Invalid - Static variable in class io.objectbox.sync.CredentialsType
-
Used to indicate an uninitialized variable.
- 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@IdProperty, to create an@Indexor a@TransientProperty. - io.objectbox.annotation.apihint - package io.objectbox.annotation.apihint
-
Annotations to mark APIs as for example
@Internalor@Experimental. - io.objectbox.config - package io.objectbox.config
- io.objectbox.converter - package io.objectbox.converter
-
For use with
@Convert:PropertyConverterto convert custom Property types. - io.objectbox.exception - package io.objectbox.exception
-
Various exceptions thrown by ObjectBox.
- io.objectbox.flatbuffers - package io.objectbox.flatbuffers
- io.objectbox.ideasonly - package io.objectbox.ideasonly
- io.objectbox.internal - package io.objectbox.internal
- io.objectbox.model - package io.objectbox.model
- io.objectbox.query - package io.objectbox.query
- io.objectbox.reactive - package io.objectbox.reactive
-
Classes to
configureaDataSubscriptionfor observing Box or Query changes. - io.objectbox.relation - package io.objectbox.relation
- io.objectbox.rx3 - package io.objectbox.rx3
- io.objectbox.sync - package io.objectbox.sync
-
ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g.
- io.objectbox.sync.internal - package io.objectbox.sync.internal
- io.objectbox.sync.listener - package io.objectbox.sync.listener
- io.objectbox.sync.server - package io.objectbox.sync.server
- io.objectbox.tree - package io.objectbox.tree
-
APIs to interact with tree structures stored in ObjectBox.
- IS_NULL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.NullCondition.Operation
- isActive() - Method in class io.objectbox.Transaction
- isAvailable() - Static method in class io.objectbox.sync.Sync
-
Returns true if the included native (JNI) ObjectBox library supports Sync.
- isBacklink() - Method in class io.objectbox.relation.RelationInfo
- isBlob() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is a blob
- isBoolean() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element is boolean type
- isCanceled() - Method in interface io.objectbox.reactive.DataSubscription
-
Current cancellation state of the subscription.
- isCanceled() - Method in class io.objectbox.reactive.DataSubscriptionImpl
- isCanceled() - Method in class io.objectbox.reactive.DataSubscriptionList
-
Returns true if
DataSubscriptionList.cancel()was called without any subsequent calls toDataSubscriptionList.add(DataSubscription). - isChanged(T) - Method in class io.objectbox.Box
- isClosed() - Method in class io.objectbox.BoxStore
-
If this was
closed. - isClosed() - Method in class io.objectbox.Cursor
- isClosed() - Method in class io.objectbox.Transaction
- isDatabaseOpen(File) - Static method in class io.objectbox.BoxStore
-
Using a directory, as configured with
BoxStoreBuilder.directory(File), checks if the associated database files are in use by a BoxStore instance. - isDatabaseOpen(File, String) - Static method in class io.objectbox.BoxStore
-
Using an optional base directory, as configured with
BoxStoreBuilder.baseDirectory(File), and an optional database name, as configured withBoxStoreBuilder.name(String), checks if the associated database files are in use by a BoxStore instance. - isDatabaseOpen(Object, String) - Static method in class io.objectbox.BoxStore
-
Using an Android Context and an optional database name, as configured with
BoxStoreBuilder.name(String), checks if the associated database files are in use by a BoxStore instance. - isDebugRelations() - Method in class io.objectbox.BoxStore
- isDouble() - Method in class io.objectbox.tree.Leaf
- isEmpty() - Method in class io.objectbox.Box
-
Returns true if no objects are in this box.
- isEmpty() - Method in class io.objectbox.flatbuffers.FlexBuffers.Vector
-
Checks if the vector is empty
- isEmpty() - Method in class io.objectbox.query.LazyList
- isEmpty() - Method in class io.objectbox.relation.ToMany
- isEmptyVector() - Method in class io.objectbox.flatbuffers.FlexBuffers.TypedVector
-
Returns whether the vector is empty
- isFieldPresent(Table, int) - Static method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Helper function to test if a field is present in the table
- isFileOpen(String) - Static method in class io.objectbox.BoxStore
-
Also retries up to 500ms to improve GC race condition situation.
- isFileOpenSync(String, boolean) - Static method in class io.objectbox.BoxStore
- isFloat() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is float
- isHybridAvailable() - Static method in class io.objectbox.sync.Sync
-
Returns true if the included native (JNI) ObjectBox library supports Sync hybrids (server invalid input: '&' client).
- isId - Variable in class io.objectbox.Property
- isIdVerified() - Method in class io.objectbox.Property
- isInt() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is signed integer
- isInt() - Method in class io.objectbox.tree.Leaf
- isIntOrUInt() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is signed or unsigned integers
- isKey() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is key
- 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
- isMap() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is a map
- isNativeStoreClosed() - Method in class io.objectbox.BoxStore
-
For internal use only.
- isNotNull() - Method in class io.objectbox.Property
-
Deprecated.Use
Property.notNull()instead. - isNotTrailingByte(byte) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
-
Returns whether the byte is not a valid continuation of the form '10XXXXXX'.
- isNull() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element is null type
- 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
-
Note: New code should use the
new query API. - isNumeric() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is numeric (signed/unsigned integers and floats)
- isObjectBrowserAvailable() - Static method in class io.objectbox.BoxStore
- isObjectBrowserRunning() - Method in class io.objectbox.BoxStore
- isObsolete() - Method in class io.objectbox.Cursor
- isObsolete() - Method in class io.objectbox.Transaction
-
Indicates if data returned from this transaction may be obsolete (another write TX was committed after this transaction was started).
- isOneByte(byte) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
-
Returns whether this is a single-byte codepoint (i.e., ASCII) with the form '0XXXXXXX'.
- isReadOnly() - Method in class io.objectbox.BoxStore
-
Whether the store was created using read-only mode.
- isReadOnly() - Method in class io.objectbox.Transaction
- isRecycled() - Method in class io.objectbox.Transaction
- 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
- isServerAvailable() - Static method in class io.objectbox.sync.Sync
-
Returns true if the included native (JNI) ObjectBox library supports Sync server.
- isStarted() - Method in interface io.objectbox.sync.SyncClient
-
Flag indicating if the sync client was started.
- isStarted() - Method in class io.objectbox.sync.SyncClientImpl
- isString() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is string
- isString() - Method in class io.objectbox.tree.Leaf
- isStringArray() - Method in class io.objectbox.tree.Leaf
- isSubQuery - Variable in class io.objectbox.query.QueryBuilder
- isSyncAvailable() - Static method in class io.objectbox.BoxStore
- isSyncServerAvailable() - Static method in class io.objectbox.BoxStore
- isThreeBytes(byte) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
-
Returns whether this is a three-byte codepoint with the form '110XXXXX'.
- isTwoBytes(byte) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
-
Returns whether this is a two-byte codepoint with the form '10XXXXXX'.
- isTypedVector() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is typed vector
- isTypedVector(int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
-
Checks where a type is a typed vector
- isTypedVectorElementType(int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- isTypeInline(int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
-
Check whether you can access type directly (no indirection) or not.
- isUInt() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is signed integer
- isVector() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Checks whether the element type is vector
- isVirtual - Variable in class io.objectbox.Property
- iterator() - Method in class io.objectbox.query.LazyList
- iterator() - Method in class io.objectbox.relation.ToMany
- iValue - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
J
- JNI_VERSION - Static variable in class io.objectbox.BoxStore
-
ReLinker uses this as a suffix for the extracted shared library file.
- JniTest - Class in io.objectbox.internal
- JniTest() - Constructor for class io.objectbox.internal.JniTest
- JWT_ACCESS_TOKEN - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- JWT_CUSTOM_TOKEN - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- JWT_ID_TOKEN - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- JWT_REFRESH_TOKEN - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- JwtAccess - Static variable in class io.objectbox.sync.CredentialsType
-
JSON Web Token (JWT): an access token that is used to access resources.
- jwtAccessToken(String) - Static method in class io.objectbox.sync.SyncCredentials
-
JSON Web Token (JWT): an access token that is used to access resources.
- jwtConfig() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Optional configuration for JWT (JSON Web Token) authentication.
- jwtConfig(JwtConfig) - Method in class io.objectbox.sync.server.SyncServerOptions
- JwtConfig - Class in io.objectbox.sync.server
- JwtConfig() - Constructor for class io.objectbox.sync.server.JwtConfig
- JwtConfig.Vector - Class in io.objectbox.sync.server
- jwtConfigClaimAud(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Set the JWT claim "aud" (audience) used to verify JWT tokens.
- jwtConfigClaimIss(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Set the JWT claim "iss" (issuer) used to verify JWT tokens.
- jwtConfigPublicKey(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Set the public key used to verify JWT tokens.
- jwtConfigPublicKeyUrl(String) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Set the JWKS (Json Web Key Sets) URL to fetch the current public key used to verify JWT tokens.
- JwtCustom - Static variable in class io.objectbox.sync.CredentialsType
-
JSON Web Token (JWT): a token that is neither an ID, access, nor refresh token.
- jwtCustomToken(String) - Static method in class io.objectbox.sync.SyncCredentials
-
JSON Web Token (JWT): a token that is neither an ID, access, nor refresh token.
- JwtId - Static variable in class io.objectbox.sync.CredentialsType
-
JSON Web Token (JWT): an ID token that typically provides identity information about the authenticated user.
- jwtIdToken(String) - Static method in class io.objectbox.sync.SyncCredentials
-
JSON Web Token (JWT): an ID token that typically provides identity information about the authenticated user.
- JwtRefresh - Static variable in class io.objectbox.sync.CredentialsType
-
JSON Web Token (JWT): a refresh token that is used to obtain a new access token.
- jwtRefreshToken(String) - Static method in class io.objectbox.sync.SyncCredentials
-
JSON Web Token (JWT): a refresh token that is used to obtain a new access token.
K
- keep(T) - Method in interface io.objectbox.query.QueryFilter
- key - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- Key(ReadBuf, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Key
- keyComparator - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- keyPool - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- keys() - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
-
Get a vector or keys in the map
- keysCompare(Integer, Integer, ByteBuffer) - Method in class io.objectbox.flatbuffers.Table
-
Compare two tables by the key.
- KeyValueCursor - Class in io.objectbox
- KeyValueCursor(long) - Constructor for class io.objectbox.KeyValueCursor
- KeyVector(FlexBuffers.TypedVector) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.KeyVector
L
- lastCondition - Variable in class io.objectbox.query.QueryBuilder
-
Holds on to last condition.
- lastEntityId - Variable in class io.objectbox.ModelBuilder
- lastEntityId() - Method in class io.objectbox.model.Model
- lastEntityId(int, long) - Method in class io.objectbox.ModelBuilder
- lastEntityId(IdUid) - Method in class io.objectbox.model.Model
- lastEntityUid - Variable in class io.objectbox.ModelBuilder
- lastIndexId - Variable in class io.objectbox.ModelBuilder
- lastIndexId() - Method in class io.objectbox.model.Model
- lastIndexId(int, long) - Method in class io.objectbox.ModelBuilder
- lastIndexId(IdUid) - Method in class io.objectbox.model.Model
- lastIndexOf(Object) - Method in class io.objectbox.query.LazyList
- lastIndexOf(Object) - Method in class io.objectbox.relation.ToMany
- lastIndexUid - Variable in class io.objectbox.ModelBuilder
- lastInput - Variable in class io.objectbox.flatbuffers.Utf8Old.Cache
- lastLoginCode - Variable in class io.objectbox.sync.SyncClientImpl
- lastOutput - Variable in class io.objectbox.flatbuffers.Utf8Old.Cache
- lastPropertyCondition - Variable in class io.objectbox.query.QueryBuilder
-
Holds on to last property condition to use with
QueryBuilder.parameterAlias(String) - lastPropertyId - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- lastPropertyId() - Method in class io.objectbox.model.ModelEntity
- lastPropertyId(int, long) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- lastPropertyId(IdUid) - Method in class io.objectbox.model.ModelEntity
- lastPropertyUid - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- lastRelationId - Variable in class io.objectbox.ModelBuilder
- lastRelationId() - Method in class io.objectbox.model.Model
- lastRelationId(int, long) - Method in class io.objectbox.ModelBuilder
- lastRelationId(IdUid) - Method in class io.objectbox.model.Model
- lastRelationUid - Variable in class io.objectbox.ModelBuilder
- lastSequenceId() - Method in class io.objectbox.model.Model
- lastSequenceId(IdUid) - Method in class io.objectbox.model.Model
- LazyIterator(int) - Constructor for class io.objectbox.query.LazyList.LazyIterator
- LazyList<E> - Class in io.objectbox.query
-
A thread-safe, unmodifiable
Listthat gets Objects from their Box not until they are accessed. - LazyList(Box<E>, long[], boolean) - Constructor for class io.objectbox.query.LazyList
- LazyList.LazyIterator - Class in io.objectbox.query
- leaf(String) - Method in class io.objectbox.tree.Branch
-
Get the leaf following the given path of children from this branch.
- leaf(String[]) - Method in class io.objectbox.tree.Branch
-
Get the leaf following the given path of children from this branch.
- Leaf - Class in io.objectbox.tree
- Leaf(LeafNode) - Constructor for class io.objectbox.tree.Leaf
- leafChild(String) - Method in class io.objectbox.tree.Branch
-
Get the child leaf directly attached to this branch with the given name.
- LeafNode - Class in io.objectbox.tree
-
(Potentially internal) value object created in our JNI layer to represent a leaf with all stored data.
- LeafNode(long, long, long, long, double, Object, short) - Constructor for class io.objectbox.tree.LeafNode
-
All-args constructor used by JNI (don't change, it's actually used).
- leftCondition - Variable in class io.objectbox.query.LogicQueryCondition
- leftValue - Variable in class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition
- leftValue - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition
- leftValue - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition
- length - Variable in class io.objectbox.flatbuffers.BaseVector
-
Used to hold the vector size.
- length() - Method in class io.objectbox.flatbuffers.BaseVector
-
Get the length of a vector.
- less(byte[]) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- less(double) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- less(int) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- less(long) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- less(short) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- less(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - less(Property<T>, double) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - less(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - less(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - less(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - less(String) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property using
StringOrder#CASE_SENSITIVE. - less(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- less(Date) - Method in class io.objectbox.Property
-
Creates a "less than ('<')" condition for this property.
- LESS - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
- LESS - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
- LESS - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- LESS - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- LESS_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
- LESS_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
- LESS_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- LESS_OR_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- lessOrEqual(byte[]) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- lessOrEqual(double) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- lessOrEqual(int) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- lessOrEqual(long) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- lessOrEqual(short) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- lessOrEqual(Property<T>, byte[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - lessOrEqual(Property<T>, double) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - lessOrEqual(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - lessOrEqual(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - lessOrEqual(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - lessOrEqual(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- lessOrEqual(Date) - Method in class io.objectbox.Property
-
Creates a "less or equal ('<=')" condition for this property.
- limit - Variable in class io.objectbox.query.EagerRelation
- limit() - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- limit() - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- limit() - Method in interface io.objectbox.flatbuffers.ReadBuf
-
Defines the size of the message in the buffer.
- limit() - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Defines the size of the message in the buffer.
- link(RelationInfo<?, ?>, EntityInfo<?>, EntityInfo<?>, boolean) - Method in class io.objectbox.query.QueryBuilder
- 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 - Variable in class io.objectbox.sync.SyncBuilder
- listener(SyncListener) - Method in class io.objectbox.sync.SyncBuilder
-
Sets a listener to observe all Sync events like login or sync completion.
- listFactory - Variable in class io.objectbox.relation.ToMany
- 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(). - loadedCount - Variable in class io.objectbox.query.LazyList
- loadLibraryAndroid() - Static method in class io.objectbox.internal.NativeLibraryLoader
- 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.config.DebugFlags
- LOG_ASYNC_QUEUE - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_CACHE_ALL - Static variable in class io.objectbox.config.DebugFlags
- LOG_CACHE_ALL - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_CACHE_HITS - Static variable in class io.objectbox.config.DebugFlags
- LOG_CACHE_HITS - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_EXCEPTION_STACK_TRACE - Static variable in class io.objectbox.config.DebugFlags
-
For a limited number of error conditions, this will try to print stack traces.
- LOG_EXCEPTION_STACK_TRACE - Static variable in class io.objectbox.DebugFlags
-
Deprecated.For a limited number of error conditions, this will try to print stack traces.
- LOG_QUERIES - Static variable in class io.objectbox.config.DebugFlags
- LOG_QUERIES - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_QUERY_PARAMETERS - Static variable in class io.objectbox.config.DebugFlags
- LOG_QUERY_PARAMETERS - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_READ_NOT_CLOSED - Static variable in class io.objectbox.Cursor
- LOG_TRANSACTIONS_READ - Static variable in class io.objectbox.config.DebugFlags
- LOG_TRANSACTIONS_READ - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_TRANSACTIONS_WRITE - Static variable in class io.objectbox.config.DebugFlags
- LOG_TRANSACTIONS_WRITE - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOG_TREE - Static variable in class io.objectbox.config.DebugFlags
- LOG_TREE - Static variable in class io.objectbox.DebugFlags
-
Deprecated.
- LOGGED_IN - Enum constant in enum class io.objectbox.sync.SyncState
- LogicQueryCondition<T> - Class in io.objectbox.query
-
Logic based query conditions, currently
LogicQueryCondition.AndConditionandLogicQueryCondition.OrCondition. - LogicQueryCondition(QueryConditionImpl<T>, QueryConditionImpl<T>) - Constructor for class io.objectbox.query.LogicQueryCondition
- LogicQueryCondition.AndCondition<T> - Class in io.objectbox.query
-
Combines the left condition using AND with the right condition.
- LogicQueryCondition.OrCondition<T> - Class in io.objectbox.query
-
Combines the left condition using OR with the right condition.
- loginListener - Variable in class io.objectbox.sync.SyncBuilder
- loginListener - Variable in class io.objectbox.sync.SyncClientImpl
- loginListener(SyncLoginListener) - Method in class io.objectbox.sync.SyncBuilder
-
Sets a listener to only observe Sync login events.
- LogStartStopDisabled - Static variable in class io.objectbox.sync.server.SyncServerFlags
-
By default, the Sync Server logs messages when it starts and stops; this flag disables it.
- Long - Static variable in class io.objectbox.model.PropertyType
-
64-bit integer
- LongArrayCondition(Property<T>, PropertyQueryConditionImpl.LongArrayCondition.Operation, long[]) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition
- LongArrayCondition(Property<T>, PropertyQueryConditionImpl.LongArrayCondition.Operation, Date[]) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition
- LongCondition(Property<T>, PropertyQueryConditionImpl.LongCondition.Operation, boolean) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongCondition
- LongCondition(Property<T>, PropertyQueryConditionImpl.LongCondition.Operation, long) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongCondition
- LongCondition(Property<T>, PropertyQueryConditionImpl.LongCondition.Operation, Date) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongCondition
- LongFlexMapConverter - Class in io.objectbox.converter
-
A
FlexObjectConverterthat usesLongas map keys. - LongFlexMapConverter() - Constructor for class io.objectbox.converter.LongFlexMapConverter
- LongLongCondition(Property<T>, PropertyQueryConditionImpl.LongLongCondition.Operation, long, long) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition
- LongLongCondition(Property<T>, PropertyQueryConditionImpl.LongLongCondition.Operation, Date, Date) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition
- LongLongMapConverter - Class in io.objectbox.converter
-
Like
LongFlexMapConverter, but always restores integer map values asLong. - LongLongMapConverter() - Constructor for class io.objectbox.converter.LongLongMapConverter
- LongVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of long values.
- LongVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Long values (64-bit integers)
- LongVector() - Constructor for class io.objectbox.flatbuffers.LongVector
- lookupKeyUsingIndex(int, String) - Method in class io.objectbox.Cursor
-
Deprecated.TODO only used in tests, remove in the future
- lowSurrogate(int) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
- lt(Object) - Method in class io.objectbox.Property
-
Deprecated.Use
Property.less(short)instead.
M
- MANUAL - Enum constant in enum class io.objectbox.sync.SyncBuilder.RequestUpdatesMode
-
Once logged in, does not request any sync updates automatically.
- Map(ReadBuf, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Map
- max() - Method in class io.objectbox.query.PropertyQuery
-
Finds the maximum value for the given property over all Objects matching the query.
- MAX_BUFFER_SIZE - Static variable in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Maximum size of buffer to allocate.
- maxDataSizeInKbyte() - Method in class io.objectbox.config.FlatStoreOptions
-
Data size tracking is more involved than DB size tracking, e.g.
- maxDataSizeInKByte - Variable in class io.objectbox.BoxStoreBuilder
- maxDataSizeInKByte(long) - Method in class io.objectbox.BoxStoreBuilder
-
Sets the maximum size the data stored in the database can grow to.
- maxDbSizeInKbyte() - Method in class io.objectbox.config.FlatStoreOptions
-
This maximum size setting is meant to prevent your database from growing to unexpected sizes, e.g.
- maxDouble() - Method in class io.objectbox.query.PropertyQuery
-
Finds the maximum value for the given property over all Objects matching the query.
- maxIndexValueLength() - Method in class io.objectbox.model.ModelProperty
-
For value-based indexes, this defines the maximum length of the value stored for indexing
- maxReaders - Variable in class io.objectbox.BoxStoreBuilder
- maxReaders() - Method in class io.objectbox.config.FlatStoreOptions
-
The maximum number of readers (related to read transactions).
- maxReaders(int) - Method in class io.objectbox.BoxStoreBuilder
-
Sets the maximum number of concurrent readers.
- maxResultCount - Variable in class io.objectbox.query.PropertyQueryConditionImpl.NearestNeighborCondition
- maxSizeInKByte - Variable in class io.objectbox.BoxStoreBuilder
-
Defaults to
BoxStoreBuilder.DEFAULT_MAX_DB_SIZE_KBYTE. - maxSizeInKByte(long) - Method in class io.objectbox.BoxStoreBuilder
-
Sets the maximum size the database file can grow to.
- metaId - Variable in class io.objectbox.tree.LeafNode
- min() - Method in class io.objectbox.query.PropertyQuery
-
Finds the minimum value for the given property over all Objects matching the query.
- minalign - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- minBitWidth - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- minDouble() - Method in class io.objectbox.query.PropertyQuery
-
Finds the minimum value for the given property over all objects matching the query.
- model - Variable in class io.objectbox.BoxStoreBuilder
- Model - Class in io.objectbox.model
-
A model describes all entities and other meta data.
- Model() - Constructor for class io.objectbox.model.Model
- MODEL_VERSION - Static variable in class io.objectbox.ModelBuilder
- Model.Vector - Class in io.objectbox.model
- ModelBuilder - Class in io.objectbox
- ModelBuilder() - Constructor for class io.objectbox.ModelBuilder
- ModelBuilder.EntityBuilder - Class in io.objectbox
- ModelBuilder.PropertyBuilder - Class in io.objectbox
- modelBytes(int) - Method in class io.objectbox.config.FlatStoreOptions
-
Provide a data model, e.g.
- modelBytesAsByteBuffer() - Method in class io.objectbox.config.FlatStoreOptions
- modelBytesInByteBuffer(ByteBuffer) - Method in class io.objectbox.config.FlatStoreOptions
- modelBytesLength() - Method in class io.objectbox.config.FlatStoreOptions
- modelBytesVector() - Method in class io.objectbox.config.FlatStoreOptions
- modelBytesVector(ByteVector) - Method in class io.objectbox.config.FlatStoreOptions
- ModelEntity - Class in io.objectbox.model
- ModelEntity() - Constructor for class io.objectbox.model.ModelEntity
- ModelEntity.Vector - Class in io.objectbox.model
- ModelModifier - Class in io.objectbox.ideasonly
- ModelModifier() - Constructor for class io.objectbox.ideasonly.ModelModifier
- ModelModifier.EntityModifier - Class in io.objectbox.ideasonly
- ModelModifier.PropertyModifier - Class in io.objectbox.ideasonly
- ModelProperty - Class in io.objectbox.model
- ModelProperty() - Constructor for class io.objectbox.model.ModelProperty
- ModelProperty.Vector - Class in io.objectbox.model
- ModelRelation - Class in io.objectbox.model
- ModelRelation() - Constructor for class io.objectbox.model.ModelRelation
- ModelRelation.Vector - Class in io.objectbox.model
- modelUpdate - Variable in class io.objectbox.BoxStoreBuilder
- modelUpdate(ModelUpdate) - Method in class io.objectbox.BoxStoreBuilder
- ModelUpdate - Interface in io.objectbox.ideasonly
- modelVersion() - Method in class io.objectbox.model.Model
-
(Meta) version of the model, which is verified by model sync (e.g.
- modifyRelations(int, long, long[], boolean) - Method in class io.objectbox.Cursor
- modifyRelationsSingle(int, long, long, boolean) - Method in class io.objectbox.Cursor
N
- name - Variable in class io.objectbox.BoxStoreBuilder
-
Ignored by BoxStore
- name - Variable in class io.objectbox.ideasonly.ModelModifier.EntityModifier
- name - Variable in class io.objectbox.ideasonly.ModelModifier.PropertyModifier
- name - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- name - Variable in class io.objectbox.Property
- name() - Method in class io.objectbox.model.Model
-
currently always "default"
- name() - Method in class io.objectbox.model.ModelEntity
- name() - Method in class io.objectbox.model.ModelProperty
- name() - Method in class io.objectbox.model.ModelRelation
- name(int) - Static method in class io.objectbox.config.ValidateOnOpenModeKv
- name(int) - Static method in class io.objectbox.config.ValidateOnOpenModePages
- name(int) - Static method in class io.objectbox.model.HnswDistanceType
- name(int) - Static method in class io.objectbox.model.PropertyType
- name(int) - Static method in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.
- name(String) - Method in class io.objectbox.BoxStoreBuilder
-
Name of the database, which will be used as a directory for database files.
- nameAsByteBuffer() - Method in class io.objectbox.model.Model
- nameAsByteBuffer() - Method in class io.objectbox.model.ModelEntity
- nameAsByteBuffer() - Method in class io.objectbox.model.ModelProperty
- nameAsByteBuffer() - Method in class io.objectbox.model.ModelRelation
- nameInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.Model
- nameInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelEntity
- nameInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelProperty
- nameInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelRelation
- NameInDb - Annotation Interface in io.objectbox.annotation
-
Allows to specify a simple name mapping for entities and properties.
- namePrefix - Variable in class io.objectbox.internal.ObjectBoxThreadPool.ObjectBoxThreadFactory
- names - Static variable in class io.objectbox.config.ValidateOnOpenModeKv
- names - Static variable in class io.objectbox.config.ValidateOnOpenModePages
- names - Static variable in class io.objectbox.model.HnswDistanceType
- names - Static variable in class io.objectbox.model.PropertyType
- names - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.
- nameSecondary() - Method in class io.objectbox.model.ModelEntity
-
Secondary name ignored by core; e.g.
- nameSecondary() - Method in class io.objectbox.model.ModelProperty
-
Secondary name ignored by core; e.g.
- nameSecondaryAsByteBuffer() - Method in class io.objectbox.model.ModelEntity
- nameSecondaryAsByteBuffer() - Method in class io.objectbox.model.ModelProperty
- nameSecondaryInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelEntity
- nameSecondaryInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelProperty
- nativeAbort(long) - Method in class io.objectbox.Transaction
- nativeAddLoginCredentials(long, long, byte[], boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeAddLoginCredentialsUserPassword(long, long, String, String, boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeAvg(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeAvgLong(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeBeginReadTx(long) - Static method in class io.objectbox.BoxStore
- nativeBeginTx(long) - Static method in class io.objectbox.BoxStore
- nativeBetween(long, int, double, double) - Method in class io.objectbox.query.QueryBuilder
- nativeBetween(long, int, long, long) - Method in class io.objectbox.query.QueryBuilder
- nativeBuild(long) - Method in class io.objectbox.query.QueryBuilder
- nativeCancelCurrentException() - Static method in class io.objectbox.exception.DbExceptionListenerJni
- nativeCancelUpdates(long) - Method in class io.objectbox.sync.SyncClientImpl
-
(Optional) Pause sync updates.
- nativeCleanStaleReadTransactions(long) - Static method in class io.objectbox.BoxStore
- nativeClearTransaction(long) - Method in class io.objectbox.tree.Tree
- nativeClone(long) - Method in class io.objectbox.query.Query
-
Clones the native query, incl.
- nativeCombine(long, long, long, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeCommit(long) - Method in class io.objectbox.Transaction
- nativeContains(long, int, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeContainsElement(long, int, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeContainsKeyValue(long, int, String, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeCount(long, long) - Method in class io.objectbox.Cursor
- nativeCount(long, long) - Method in class io.objectbox.query.Query
- nativeCount(long, long, int, boolean) - Method in class io.objectbox.query.PropertyQuery
- nativeCreate(long) - Static method in class io.objectbox.internal.DebugCursor
- nativeCreate(long, long) - Static method in class io.objectbox.tree.Tree
-
Create a (Data)Tree instance for the given meta-branch root, or find a singular root if 0 is given.
- nativeCreate(long, String) - Method in class io.objectbox.query.QueryBuilder
- nativeCreate(long, String, String[]) - Static method in class io.objectbox.sync.SyncClientImpl
-
Creates a native sync client for the given store handle ready to connect to the server at the given URI.
- nativeCreateCursor(long, String, Class<?>) - Method in class io.objectbox.Transaction
- nativeCreateFromFlatOptions(long, byte[]) - Static method in class io.objectbox.sync.server.SyncServerImpl
-
Creates a native Sync server instance with FlatBuffer
SyncServerOptionsflatOptionsByteArray. - nativeCreateKeyValueCursor(long) - Method in class io.objectbox.Transaction
- nativeCreateWithFlatOptions(byte[], byte[]) - Static method in class io.objectbox.BoxStore
-
Creates a native BoxStore instance with FlatBuffer
FlatStoreOptionsoptionsand aModelBuildermodel. - nativeCreateWithUid(long, String) - Static method in class io.objectbox.tree.Tree
-
Not usable yet; TX is not aligned
- nativeDbSize(long) - Method in class io.objectbox.BoxStore
- nativeDbSizeOnDisk(long) - Method in class io.objectbox.BoxStore
- nativeDelete(long) - Static method in class io.objectbox.BoxStore
- nativeDelete(long) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeDelete(long) - Method in class io.objectbox.sync.SyncClientImpl
- nativeDelete(long) - Static method in class io.objectbox.tree.Tree
- nativeDeleteAll(long) - Method in class io.objectbox.Cursor
- nativeDeleteEntity(long, long) - Static method in class io.objectbox.Cursor
- nativeDescribeParameters(long) - Method in class io.objectbox.query.Query
- nativeDestroy(long) - Method in class io.objectbox.Cursor
- nativeDestroy(long) - Static method in class io.objectbox.internal.DebugCursor
- nativeDestroy(long) - Static method in class io.objectbox.KeyValueCursor
- nativeDestroy(long) - Method in class io.objectbox.query.Query
- nativeDestroy(long) - Method in class io.objectbox.query.QueryBuilder
- nativeDestroy(long) - Method in class io.objectbox.Transaction
- nativeDiagnose(long) - Static method in class io.objectbox.BoxStore
- nativeDropAllData(long) - Static method in class io.objectbox.BoxStore
- nativeEndsWith(long, int, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeEqual(long, int, byte[]) - Method in class io.objectbox.query.QueryBuilder
- nativeEqual(long, int, long) - Method in class io.objectbox.query.QueryBuilder
- nativeEqual(long, int, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeFind(long, long, long, long) - Method in class io.objectbox.query.Query
- nativeFindBytes(long, long, int, boolean, boolean, byte) - Method in class io.objectbox.query.PropertyQuery
- nativeFindChars(long, long, int, boolean, boolean, char) - Method in class io.objectbox.query.PropertyQuery
- nativeFindDoubles(long, long, int, boolean, boolean, double) - Method in class io.objectbox.query.PropertyQuery
- nativeFindFirst(long, long) - Method in class io.objectbox.query.Query
- nativeFindFirst(Query<T>, long) - Static method in class io.objectbox.query.InternalAccess
- nativeFindFirstId(long, long) - Method in class io.objectbox.query.Query
- nativeFindFloats(long, long, int, boolean, boolean, float) - Method in class io.objectbox.query.PropertyQuery
- nativeFindIds(long, long, long, long) - Method in class io.objectbox.query.Query
- nativeFindIdsWithScores(long, long, long, long) - Method in class io.objectbox.query.Query
- nativeFindInts(long, long, int, boolean, boolean, int) - Method in class io.objectbox.query.PropertyQuery
- nativeFindLongs(long, long, int, boolean, boolean, long) - Method in class io.objectbox.query.PropertyQuery
- nativeFindNumber(long, long, int, boolean, boolean, boolean, long, float, double) - Method in class io.objectbox.query.PropertyQuery
- nativeFindShorts(long, long, int, boolean, boolean, short) - Method in class io.objectbox.query.PropertyQuery
- nativeFindString(long, long, int, boolean, boolean, boolean, boolean, String) - Method in class io.objectbox.query.PropertyQuery
- nativeFindStrings(long, long, int, boolean, boolean, boolean, String) - Method in class io.objectbox.query.PropertyQuery
- nativeFindUnique(long, long) - Method in class io.objectbox.query.Query
- nativeFindUniqueId(long, long) - Method in class io.objectbox.query.Query
- nativeFindWithScores(long, long, long, long) - Method in class io.objectbox.query.Query
- nativeFirstEntity(long) - Static method in class io.objectbox.Cursor
- nativeGet(long, byte[]) - Static method in class io.objectbox.internal.DebugCursor
- nativeGetAllEntities(long) - Method in class io.objectbox.Cursor
- nativeGetBacklinkEntities(long, int, int, long) - Method in class io.objectbox.Cursor
- nativeGetBacklinkIds(long, int, int, long) - Method in class io.objectbox.Cursor
- nativeGetBranchId(long, long, String[]) - Method in class io.objectbox.tree.Branch
-
Get a data branch ID matching the path, starting at the given data
branchId. - nativeGetCurrent(long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetCursorFor(long, int) - Method in class io.objectbox.Cursor
- nativeGetEntity(long, long) - Static method in class io.objectbox.Cursor
- nativeGetEqualOrGreater(long, long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetFirst(long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetKey(long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetKey(long, long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetLast(long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetLeaf(long, long, String[]) - Method in class io.objectbox.tree.Branch
-
Get a data leaf matching the path, starting at the given data
branchId. - nativeGetLeafById(long, long) - Method in class io.objectbox.tree.Tree
- nativeGetLongKey(long, long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetNext(long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetPort(long) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeGetPrev(long) - Static method in class io.objectbox.KeyValueCursor
- nativeGetRelationEntities(long, int, int, long, boolean) - Method in class io.objectbox.Cursor
- nativeGetRelationIds(long, int, int, long, boolean) - Method in class io.objectbox.Cursor
- nativeGetRootId(long) - Method in class io.objectbox.tree.Tree
-
Get the root data branch ID.
- nativeGetState(long) - Method in class io.objectbox.sync.SyncClientImpl
-
Returns the current
SyncStatevalue. - nativeGetStatsString(long) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeGetVersion() - Static method in class io.objectbox.BoxStore
- nativeGloballyActiveEntityTypes() - Static method in class io.objectbox.BoxStore
-
A static counter for the alive entity types (entity schema instances); this can be useful to test against leaks.
- nativeGreater(long, int, byte[], boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeGreater(long, int, double, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeGreater(long, int, long, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeGreater(long, int, String, boolean, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeHasFeature(int) - Static method in class io.objectbox.BoxStore
- nativeIn(long, int, int[], boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeIn(long, int, long[], boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeIn(long, int, String[], boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeIsActive(long) - Method in class io.objectbox.Transaction
- nativeIsObjectBrowserAvailable() - Static method in class io.objectbox.BoxStore
- nativeIsOwnerThread(long) - Method in class io.objectbox.Transaction
- nativeIsReadOnly(long) - Static method in class io.objectbox.BoxStore
- nativeIsReadOnly(long) - Method in class io.objectbox.Transaction
- nativeIsRecycled(long) - Method in class io.objectbox.Transaction
- nativeIsRunning(long) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeLess(long, int, byte[], boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeLess(long, int, double, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeLess(long, int, long, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeLess(long, int, String, boolean, boolean) - Method in class io.objectbox.query.QueryBuilder
- NativeLibraryLoader - Class in io.objectbox.internal
-
Separate class, so we can mock BoxStore.
- NativeLibraryLoader() - Constructor for class io.objectbox.internal.NativeLibraryLoader
- nativeLink(long, long, int, int, int, int, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeLookupKeyUsingIndex(long, int, String) - Static method in class io.objectbox.Cursor
- nativeMax(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeMaxDouble(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeMin(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeMinDouble(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeModifyRelations(long, int, long, long[], boolean) - Method in class io.objectbox.Cursor
- nativeModifyRelationsSingle(long, int, long, long, boolean) - Method in class io.objectbox.Cursor
- nativeNearestNeighborsF32(long, int, float[], int) - Method in class io.objectbox.query.QueryBuilder
- nativeNextEntity(long) - Static method in class io.objectbox.Cursor
- nativeNotEqual(long, int, long) - Method in class io.objectbox.query.QueryBuilder
- nativeNotEqual(long, int, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeNotNull(long, int) - Method in class io.objectbox.query.QueryBuilder
- nativeNull(long, int) - Method in class io.objectbox.query.QueryBuilder
- nativeObjectsMessageAddBytes(long, long, byte[], boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeObjectsMessageAddString(long, long, String) - Method in class io.objectbox.sync.SyncClientImpl
- nativeObjectsMessageSend(long, long) - Method in class io.objectbox.sync.SyncClientImpl
-
Do not use
builderHandleafterwards. - nativeObjectsMessageStart(long, String) - Method in class io.objectbox.sync.SyncClientImpl
-
Returns a handle to the message builder.
- nativeOrder(long, int, int) - Method in class io.objectbox.query.QueryBuilder
- nativePanicModeRemoveAllObjects(long, int) - Method in class io.objectbox.BoxStore
- nativePropertyId(long, String) - Method in class io.objectbox.Cursor
- nativePutBranch(long, long, long, long, String) - Method in class io.objectbox.tree.Tree
- nativePutLongKey(long, long, byte[]) - Static method in class io.objectbox.KeyValueCursor
- nativePutMetaBranch(long, long, long, String, String) - Method in class io.objectbox.tree.Tree
- nativePutMetaBranches(long, long, String[]) - Method in class io.objectbox.tree.Tree
- nativePutMetaLeaf(long, long, long, String, short, boolean, String) - Method in class io.objectbox.tree.Tree
- nativePutValueFP(long, long, long, long, double) - Method in class io.objectbox.tree.Tree
- nativePutValueInteger(long, long, long, long, long) - Method in class io.objectbox.tree.Tree
- nativePutValueString(long, long, long, long, String) - Method in class io.objectbox.tree.Tree
- nativeRecycle(long) - Method in class io.objectbox.Transaction
- nativeRegisterCustomType(long, int, int, String, Class<? extends PropertyConverter>, Class<?>) - Static method in class io.objectbox.BoxStore
- nativeRegisterEntityClass(long, String, Class<?>) - Static method in class io.objectbox.BoxStore
- nativeRelationCount(long, long, int, int, int) - Method in class io.objectbox.query.QueryBuilder
- nativeRemove(long, long) - Method in class io.objectbox.query.Query
- nativeRemoveAt(long, long) - Static method in class io.objectbox.KeyValueCursor
- nativeRemoveDbFiles(String, boolean) - Static method in class io.objectbox.BoxStore
- nativeRenew(long) - Method in class io.objectbox.Cursor
- nativeRenew(long) - Method in class io.objectbox.Transaction
- nativeRequestFullSync(long, boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeRequestUpdates(long, boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeReset(long) - Method in class io.objectbox.Transaction
- nativeRoundtripTime(long) - Method in class io.objectbox.sync.SyncClientImpl
- nativeSeek(long, long) - Static method in class io.objectbox.Cursor
- nativeSeek(long, long) - Static method in class io.objectbox.KeyValueCursor
- nativeSeekOrNext(long, byte[]) - Static method in class io.objectbox.internal.DebugCursor
- nativeServerTime(long) - Method in class io.objectbox.sync.SyncClientImpl
-
The current server timestamp approximation based on the last server time we've received and local steady clock.
- nativeServerTimeDiff(long) - Method in class io.objectbox.sync.SyncClientImpl
-
Returns the difference between the current local timestamp and the current server timestamp approximation as given by nativeServerTime().
- nativeSetBoxStoreForEntities(long, Object) - Method in class io.objectbox.Cursor
- nativeSetDbExceptionListener(long, DbExceptionListener) - Static method in class io.objectbox.BoxStore
- nativeSetDebugFlags(long, int) - Static method in class io.objectbox.BoxStore
- nativeSetListener(long, SyncClientImpl.InternalSyncClientListener) - Method in class io.objectbox.sync.SyncClientImpl
- nativeSetLoginInfo(long, long, byte[]) - Method in class io.objectbox.sync.SyncClientImpl
- nativeSetLoginInfoUserPassword(long, long, String, String) - Method in class io.objectbox.sync.SyncClientImpl
- nativeSetParameter(long, int, int, String, byte[]) - Method in class io.objectbox.query.Query
- nativeSetParameter(long, int, int, String, double) - Method in class io.objectbox.query.Query
- nativeSetParameter(long, int, int, String, float[]) - Method in class io.objectbox.query.Query
- nativeSetParameter(long, int, int, String, long) - Method in class io.objectbox.query.Query
- nativeSetParameter(long, int, int, String, String) - Method in class io.objectbox.query.Query
- nativeSetParameterAlias(long, String) - Method in class io.objectbox.query.QueryBuilder
- nativeSetParameters(long, int, int, String, double, double) - Method in class io.objectbox.query.Query
- nativeSetParameters(long, int, int, String, int[]) - Method in class io.objectbox.query.Query
- nativeSetParameters(long, int, int, String, long[]) - Method in class io.objectbox.query.Query
- nativeSetParameters(long, int, int, String, long, long) - Method in class io.objectbox.query.Query
- nativeSetParameters(long, int, int, String, String[]) - Method in class io.objectbox.query.Query
- nativeSetParameters(long, int, int, String, String, String) - Method in class io.objectbox.query.Query
- nativeSetRequestUpdatesMode(long, boolean, boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeSetSyncChangesListener(long, SyncChangeListener) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeSetSyncChangesListener(long, SyncChangeListener) - Method in class io.objectbox.sync.SyncClientImpl
- nativeSetTransaction(long, long) - Method in class io.objectbox.tree.Tree
- nativeSetUncommittedAcks(long, boolean) - Method in class io.objectbox.sync.SyncClientImpl
- nativeStart(long) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeStart(long) - Method in class io.objectbox.sync.SyncClientImpl
- nativeStartObjectBrowser(long, String, int) - Method in class io.objectbox.BoxStore
- nativeStartsWith(long, int, String, boolean) - Method in class io.objectbox.query.QueryBuilder
- nativeStop(long) - Method in class io.objectbox.sync.server.SyncServerImpl
- nativeStop(long) - Method in class io.objectbox.sync.SyncClientImpl
- nativeStopObjectBrowser(long) - Method in class io.objectbox.BoxStore
- nativeSum(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeSumDouble(long, long, int) - Method in class io.objectbox.query.PropertyQuery
- nativeSysProcMeminfoKb(String) - Static method in class io.objectbox.BoxStore
- nativeSysProcStatusKb(String) - Static method in class io.objectbox.BoxStore
- nativeThrowException(long, int) - Static method in class io.objectbox.exception.DbExceptionListenerJni
- nativeToString(long) - Method in class io.objectbox.query.Query
- nativeTriggerReconnect(long) - Method in class io.objectbox.sync.SyncClientImpl
-
Hints to the native client that an active network connection is available.
- nativeValidate(long, long, boolean) - Method in class io.objectbox.BoxStore
- NearestNeighborCondition(Property<T>, float[], int) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.NearestNeighborCondition
- nearestNeighbors(float[], int) - Method in class io.objectbox.Property
-
Performs an approximate nearest neighbor (ANN) search to find objects near to the given
queryVector. - nearestNeighbors(Property<T>, float[], int) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - neighborsPerNode() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
Aka "M": the max number of connections per node (default: 30).
- neighborsPerNode() - Method in class io.objectbox.model.HnswParams
-
Aka "M": the max number of connections per node (default: 30).
- nested - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- Nested(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Structures are always stored inline, they need to be created right where they're used.
- newByteBuffer(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder.ByteBufferFactory
-
Create a `ByteBuffer` with a given capacity.
- newByteBuffer(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder.HeapByteBufferFactory
- newThread(Runnable) - Method in class io.objectbox.internal.ObjectBoxThreadPool.ObjectBoxThreadFactory
- next() - Method in class io.objectbox.Cursor
- next() - Method in class io.objectbox.query.LazyList.LazyIterator
- nextIndex() - Method in class io.objectbox.query.LazyList.LazyIterator
- noCaseIfDistinct - Variable in class io.objectbox.query.PropertyQuery
- node - Variable in class io.objectbox.tree.Leaf
- NON_PRIMITIVE_TYPE - Static variable in class io.objectbox.model.PropertyFlags
-
On languages like Java, a non-primitive type is used (aka wrapper types, allowing null)
- none() - Static method in class io.objectbox.sync.SyncCredentials
-
No authentication, unsecured.
- None - Static variable in class io.objectbox.config.ValidateOnOpenModePages
-
No additional checks are performed.
- None - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.No additional checks are performed.
- None - Static variable in class io.objectbox.sync.CredentialsType
-
No credentials required; do not use for public/production servers.
- NONE - Enum constant in enum class io.objectbox.query.QueryBuilder.Operator
- NONE - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- NonUniqueResultException - Exception Class in io.objectbox.exception
-
Thrown if
Query.findUnique()orQuery.findUniqueId()is called, but the query matches more than one object. - NonUniqueResultException(String) - Constructor for exception class io.objectbox.exception.NonUniqueResultException
- noReaderThreadLocals - Variable in class io.objectbox.BoxStoreBuilder
- noReaderThreadLocals() - Method in class io.objectbox.BoxStoreBuilder
-
Disables the usage of thread locals for "readers" related to read transactions.
- noReaderThreadLocals() - Method in class io.objectbox.config.FlatStoreOptions
-
Disables the usage of thread locals for "readers" related to read transactions.
- NOT_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- NOT_EQUAL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- NOT_IN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition.Operation
- NOT_IN - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition.Operation
- NOT_NULL - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.NullCondition.Operation
- NOT_NULL - Static variable in class io.objectbox.model.PropertyFlags
-
Unused yet
- notEq(Object) - Method in class io.objectbox.Property
-
Deprecated.Use
Property.notEqual(boolean)instead. - notEqual(boolean) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property.
- notEqual(int) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property.
- notEqual(long) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property.
- notEqual(short) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property.
- notEqual(Property<T>, boolean) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - notEqual(Property<T>, long) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - notEqual(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - notEqual(Property<T>, Date) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - notEqual(String) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property using
StringOrder#CASE_SENSITIVE. - notEqual(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property.
- notEqual(Date) - Method in class io.objectbox.Property
-
Creates a "not equal ('<>')" condition for this property.
- notifyConnectionAvailable() - Method in class io.objectbox.sync.ConnectivityMonitor
-
Notifies the observer that a connection is available.
- notifyConnectionAvailable() - Method in interface io.objectbox.sync.SyncClient
-
Lets the sync client know that a working network connection is available.
- notifyConnectionAvailable() - Method in class io.objectbox.sync.SyncClientImpl
- notIn(Property<T>, int[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - notIn(Property<T>, long[]) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - notNested() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Should not be creating any other object, string or vector while an object is being constructed.
- notNull() - Method in class io.objectbox.Property
-
Creates an "IS NOT NULL" condition for this property.
- notNull(Property<T>) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - NotNull - Annotation Interface in io.objectbox.annotation
-
Specifies that property is not null
- notOneOf(int[]) - Method in class io.objectbox.Property
-
Creates a "NOT IN (..., ..., ...)" condition for this property.
- notOneOf(long[]) - Method in class io.objectbox.Property
-
Creates a "NOT IN (..., ..., ...)" condition for this property.
- notOneOf(Date[]) - Method in class io.objectbox.Property
-
Creates a "NOT IN (..., ..., ...)" condition for this property.
- NULL_REFERENCE - Static variable in class io.objectbox.flatbuffers.FlexBuffers.Reference
- NullCondition(Property<T>, PropertyQueryConditionImpl.NullCondition.Operation) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.NullCondition
- 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).
- NullToEmptyStringConverter - Class in io.objectbox.converter
-
Used as a converter if a property is annotated with
@DefaultValue(""). - NullToEmptyStringConverter() - Constructor for class io.objectbox.converter.NullToEmptyStringConverter
- nullValue(int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- nullValue(Object) - Method in class io.objectbox.query.PropertyQuery
-
By default, null values are not returned by find methods (primitive arrays cannot contains nulls).
- nullValueDouble - Variable in class io.objectbox.query.PropertyQuery
- nullValueFloat - Variable in class io.objectbox.query.PropertyQuery
- nullValueLong - Variable in class io.objectbox.query.PropertyQuery
- nullValueString - Variable in class io.objectbox.query.PropertyQuery
- num_vtables - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- NumericOverflowException - Exception Class 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 class io.objectbox.exception.NumericOverflowException
O
- object - Variable in class io.objectbox.query.ObjectWithScore
- Object(ReadBuf, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Object
- object_start - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- OBJECTBOX_JNI - Static variable in class io.objectbox.internal.NativeLibraryLoader
- ObjectBoxThreadFactory() - Constructor for class io.objectbox.internal.ObjectBoxThreadPool.ObjectBoxThreadFactory
- ObjectBoxThreadPool - Class in io.objectbox.internal
-
Custom thread pool similar to
Executors.newCachedThreadPool()with the following adjustments: Release thread local resources (BoxStore.closeThreadResources()) Reduce keep-alive time for threads to 20 seconds Uses a ThreadFactory to name threads like "ObjectBox-1-Thread-1" - ObjectBoxThreadPool(BoxStore) - Constructor for class io.objectbox.internal.ObjectBoxThreadPool
- ObjectBoxThreadPool.ObjectBoxThreadFactory - Class in io.objectbox.internal
- objectBrowserPort - Variable in class io.objectbox.BoxStore
- objectClassObserver - Variable in class io.objectbox.query.QueryPublisher
- objectClassPublisher - Variable in class io.objectbox.BoxStore
- ObjectClassPublisher - Class in io.objectbox
-
A
DataPublisherthat notifiesDataObservers about changes in an entity box. - ObjectClassPublisher(BoxStore) - Constructor for class io.objectbox.ObjectClassPublisher
- ObjectClassPublisher.PublishRequest - Class in io.objectbox
- objectClassSubscription - Variable in class io.objectbox.query.QueryPublisher
- objectIds - Variable in class io.objectbox.query.LazyList
- ObjectsMessageBuilder - Interface in io.objectbox.sync
- ObjectsMessageBuilderImpl(SyncClientImpl, long, String) - Constructor for class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- objectValue - Variable in class io.objectbox.tree.LeafNode
-
One of String, byte[], String[]
- ObjectWithScore<T> - Class in io.objectbox.query
-
Wraps a matching object and a score when using
Query.findWithScores(long, long). - ObjectWithScore(T, double) - Constructor for class io.objectbox.query.ObjectWithScore
- observable(BoxStore) - Static method in class io.objectbox.rx3.RxBoxStore
-
Using the returned Observable, you can be notified about data changes.
- observable(Query<T>) - Static method in class io.objectbox.rx3.RxQuery
-
The returned Observable emits Query results as Lists.
- observer - Variable in class io.objectbox.ObjectClassPublisher.PublishRequest
- observer - Variable in class io.objectbox.reactive.DataSubscriptionImpl
- observer - Variable in class io.objectbox.reactive.SubscriptionBuilder
- observer(DataObserver<T>) - Method in class io.objectbox.reactive.SubscriptionBuilder
-
Sets the observer for this subscription and requests the latest data to be delivered immediately.
- observers - Variable in class io.objectbox.query.QueryPublisher
- observersByEntityTypeId - Variable in class io.objectbox.ObjectClassPublisher
- OBX_ADMIN_USER - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- obxAdminUser(String, String) - Static method in class io.objectbox.sync.SyncCredentials
-
ObjectBox admin users (username/password)
- ObxAdminUser - Static variable in class io.objectbox.sync.CredentialsType
-
Use ObjectBox Admin users for Sync authentication.
- offset() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Offset relative to the end of the buffer.
- 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. - onConflict() - Element in annotation interface io.objectbox.annotation.Unique
-
The strategy to use when a conflict is detected when an object is put.
- onData(List<T>) - Method in class io.objectbox.query.QueryPublisher.SubscribedObservers
- onData(T) - Method in interface io.objectbox.reactive.DataObserver
-
Called when data changed.
- onData(T) - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- onData(T) - Method in class io.objectbox.reactive.WeakDataObserver
- 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.SyncClientImpl.InternalSyncClientListener
- onDisconnected() - Method in class io.objectbox.sync.listener.AbstractSyncListener
- onDisconnected() - Method in interface io.objectbox.sync.listener.SyncConnectionListener
-
Called when the client is disconnected from the sync server, e.g.
- ONE - Static variable in class io.objectbox.relation.ToMany
- oneOf(int[]) - Method in class io.objectbox.Property
-
Creates an "IN (..., ..., ...)" condition for this property.
- oneOf(long[]) - Method in class io.objectbox.Property
-
Creates an "IN (..., ..., ...)" condition for this property.
- oneOf(String[]) - Method in class io.objectbox.Property
-
Creates an "IN (..., ..., ...)" condition for this property using
StringOrder#CASE_SENSITIVE. - oneOf(String[], QueryBuilder.StringOrder) - Method in class io.objectbox.Property
-
Creates an "IN (..., ..., ...)" condition for this property.
- oneOf(Date[]) - Method in class io.objectbox.Property
-
Creates an "IN (..., ..., ...)" condition for this property.
- onError(ErrorObserver) - Method in class io.objectbox.reactive.SubscriptionBuilder
-
The given
ErrorObserveris notified when theDataTransformer(SubscriptionBuilder.transform(DataTransformer)) orDataObserver(SubscriptionBuilder.observer(DataObserver)) threw an exception. - onError(Throwable) - Method in interface io.objectbox.reactive.ErrorObserver
-
Called when an exception was thrown.
- onLoggedIn() - Method in class io.objectbox.sync.listener.AbstractSyncListener
- onLoggedIn() - Method in interface io.objectbox.sync.listener.SyncLoginListener
-
Called on a successful login.
- onLogin() - Method in class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
- onLoginFailed(long) - Method in class io.objectbox.sync.listener.AbstractSyncListener
- onLoginFailed(long) - Method in interface io.objectbox.sync.listener.SyncLoginListener
-
Called on a login failure.
- onLoginFailure(long) - Method in class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
- onlyChanges - Variable in class io.objectbox.reactive.SubscriptionBuilder
- onlyChanges() - Method in class io.objectbox.reactive.SubscriptionBuilder
-
Upon subscribing do not deliver the latest data, only once there are changes.
- onObserverRemoved() - Method in class io.objectbox.sync.ConnectivityMonitor
-
Called right after the observer was removed.
- onObserverSet() - Method in class io.objectbox.sync.ConnectivityMonitor
-
Called right after the observer was set.
- onServerTimeUpdate(long) - Method in class io.objectbox.sync.listener.AbstractSyncListener
- onServerTimeUpdate(long) - Method in interface io.objectbox.sync.listener.SyncTimeListener
-
Called when server time information is received on the client.
- onServerTimeUpdate(long) - Method in class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
- onSyncChanges(SyncChange[]) - Method in class io.objectbox.sync.listener.AbstractSyncListener
- onSyncChanges(SyncChange[]) - Method in interface io.objectbox.sync.listener.SyncChangeListener
-
Called each time when data from sync was applied locally.
- onSyncComplete() - Method in class io.objectbox.sync.SyncClientImpl.InternalSyncClientListener
- onUpdatesCompleted() - Method in class io.objectbox.sync.listener.AbstractSyncListener
- onUpdatesCompleted() - Method in interface io.objectbox.sync.listener.SyncCompletedListener
-
Called each time a sync was "completed", in the sense that the client caught up with the current server state.
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.NullCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringCondition
- op - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition
- openFiles - Static variable in class io.objectbox.BoxStore
-
Currently used DB dirs with values from
BoxStore.getCanonicalPath(File). - openFilesCheckerThread - Static variable in class io.objectbox.BoxStore
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.NullCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- Operation() - Constructor for enum class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition.Operation
- Operator() - Constructor for enum class io.objectbox.query.QueryBuilder.Operator
- or() - Method in class io.objectbox.query.QueryBuilder
-
Combines the previous condition with the following condition with a logical OR.
- or(QueryCondition<T>) - Method in interface io.objectbox.query.QueryCondition
-
Combines this condition using OR with the given condition.
- or(QueryCondition<T>) - Method in class io.objectbox.query.QueryConditionImpl
- OR - Enum constant in enum class io.objectbox.query.QueryBuilder.Operator
- OrCondition(QueryConditionImpl<T>, QueryConditionImpl<T>) - Constructor for class io.objectbox.query.LogicQueryCondition.OrCondition
- order - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition
- order - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringCondition
- order - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition
- 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).
- OrderBy - Annotation Interface in io.objectbox.annotation
-
Specifies ordering of related collection ofrelation E.g.: @OrderBy("name, age DESC") List collection; If used as marker (@OrderBy List collection), then collection is ordered by primary key
invalid reference
Relation - 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
- OrderFlags() - Constructor for class io.objectbox.query.OrderFlags
- ordinal - Variable in class io.objectbox.Property
- original - Variable in class io.objectbox.query.QueryThreadLocal
P
- packedType(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- pad(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add zero valued bytes to prepare a new entry to be added.
- paddingBytes(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- PagesCorruptException - Exception Class in io.objectbox.exception
-
Errors related to pages were detected in a database file, e.g.
- PagesCorruptException(String) - Constructor for exception class io.objectbox.exception.PagesCorruptException
- PagesCorruptException(String, int) - Constructor for exception class io.objectbox.exception.PagesCorruptException
- 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.
- panicModeRemoveAllObjects(int) - Method in class io.objectbox.BoxStore
- parameterAlias(String) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - parentWidth - Variable in class io.objectbox.flatbuffers.FlexBuffers.Reference
- password - Variable in class io.objectbox.sync.SyncCredentialsUserPassword
- pathSeparatorRegex - Variable in class io.objectbox.tree.Tree
- 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
-
Deprecated.Use
clusterPeer(url, SyncCredentials.none())instead. - peer(String, SyncCredentials) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Deprecated.
- platform - Variable in class io.objectbox.sync.SyncBuilder
- Platform - Class in io.objectbox.sync.internal
-
Provides access to platform-specific features.
- Platform() - Constructor for class io.objectbox.sync.internal.Platform
- POOL_COUNT - Static variable in class io.objectbox.internal.ObjectBoxThreadPool.ObjectBoxThreadFactory
- prep(int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Prepare to write an element of `size` after `additional_bytes` have been written, e.g.
- prepareToManyBacklinkEntitiesForDb(long, IdGetter<TARGET>, Map<TARGET, Boolean>, Map<TARGET, Boolean>) - Method in class io.objectbox.relation.ToMany
-
Modifies the
linkedToMany relation of added or removed target objects and schedules put byToMany.internalApplyToDb(io.objectbox.Cursor<?>, io.objectbox.Cursor<TARGET>)for them. - prepareToOneBacklinkEntitiesForDb(long, IdGetter<TARGET>, Map<TARGET, Boolean>, Map<TARGET, Boolean>) - Method in class io.objectbox.relation.ToMany
- 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
- properties(int) - Method in class io.objectbox.model.ModelEntity
- properties(ModelProperty, int) - Method in class io.objectbox.model.ModelEntity
- propertiesByClass - Variable in class io.objectbox.BoxStore
- propertiesLength() - Method in class io.objectbox.model.ModelEntity
- propertiesVector() - Method in class io.objectbox.model.ModelEntity
- propertiesVector(ModelProperty.Vector) - Method in class io.objectbox.model.ModelEntity
- property - Variable in class io.objectbox.query.PropertyQuery
- property - Variable in class io.objectbox.query.PropertyQueryConditionImpl
- property(Property<T>) - Method in class io.objectbox.query.Query
-
Creates a
PropertyQueryfor the given property. - property(String) - Method in class io.objectbox.ideasonly.ModelModifier.EntityModifier
- property(String, int) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- property(String, String, int) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- property(String, String, String, int) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- 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
- propertyBuilder - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- PropertyBuilder(String, String, String, int) - Constructor for class io.objectbox.ModelBuilder.PropertyBuilder
- 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.
- PropertyFlags - Class in io.objectbox.model
-
Bit-flags defining the behavior of properties.
- PropertyFlags() - Constructor for class io.objectbox.model.PropertyFlags
- propertyId - Variable in class io.objectbox.query.PropertyQuery
- PropertyModifier(ModelModifier.EntityModifier, String) - Constructor for class io.objectbox.ideasonly.ModelModifier.PropertyModifier
- propertyNameOffset - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- propertyOffsets - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- PropertyQuery - Class in io.objectbox.query
-
Query for a specific property; create using
Query.property(Property). - PropertyQuery(Query<?>, Property<?>) - Constructor for class io.objectbox.query.PropertyQuery
- PropertyQueryCondition<T> - Interface in io.objectbox.query
-
A condition on a
Property, which can have an alias to allow referring to it later. - PropertyQueryConditionImpl<T> - Class in io.objectbox.query
-
Propertybased query conditions with implementations split by number and type of values, such asLongCondition,LongLongCondition,LongArrayConditionand the generalNullCondition. - PropertyQueryConditionImpl(Property<T>) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl
- PropertyQueryConditionImpl.ByteArrayCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.ByteArrayCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.DoubleCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.DoubleCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.DoubleDoubleCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.DoubleDoubleCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.IntArrayCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.IntArrayCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.LongArrayCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.LongArrayCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.LongCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.LongCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.LongLongCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.LongLongCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.NearestNeighborCondition<T> - Class in io.objectbox.query
-
Conditions for properties with an
HnswIndex. - PropertyQueryConditionImpl.NullCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.NullCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.StringArrayCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.StringArrayCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.StringCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.StringCondition.Operation - Enum Class in io.objectbox.query
- PropertyQueryConditionImpl.StringStringCondition<T> - Class in io.objectbox.query
- PropertyQueryConditionImpl.StringStringCondition.Operation - Enum Class in io.objectbox.query
- PropertyType - Class in io.objectbox.model
-
Basic type of a property
- PropertyType() - Constructor for class io.objectbox.model.PropertyType
- provide() - Method in interface io.objectbox.Factory
- publicKey - Variable in class io.objectbox.sync.server.SyncServerBuilder
- publicKey() - Method in class io.objectbox.sync.server.JwtConfig
-
Fixed public key used to sign JWT tokens; e.g.
- publicKeyAsByteBuffer() - Method in class io.objectbox.sync.server.JwtConfig
- publicKeyCacheExpirationSeconds() - Method in class io.objectbox.sync.server.JwtConfig
-
Cache expiration time in seconds for the public key(s) fetched from publicKeyUrl.
- publicKeyInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig
- publicKeyUrl - Variable in class io.objectbox.sync.server.SyncServerBuilder
- publicKeyUrl() - Method in class io.objectbox.sync.server.JwtConfig
-
URL to fetch the current public key used to verify JWT signatures.
- publicKeyUrlAsByteBuffer() - Method in class io.objectbox.sync.server.JwtConfig
- publicKeyUrlInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig
- publish() - Method in class io.objectbox.query.Query
-
Publishes the current data to all subscribed @
DataObservers. - publish() - Method in class io.objectbox.query.QueryPublisher
- publish(int[]) - Method in class io.objectbox.ObjectClassPublisher
- publisher - Variable in class io.objectbox.query.Query
- publisher - Variable in class io.objectbox.reactive.DataSubscriptionImpl
- publisher - Variable in class io.objectbox.reactive.SubscriptionBuilder
- publisherParam - Variable in class io.objectbox.reactive.DataSubscriptionImpl
- publisherParam - Variable in class io.objectbox.reactive.SubscriptionBuilder
- publisherRunning - Variable in class io.objectbox.query.QueryPublisher
- publishQueue - Variable in class io.objectbox.query.QueryPublisher
- PublishRequest(DataObserver<Class>, int[]) - Constructor for class io.objectbox.ObjectClassPublisher.PublishRequest
- publishSingle(DataObserver<Class>, Object) - Method in class io.objectbox.ObjectClassPublisher
- publishSingle(DataObserver<List<T>>, Object) - Method in class io.objectbox.query.QueryPublisher
- publishSingle(DataObserver<T>, Object) - Method in interface io.objectbox.reactive.DataPublisher
- put(byte) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- put(byte) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- put(byte) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write a byte into the buffer at
writePosition(). - put(byte[], int, int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- put(byte[], int, int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- put(byte[], int, int) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Put an array of bytes into the buffer at
writePosition(). - put(long, byte[]) - Method in class io.objectbox.KeyValueCursor
- put(Leaf) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data leaf (containing a data value).
- 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 and returns its (new) ID.
- put(T) - Method in class io.objectbox.Cursor
- put(T...) - Method in class io.objectbox.Box
-
Puts the given entities in a box using a single transaction.
- PUT_FLAG_COMPLETE - Static variable in class io.objectbox.Cursor
- PUT_FLAG_COMPLETE - Static variable in class io.objectbox.KeyValueCursor
- PUT_FLAG_FIRST - Static variable in class io.objectbox.Cursor
- PUT_FLAG_FIRST - Static variable in class io.objectbox.KeyValueCursor
- PUT_FLAG_INSERT_NEW - Static variable in class io.objectbox.KeyValueCursor
- 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.
- putBlob(byte[]) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a byte array into the message
- putBlob(String, byte[]) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a byte array into the message
- putBoolean(boolean) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- putBoolean(boolean) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- putBoolean(boolean) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `boolean` to the buffer, backwards from the current location.
- putBoolean(boolean) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Insert a single boolean into the buffer
- putBoolean(boolean) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Put a boolean into the buffer at
writePosition(). - putBoolean(String, boolean) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Insert a single boolean into the buffer
- putBranch(long, long) - Method in class io.objectbox.tree.Tree
-
Put a new (inserts) data branch
- putBranch(long, long, long, String) - Method in class io.objectbox.tree.Tree
-
Put a new or existing data branch
- putBranch(long, long, String) - Method in class io.objectbox.tree.Tree
-
Put a new (inserts) data branch
- putByte(byte) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `byte` to the buffer, backwards from the current location.
- putDouble(double) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- putDouble(double) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- putDouble(double) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `double` to the buffer, backwards from the current location.
- putDouble(double) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write a 64-bit float into the buffer at
writePosition(). - putFloat(double) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a 64-bit float into the buff.
- putFloat(float) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- putFloat(float) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- putFloat(float) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `float` to the buffer, backwards from the current location.
- putFloat(float) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a 32-bit float into the buff.
- putFloat(float) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write a 32-bit float into the buffer at
writePosition(). - putFloat(String, double) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a 64-bit float into the buff.
- putFloat(String, float) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a 32-bit float into the buff.
- putIfChanged(T) - Method in class io.objectbox.Box
- putInt(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- putInt(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- putInt(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add an `int` to the buffer, backwards from the current location.
- putInt(int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a integer into the buff
- putInt(int) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write a 32-bit into in the buffer at
writePosition(). - putInt(long) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a 64-bit integer into the buff
- putInt(String, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a integer into the buff
- putInt(String, long) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a integer into the buff
- putKey(String) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- putLong(long) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- putLong(long) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- putLong(long) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `long` to the buffer, backwards from the current location.
- putLong(long) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write a 64-bit into in the buffer at
writePosition(). - putMetaBranch(long, long, String) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a branch in the metamodel.
- putMetaBranch(long, long, String, String) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a branch in the metamodel with an optional description.
- putMetaBranches(long, String[]) - Method in class io.objectbox.tree.Tree
-
Puts (persists) several branches in the metamodel from the given parent ID (must be a meta branch).
- putMetaBranches(String[]) - Method in class io.objectbox.tree.Tree
-
Puts (persists) several branches in the metamodel to create the given path from the root.
- putMetaLeaf(long, long, String, short) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data leaf in the metamodel (describes values).
- putMetaLeaf(long, long, String, short, boolean) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data leaf in the metamodel (describes values).
- putMetaLeaf(long, long, String, short, boolean, String) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data leaf in the metamodel (describes values).
- putNull() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Insert a null value into the buffer
- putNull(String) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Insert a null value into the buffer
- putPaddingMode() - Method in class io.objectbox.config.FlatStoreOptions
-
Don't touch unless you know exactly what you are doing: Advanced setting typically meant for language bindings (not end users).
- putShort(short) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- putShort(short) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- putShort(short) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Add a `short` to the buffer, backwards from the current location.
- putShort(short) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write a 16-bit into in the buffer at
writePosition(). - putString(String) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a String into the buffer
- putString(String, String) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a String into the buffer
- putUInt(int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a unsigned integer into the buff.
- putUInt(long) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a unsigned integer (stored in a signed 64-bit integer) into the buff.
- putUInt(String, long) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- putUInt64(String, long) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- putUInt64(BigInteger) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Adds a 64-bit unsigned integer (stored as
BigInteger) into the buff. - putValue(long, long, double) - Method in class io.objectbox.tree.Tree
-
Puts (inserts) a new data value (using a data leaf).
- putValue(long, long, long) - Method in class io.objectbox.tree.Tree
-
Puts (inserts) a new data value (using a data leaf).
- putValue(long, long, long, double) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data value (using a data leaf).
- putValue(long, long, long, long) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data value (using a data leaf).
- putValue(long, long, long, String) - Method in class io.objectbox.tree.Tree
-
Puts (persists) a data value (using a data leaf).
- putValue(long, long, String) - Method in class io.objectbox.tree.Tree
-
Puts (inserts) a new data value (using a data leaf).
Q
- query - Variable in class io.objectbox.query.PropertyQuery
- query - Variable in class io.objectbox.query.QueryPublisher
- query() - Method in class io.objectbox.Box
-
Create a query with no conditions.
- query(QueryCondition<T>) - Method in class io.objectbox.Box
-
Applies the given query conditions and returns the builder for further customization, such as result order.
- Query<T> - Class in io.objectbox.query
-
A repeatable Query returning the latest matching objects.
- Query(Box<T>, long, List<EagerRelation<T, ?>>, QueryFilter<T>, Comparator<T>) - Constructor for class io.objectbox.query.Query
- Query(Query<T>, long) - Constructor for class io.objectbox.query.Query
-
Creates a copy of the
originalQuery, but pointing to a different native query usinghandle. - queryAttempts - Variable in class io.objectbox.BoxStore
- queryAttempts - Variable in class io.objectbox.BoxStoreBuilder
- queryAttempts - Variable in class io.objectbox.query.Query
- 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
-
Builds a
Queryusing conditions which can then be used to return a list of matching Objects. - QueryBuilder(long, long) - Constructor for class io.objectbox.query.QueryBuilder
- QueryBuilder(Box<T>, long, String) - Constructor for class io.objectbox.query.QueryBuilder
- QueryBuilder.Operator - Enum Class in io.objectbox.query
- QueryBuilder.StringOrder - Enum Class in io.objectbox.query
- QueryCondition<T> - Interface in io.objectbox.query
-
Allows building queries with a fluent interface.
- QueryConditionImpl<T> - Class in io.objectbox.query
-
Hides the
QueryConditionImpl.apply(QueryBuilder)method from the public API (QueryCondition). - QueryConditionImpl() - Constructor for class io.objectbox.query.QueryConditionImpl
- QueryConsumer<T> - Interface in io.objectbox.query
- QueryFilter<T> - Interface in io.objectbox.query
-
Decides which entities to keep as a query result.
- queryHandle - Variable in class io.objectbox.query.PropertyQuery
- QueryPublisher<T> - Class in io.objectbox.query
-
A
DataPublisherthat subscribes to an ObjectClassPublisher if there is at least one observer. - QueryPublisher(Query<T>, Box<T>) - Constructor for class io.objectbox.query.QueryPublisher
- QueryPublisher.SubscribedObservers<T> - Class in io.objectbox.query
- QueryThreadLocal<T> - Class in io.objectbox.query
- QueryThreadLocal(Query<T>) - Constructor for class io.objectbox.query.QueryThreadLocal
-
See
QueryThreadLocal. - queryVector - Variable in class io.objectbox.query.PropertyQueryConditionImpl.NearestNeighborCondition
- queueObserverAndScheduleRun(DataObserver<List<T>>) - Method in class io.objectbox.query.QueryPublisher
-
Non-blocking: will just enqueue the changes for a separate thread.
- queuePublishRequestAndScheduleRun(DataObserver<Class>, int[]) - Method in class io.objectbox.ObjectClassPublisher
-
Non-blocking: will just enqueue the changes for a separate thread.
R
- read() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder.ByteBufferBackedInputStream
- ReadBuf - Interface in io.objectbox.flatbuffers
-
Represent a chunk of data, where FlexBuffers will read from.
- readDouble(ReadBuf, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- readInt(ReadBuf, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- readLong(ReadBuf, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- readOnly - Variable in class io.objectbox.BoxStoreBuilder
- readOnly - Variable in class io.objectbox.Cursor
- readOnly - Variable in class io.objectbox.Transaction
- readOnly() - Method in class io.objectbox.BoxStoreBuilder
-
Open the store in read-only mode: no schema update, no write transactions are allowed (would throw).
- readOnly() - Method in class io.objectbox.config.FlatStoreOptions
-
Open store in read-only mode: no schema update, no write transactions.
- readTxFinished(Transaction) - Method in class io.objectbox.Box
-
Called by
BoxStore.callInReadTx(Callable)- does not throw so caller does not need try/finally. - readUInt(ReadBuf, int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- ReadWriteBuf - Interface in io.objectbox.flatbuffers
-
Interface to represent a read-write buffer.
- recycle() - Method in class io.objectbox.Transaction
-
For read transactions, this releases important native resources that hold on versions of potential old data.
- Reference(ReadBuf, int, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Reference
- Reference(ReadBuf, int, int, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Reference
- ReflectionCache - Class in io.objectbox.internal
- ReflectionCache() - Constructor for class io.objectbox.internal.ReflectionCache
- Regular - Static variable in class io.objectbox.config.ValidateOnOpenModeKv
-
Performs standard checks.
- Regular - Static variable in class io.objectbox.config.ValidateOnOpenModePages
-
Performs a limited number of checks on the most important database structures (e.g.
- Regular - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.Performs a limited number of checks on the most important database structures (e.g.
- relation(String, int, long, int, long) - Method in class io.objectbox.ModelBuilder.EntityBuilder
- Relation - Static variable in class io.objectbox.model.PropertyType
-
Relation to another entity
- relationCount - Variable in class io.objectbox.query.RelationCountCondition
- relationCount(int) - Method in class io.objectbox.relation.RelationInfo
-
Creates a condition to match objects that have
relationCountrelated objects pointing to them. - relationCount(RelationInfo<T, ?>, int) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - RelationCountCondition<T> - Class in io.objectbox.query
- RelationCountCondition(RelationInfo<T, ?>, int) - Constructor for class io.objectbox.query.RelationCountCondition
- relationId - Variable in class io.objectbox.relation.RelationInfo
-
For stand-alone to-many relations (0 otherwise).
- relationInfo - Variable in class io.objectbox.query.EagerRelation
- relationInfo - Variable in class io.objectbox.query.RelationCountCondition
- relationInfo - Variable in class io.objectbox.relation.ToMany
- relationInfo - Variable in class io.objectbox.relation.ToOne
- RelationInfo<SOURCE,
TARGET> - Class in io.objectbox.relation -
Meta info describing a relation including source and target entity.
- RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, ToManyGetter<SOURCE, TARGET>, int) - Constructor for class io.objectbox.relation.RelationInfo
-
Stand-alone ToMany.
- RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, ToManyGetter<SOURCE, TARGET>, ToManyGetter<TARGET, SOURCE>, int) - Constructor for class io.objectbox.relation.RelationInfo
-
ToMany as a ToMany backlink
- RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, ToManyGetter<SOURCE, TARGET>, Property<TARGET>, ToOneGetter<TARGET, SOURCE>) - Constructor for class io.objectbox.relation.RelationInfo
-
ToMany as a ToOne backlink
- RelationInfo(EntityInfo<SOURCE>, EntityInfo<TARGET>, Property<SOURCE>, ToOneGetter<SOURCE, TARGET>) - Constructor for class io.objectbox.relation.RelationInfo
-
ToOne
- relationOffsets - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- relations(int) - Method in class io.objectbox.model.ModelEntity
- relations(ModelRelation, int) - Method in class io.objectbox.model.ModelEntity
- relationsLength() - Method in class io.objectbox.model.ModelEntity
- relationsVector() - Method in class io.objectbox.model.ModelEntity
- relationsVector(ModelRelation.Vector) - Method in class io.objectbox.model.ModelEntity
- releaseByteBuffer(ByteBuffer) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder.ByteBufferFactory
-
Release a ByteBuffer.
- releaseReader(Cursor<T>) - Method in class io.objectbox.Box
- releaseWriter(Cursor<T>) - Method in class io.objectbox.Box
- relinker - Static variable in class io.objectbox.BoxStore
- relinker - Variable in class io.objectbox.BoxStoreBuilder
- remove() - Method in class io.objectbox.ideasonly.ModelModifier.EntityModifier
- remove() - Method in class io.objectbox.ideasonly.ModelModifier.PropertyModifier
- 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
-
Like
ToMany.remove(Object), but using the location of the target object. - remove(long) - Method in class io.objectbox.Box
-
Removes (deletes) the object with the given ID.
- remove(long...) - Method in class io.objectbox.Box
-
Like
Box.remove(long), but removes multiple objects in a single transaction. - remove(Object) - Method in class io.objectbox.query.LazyList
- remove(Object) - Method in class io.objectbox.relation.ToMany
-
Prepares to remove the target object from this relation.
- remove(Collection<T>) - Method in class io.objectbox.Box
-
Like
Box.remove(Object), but removes multiple objects in a single transaction. - remove(T) - Method in class io.objectbox.Box
-
Like
Box.remove(long), but obtains the ID from the@Idproperty of the given object instead. - remove(T...) - Method in class io.objectbox.Box
-
Like
Box.remove(Object), but removes multiple objects in a single transaction. - removeAll() - Method in class io.objectbox.Box
-
Like
Box.remove(long), but removes 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 types ("boxes"), e.g.
- removeAt(long) - Method in class io.objectbox.KeyValueCursor
- removeById(long) - Method in class io.objectbox.relation.ToMany
-
Like
ToMany.remove(Object), but using just the ID of the target object. - removeByIds(Collection<Long>) - Method in class io.objectbox.Box
-
Like
Box.remove(long), but removes multiple objects in a single transaction. - removeByKeys(Collection<Long>) - Method in class io.objectbox.Box
-
Deprecated.use
Box.removeByIds(Collection)instead. - removedIds - Variable in class io.objectbox.sync.SyncChange
- removeFromTargetBox - Variable in class io.objectbox.relation.ToMany
- removeObserver() - Method in class io.objectbox.sync.ConnectivityMonitor
- removeObserverFromCopyOnWriteSet(Set<DataObserver<T>>, DataObserver<T>) - Static method in class io.objectbox.reactive.DataPublisherUtils
-
Observers may be wrapped by @
DelegatingObserver, this will also remove those. - removeSizePrefix(ByteBuffer) - Static method in class io.objectbox.flatbuffers.ByteBufferUtil
-
Create a duplicate of a size-prefixed `ByteBuffer` that has its position advanced just past the size prefix.
- removeStandaloneRelations(Cursor<?>, long, List<TARGET>, IdGetter<TARGET>) - Method in class io.objectbox.relation.ToMany
-
The list of removed entities may contain non-persisted entities, which will be ignored (removed from the list).
- renameTo(String) - Method in class io.objectbox.ideasonly.ModelModifier.EntityModifier
- renameTo(String) - Method in class io.objectbox.ideasonly.ModelModifier.PropertyModifier
- renew() - Method in class io.objectbox.Cursor
-
To be used in combination with
Transaction.renew(). - renew() - Method in class io.objectbox.Transaction
-
Renews a previously recycled transaction (see
Transaction.recycle()). - reparationBacklinkProbability() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
When repairing the graph after a node was removed, this gives the probability of adding backlinks to the repaired neighbors.
- reparationBacklinkProbability() - Method in class io.objectbox.model.HnswParams
-
When repairing the graph after a node was removed, this gives the probability of adding backlinks to the repaired neighbors.
- reparationLimitCandidates() - Element in annotation interface io.objectbox.annotation.HnswFlags
-
If the speed of removing nodes becomes a concern in your use case, you can speed it up by setting this flag.
- ReparationLimitCandidates - Static variable in class io.objectbox.model.HnswFlags
-
If the speed of removing nodes becomes a concern in your use case, you can speed it up by setting this flag.
- REPLACE - Enum constant in enum class io.objectbox.annotation.ConflictStrategy
-
Any conflicting objects are deleted before the object is inserted.
- REQ_REJECTED - Static variable in class io.objectbox.sync.SyncLoginCodes
- requestCapacity(int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- requestCapacity(int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- requestCapacity(int) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Request capacity of the buffer.
- requestFullSync() - Method in interface io.objectbox.sync.SyncClient
-
Experimental.
- requestFullSync() - Method in class io.objectbox.sync.SyncClientImpl
-
Temporary only, try not to use it.
- requestFullSyncAndUpdates() - Method in class io.objectbox.sync.SyncClientImpl
-
Temporary only, try not to use it.
- requestUpdates() - Method in interface io.objectbox.sync.SyncClient
-
Asks the sync server to resume sync updates.
- requestUpdates() - Method in class io.objectbox.sync.SyncClientImpl
- requestUpdatesMode - Variable in class io.objectbox.sync.SyncBuilder
- requestUpdatesMode(SyncBuilder.RequestUpdatesMode) - Method in class io.objectbox.sync.SyncBuilder
-
Configure automatic sync updates from the server.
- RequestUpdatesMode() - Constructor for enum class io.objectbox.sync.SyncBuilder.RequestUpdatesMode
- 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
- required(int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Checks that a required field has been set in a given table that has just been constructed.
- requiredCredentials(int) - Method in class io.objectbox.sync.server.SyncServerOptions
-
Credential types that are required for clients logging in.
- requiredCredentialsAsByteBuffer() - Method in class io.objectbox.sync.server.SyncServerOptions
- requiredCredentialsInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- requiredCredentialsLength() - Method in class io.objectbox.sync.server.SyncServerOptions
- requiredCredentialsVector() - Method in class io.objectbox.sync.server.SyncServerOptions
- requiredCredentialsVector(IntVector) - Method in class io.objectbox.sync.server.SyncServerOptions
- RESERVED - Static variable in class io.objectbox.model.PropertyFlags
-
Unused yet
- Reserved10 - Static variable in class io.objectbox.model.PropertyType
- Reserved3 - Static variable in class io.objectbox.model.PropertyType
- Reserved4 - Static variable in class io.objectbox.model.PropertyType
- Reserved5 - Static variable in class io.objectbox.model.PropertyType
- Reserved6 - Static variable in class io.objectbox.model.PropertyType
- Reserved7 - Static variable in class io.objectbox.model.PropertyType
- Reserved8 - Static variable in class io.objectbox.model.PropertyType
- Reserved9 - Static variable in class io.objectbox.model.PropertyType
- reset() - Method in class io.objectbox.flatbuffers.BaseVector
-
Resets the internal state with a null
ByteBufferand a zero position. - 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 (cached) objects of this list, so they will be re-loaded when accessing this list again.
- reset() - Method in class io.objectbox.Transaction
-
Will throw if Cursors are still active for this TX.
- resolvedTargetId - Variable in class io.objectbox.relation.ToOne
- resolveEagerRelation(T) - Method in class io.objectbox.query.Query
- resolveEagerRelation(T, EagerRelation<T, ?>) - Method in class io.objectbox.query.Query
- resolveEagerRelationForNonNullEagerRelations(T, int) - Method in class io.objectbox.query.Query
-
Note: no null check on eagerRelations!
- resolveEagerRelations(List<T>) - Method in class io.objectbox.query.Query
- RESULT_ARRAY - Enum constant in enum class io.objectbox.internal.Feature
-
Internal feature, not relevant if using ObjectBox through JNI.
- retainAll(Collection<?>) - Method in class io.objectbox.query.LazyList
- retainAll(Collection<?>) - Method in class io.objectbox.relation.ToMany
- returnIntArray() - Static method in class io.objectbox.internal.JniTest
- rightCondition - Variable in class io.objectbox.query.LogicQueryCondition
- rightValue - Variable in class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition
- rightValue - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition
- rightValue - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition
- rootId - Variable in class io.objectbox.tree.Tree
- run() - Method in class io.objectbox.ObjectClassPublisher
-
Processes publish requests using a single thread to prevent any data generated by observers to get stale.
- run() - Method in class io.objectbox.query.QueryPublisher
-
Processes publish requests for this query on a single thread to prevent older query results getting delivered after newer query results.
- run(RunWithParam<T>, T) - Method in interface io.objectbox.reactive.Scheduler
- run(Throwable) - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver.SchedulerRunOnError
- run(T) - Method in interface io.objectbox.reactive.RunWithParam
- run(T) - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver.SchedulerRunOnChange
- RUN_THREADING_SELF_TEST - Static variable in class io.objectbox.config.DebugFlags
-
Run a quick self-test to verify basic threading; somewhat paranoia to check the platform and the library setup.
- RUN_THREADING_SELF_TEST - Static variable in class io.objectbox.DebugFlags
-
Deprecated.Run a quick self-test to verify basic threading; somewhat paranoia to check the platform and the library setup.
- runInReadTx(Runnable) - Method in class io.objectbox.BoxStore
-
Runs the given runnable inside a read(-only) transaction.
- runInReadTx(Runnable) - Method in class io.objectbox.tree.Tree
-
Similar to
BoxStore.runInReadTx(Runnable), but allows Tree functions. - runInTx(Runnable) - Method in class io.objectbox.BoxStore
-
Runs the given runnable inside a transaction.
- runInTx(Runnable) - Method in class io.objectbox.tree.Tree
-
Similar to
BoxStore.runInTx(Runnable), but allows Tree functions. - 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
- RxBoxStore - Class in io.objectbox.rx3
-
Static methods to Rx-ify ObjectBox queries.
- RxBoxStore() - Constructor for class io.objectbox.rx3.RxBoxStore
- RxQuery - Class in io.objectbox.rx3
-
Static methods to Rx-ify ObjectBox queries.
- RxQuery() - Constructor for class io.objectbox.rx3.RxQuery
S
- scheduler - Variable in class io.objectbox.reactive.SubscriptionBuilder
- Scheduler - Interface in io.objectbox.reactive
- SchedulerRunOnChange() - Constructor for class io.objectbox.reactive.SubscriptionBuilder.ActionObserver.SchedulerRunOnChange
- schedulerRunOnData - Variable in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- schedulerRunOnError - Variable in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- SchedulerRunOnError() - Constructor for class io.objectbox.reactive.SubscriptionBuilder.ActionObserver.SchedulerRunOnError
- Schedulers - Class in io.objectbox.reactive
- Schedulers() - Constructor for class io.objectbox.reactive.Schedulers
- schemaName - Variable in class io.objectbox.ideasonly.ModelModifier.EntityModifier
- score - Variable in class io.objectbox.query.IdWithScore
- score - Variable in class io.objectbox.query.ObjectWithScore
- secondaryName(String) - Method in class io.objectbox.ModelBuilder.PropertyBuilder
- secondaryNameOffset - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- seek(long) - Method in class io.objectbox.Cursor
- seek(long) - Method in class io.objectbox.KeyValueCursor
- seekOrNext(byte[]) - Method in class io.objectbox.internal.DebugCursor
- send() - Method in interface io.objectbox.sync.ObjectsMessageBuilder
-
Sends the message, returns true if successful.
- send() - Method in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- sent - Variable in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- serialVersionUID - Static variable in class io.objectbox.Property
- serialVersionUID - Static variable in class io.objectbox.relation.ListFactory.ArrayListFactory
- serialVersionUID - Static variable in class io.objectbox.relation.ListFactory.CopyOnWriteArrayListFactory
- serialVersionUID - Static variable in class io.objectbox.relation.RelationInfo
- serialVersionUID - Static variable in class io.objectbox.relation.ToMany
- serialVersionUID - Static variable in class io.objectbox.relation.ToOne
- server - Variable in class io.objectbox.sync.SyncHybrid
- server(BoxStore, String, SyncCredentials) - Static method in class io.objectbox.sync.Sync
-
Starts building a
SyncServer. - server(BoxStore, String, SyncCredentials[]) - Static method in class io.objectbox.sync.Sync
-
Starts building a
SyncServer. - serverBuilder - Variable in class io.objectbox.sync.SyncHybridBuilder
- serverBuilder() - Method in class io.objectbox.sync.SyncHybridBuilder
-
Returns the builder of the server of the hybrid for additional configuration.
- serverUrl - Variable in class io.objectbox.sync.SyncClientImpl
- serverUrl(String) - Method in class io.objectbox.sync.SyncBuilder
-
Allows internal code to set the Sync server URL after creating this builder.
- set(int, byte) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- set(int, byte) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- set(int, byte) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Read a byte from data.
- set(int, byte[], int, int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- set(int, byte[], int, int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- set(int, byte[], int, int) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write an array of bytes into the buffer.
- 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.
- setAndUpdateTargetId(long) - Method in class io.objectbox.relation.ToOne
- setBoolean(int, boolean) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- setBoolean(int, boolean) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- setBoolean(int, boolean) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Write boolean into a given position on the buffer.
- 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
-
Sets a listener that will be called when an exception is thrown.
- setDebugFlags(int) - Method in class io.objectbox.BoxStore
- setDefault(BoxStore) - Static method in class io.objectbox.BoxStore
- setDefault(Utf8) - Static method in class io.objectbox.flatbuffers.Utf8
-
Set the default instance of the UTF-8 processor.
- setDouble(double) - Method in class io.objectbox.tree.Leaf
- setDouble(int, double) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- setDouble(int, double) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- setDouble(int, double) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Read a 64-bit float from data.
- setFloat(int, float) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- setFloat(int, float) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- setFloat(int, float) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Read a 32-bit float from data.
- setInt(int, int) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- setInt(int, int) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- setInt(int, int) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Read a 32-bit int from data.
- setInt(long) - Method in class io.objectbox.tree.Leaf
- 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
- setLoginCredentials(SyncCredentials[]) - Method in interface io.objectbox.sync.SyncClient
-
Updates the login credentials.
- setLoginCredentials(SyncCredentials[]) - Method in class io.objectbox.sync.SyncClientImpl
- setLong(int, long) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- setLong(int, long) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- setLong(int, long) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Read a 64-bit long from data.
- setObserver(SyncClient) - Method in class io.objectbox.sync.ConnectivityMonitor
- setParameter(Property<?>, boolean) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto a new value. - setParameter(Property<?>, byte[]) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto new values. - setParameter(Property<?>, double) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto a new value. - setParameter(Property<?>, float[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition for
propertyto a newvalue. - setParameter(Property<?>, int[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition for
propertyto a newvalue. - setParameter(Property<?>, long) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto a new value. - setParameter(Property<?>, long[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition for
propertyto a newvalue. - setParameter(Property<?>, String) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto a new value. - setParameter(Property<?>, String[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition for
propertyto a newvalue. - setParameter(Property<?>, Date) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto a new value. - setParameter(String, boolean) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, byte[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, double) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, float[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, int[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, long) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, long[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, String) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, String[]) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameter(String, Date) - Method in class io.objectbox.query.Query
-
Changes the parameter of the query condition with the matching
aliasto a newvalue. - setParameters(Property<?>, double, double) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto new values. - setParameters(Property<?>, int[]) - Method in class io.objectbox.query.Query
-
Deprecated.Use
Query.setParameter(Property, int[])instead. - setParameters(Property<?>, long[]) - Method in class io.objectbox.query.Query
-
Deprecated.Use
Query.setParameter(Property, long[])instead. - setParameters(Property<?>, long, long) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto new values. - setParameters(Property<?>, String[]) - Method in class io.objectbox.query.Query
-
Deprecated.Use
Query.setParameter(Property, String[])instead. - setParameters(Property<?>, String, String) - Method in class io.objectbox.query.Query
-
Sets a parameter previously given to the
QueryBuilderto new values. - setParameters(String, double, double) - Method in class io.objectbox.query.Query
-
Changes the parameters of the query condition with the matching
aliasto the new values. - setParameters(String, int[]) - Method in class io.objectbox.query.Query
-
Deprecated.Use
Query.setParameter(String, int[])instead. - setParameters(String, long[]) - Method in class io.objectbox.query.Query
-
Deprecated.Use
Query.setParameter(String, long[])instead. - setParameters(String, long, long) - Method in class io.objectbox.query.Query
-
Changes the parameters of the query condition with the matching
aliasto the new values. - setParameters(String, String[]) - Method in class io.objectbox.query.Query
-
Deprecated.Use
Query.setParameter(String, String[])instead. - setParameters(String, String, String) - Method in class io.objectbox.query.Query
-
Changes the parameters of the query condition with the matching
aliasto the new values. - setPathSeparatorRegex(String) - Method in class io.objectbox.tree.Tree
-
E.g.
- setRemoveFromTargetBox(boolean) - Method in class io.objectbox.relation.ToMany
-
On put, this also deletes removed entities from the target Box.
- setResolvedTarget(TARGET, long) - Method in class io.objectbox.relation.ToOne
-
Both values should be set (and read) "atomically" using synchronized.
- setShort(int, short) - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- setShort(int, short) - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- setShort(int, short) - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
-
Read a short from data.
- setString(String) - Method in class io.objectbox.tree.Leaf
- setStringArray(String[]) - Method in class io.objectbox.tree.Leaf
- setSubscription(DataSubscription) - Method in class io.objectbox.reactive.WeakDataObserver
- setSyncChangeListener(SyncChangeListener) - Method in interface io.objectbox.sync.server.SyncServer
-
Sets a
SyncChangeListener. - setSyncChangeListener(SyncChangeListener) - Method in class io.objectbox.sync.server.SyncServerImpl
- setSyncChangeListener(SyncChangeListener) - Method in interface io.objectbox.sync.SyncClient
-
Sets a
SyncChangeListener. - setSyncChangeListener(SyncChangeListener) - Method in class io.objectbox.sync.SyncClientImpl
- setSyncClient(BoxStore, SyncClient) - Static method in class io.objectbox.InternalAccess
- setSyncClient(SyncClient) - Method in class io.objectbox.BoxStore
- setSyncCompletedListener(SyncCompletedListener) - Method in interface io.objectbox.sync.SyncClient
-
Sets a listener to observe Sync completed events.
- setSyncCompletedListener(SyncCompletedListener) - Method in class io.objectbox.sync.SyncClientImpl
- setSyncConnectionListener(SyncConnectionListener) - Method in interface io.objectbox.sync.SyncClient
-
Sets a listener to observe Sync connection events.
- setSyncConnectionListener(SyncConnectionListener) - Method in class io.objectbox.sync.SyncClientImpl
- setSyncListener(SyncListener) - Method in interface io.objectbox.sync.SyncClient
-
Sets a listener to observe all Sync events.
- setSyncListener(SyncListener) - Method in class io.objectbox.sync.SyncClientImpl
- setSyncLoginListener(SyncLoginListener) - Method in interface io.objectbox.sync.SyncClient
-
Sets a listener to observe login events.
- setSyncLoginListener(SyncLoginListener) - Method in class io.objectbox.sync.SyncClientImpl
- setSyncTimeListener(SyncTimeListener) - Method in interface io.objectbox.sync.SyncClient
-
Sets a
SyncTimeListener. - setSyncTimeListener(SyncTimeListener) - Method in class io.objectbox.sync.SyncClientImpl
- setTarget(TARGET) - Method in class io.objectbox.relation.ToOne
-
Prepares to set the target object of this relation.
- setTargetId(long) - Method in class io.objectbox.relation.ToOne
-
Prepares to set the target of this relation to the object with the given ID.
- SHARED_GLOBAL_IDS - Static variable in class io.objectbox.model.EntityFlags
-
Makes object IDs for a synced types (SYNC_ENABLED is set) global.
- SHARED_SECRET_SIPPED - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- sharedGlobalIds() - Element in annotation interface io.objectbox.annotation.Sync
- sharedSecret(byte[]) - Static method in class io.objectbox.sync.SyncCredentials
-
Authenticate with a shared secret.
- sharedSecret(String) - Static method in class io.objectbox.sync.SyncCredentials
-
Authenticate with a shared secret.
- SharedSecret - Static variable in class io.objectbox.sync.CredentialsType
-
Deprecated, replaced by SHARED_SECRET_SIPPED
- SharedSecretSipped - Static variable in class io.objectbox.sync.CredentialsType
-
Use shared secret to create a SipHash and make attacks harder than just copyinvalid input: '&paste'.
- Short - Static variable in class io.objectbox.model.PropertyType
-
16-bit integer
- shortToUnsignedInt(short) - Static method in class io.objectbox.flatbuffers.FlexBuffers.Unsigned
- ShortVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of signed or unsigned 16-bit values.
- ShortVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of Short values (16-bit integers)
- ShortVector() - Constructor for class io.objectbox.flatbuffers.ShortVector
- shouldRestoreAsLong(FlexBuffers.Reference) - Method in class io.objectbox.converter.FlexObjectConverter
-
Returns true if the width in bytes stored in the private parentWidth field of FlexBuffers.Reference is 8.
- shouldRestoreAsLong(FlexBuffers.Reference) - Method in class io.objectbox.converter.IntegerLongMapConverter
- shouldRestoreAsLong(FlexBuffers.Reference) - Method in class io.objectbox.converter.LongLongMapConverter
- shouldRestoreAsLong(FlexBuffers.Reference) - Method in class io.objectbox.converter.StringLongMapConverter
- single - Variable in class io.objectbox.reactive.SubscriptionBuilder
- single() - Method in class io.objectbox.reactive.SubscriptionBuilder
-
Only deliver the latest data once, do not subscribe for data changes.
- single(Query<T>) - Static method in class io.objectbox.rx3.RxQuery
-
The returned Single emits one Query result as a List.
- singleThreadSequential() - Static method in class io.objectbox.reactive.Schedulers
- size - Variable in class io.objectbox.flatbuffers.FlexBuffers.Sized
- size - Variable in class io.objectbox.query.LazyList
- size() - Method in class io.objectbox.flatbuffers.FlexBuffers.KeyVector
-
Returns size of key vector
- size() - Method in class io.objectbox.flatbuffers.FlexBuffers.Sized
- size() - Method in class io.objectbox.query.LazyList
- size() - Method in class io.objectbox.relation.ToMany
- SIZE_PREFIX_LENGTH - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in a size prefix.
- Sized(ReadBuf, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Sized
- sizedByteArray() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
A utility function to copy and return the ByteBuffer data as a `byte[]`.
- sizedByteArray(int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
A utility function to copy and return the ByteBuffer data from `start` to `start` + `length` as a `byte[]`.
- sizedInputStream() - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
A utility function to return an InputStream to the ByteBuffer data
- SIZEOF_BYTE - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in an `byte`.
- SIZEOF_DOUBLE - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in an `double`.
- SIZEOF_FLOAT - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in an `float`.
- SIZEOF_INT - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in an `int`.
- SIZEOF_LONG - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in an `long`.
- SIZEOF_SHORT - Static variable in class io.objectbox.flatbuffers.Constants
-
The number of bytes in a `short`.
- sizeOnDisk() - Method in class io.objectbox.BoxStore
-
Deprecated.Use
BoxStore.getDbSize()orBoxStore.getDbSizeOnDisk()instead which properly handle in-memory databases. - skipReadSchema - Variable in class io.objectbox.BoxStoreBuilder
-
For DebugCursor.
- skipReadSchema() - Method in class io.objectbox.config.FlatStoreOptions
-
Advanced setting meant only for special scenarios: opens the database in a limited, schema-less mode.
- slot(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Set the current vtable at `voffset` to the current location in the buffer.
- 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 object ID).
- sortTables(int[], ByteBuffer) - Method in class io.objectbox.flatbuffers.Table
-
Sort tables by the key.
- sourceInfo - Variable in class io.objectbox.relation.RelationInfo
- space - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- stack - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- 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
- startAuthenticationMethodsVector(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- startBytesVector(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.Credentials
- startClusterPeerConfig(FlatBufferBuilder) - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- startClusterPeersVector(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- startCredentials(FlatBufferBuilder) - Static method in class io.objectbox.sync.Credentials
- started - Variable in class io.objectbox.sync.SyncClientImpl
- STARTED - Enum constant in enum class io.objectbox.sync.SyncState
- startEntitiesVector(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- startFlatStoreOptions(FlatBufferBuilder) - Static method in class io.objectbox.config.FlatStoreOptions
- startHashVector(FlatBufferBuilder, int) - Static method in class io.objectbox.model.Model
- startHnswParams(FlatBufferBuilder) - Static method in class io.objectbox.model.HnswParams
- startJwtConfig(FlatBufferBuilder) - Static method in class io.objectbox.sync.server.JwtConfig
- startMap() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Start a new map in the buffer.
- startModel(FlatBufferBuilder) - Static method in class io.objectbox.model.Model
- startModelBytesVector(FlatBufferBuilder, int) - Static method in class io.objectbox.config.FlatStoreOptions
- startModelEntity(FlatBufferBuilder) - Static method in class io.objectbox.model.ModelEntity
- startModelProperty(FlatBufferBuilder) - Static method in class io.objectbox.model.ModelProperty
- startModelRelation(FlatBufferBuilder) - Static method in class io.objectbox.model.ModelRelation
- startObjectBrowser() - Method in class io.objectbox.BoxStore
- startObjectBrowser(int) - Method in class io.objectbox.BoxStore
- startObjectBrowser(String) - Method in class io.objectbox.BoxStore
- startObjectsMessage(long, String) - Method in interface io.objectbox.sync.SyncClient
-
Experimental.
- startObjectsMessage(long, String) - Method in class io.objectbox.sync.SyncClientImpl
- startPropertiesVector(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- startRelationsVector(FlatBufferBuilder, int) - Static method in class io.objectbox.model.ModelEntity
- startRequiredCredentialsVector(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.server.SyncServerOptions
- STARTS_WITH - Enum constant in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
- startStringsVector(FlatBufferBuilder, int) - Static method in class io.objectbox.sync.Credentials
- startsWith(Property<T>, String, QueryBuilder.StringOrder) - Method in class io.objectbox.query.QueryBuilder
-
Note: New code should use the
new query API. - startsWith(String) - Method in class io.objectbox.Property
-
Creates a starts with condition using
StringOrder#CASE_SENSITIVE. - startsWith(String, QueryBuilder.StringOrder) - Method in class io.objectbox.Property
- startSyncServerOptions(FlatBufferBuilder) - Static method in class io.objectbox.sync.server.SyncServerOptions
- startTable(int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Start encoding a new object in the buffer.
- startVector() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
-
Start a new vector in the buffer.
- startVector(int, int, int) - Method in class io.objectbox.flatbuffers.FlatBufferBuilder
-
Start a new array/vector of objects.
- 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
- stop() - Method in class io.objectbox.sync.SyncHybrid
-
Stops the client and server.
- stopObjectBrowser() - Method in class io.objectbox.BoxStore
- STOPPED - Enum constant in enum class io.objectbox.sync.SyncState
- store - Variable in class io.objectbox.Box
- store - Variable in class io.objectbox.query.Query
- store - Variable in class io.objectbox.sync.SyncHybrid
- store - Variable in class io.objectbox.Transaction
- store - Variable in class io.objectbox.tree.Tree
- storedPackedType() - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- storedPackedType(int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- storedWidth(int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- storeHandle - Variable in class io.objectbox.query.QueryBuilder
- storeServer - Variable in class io.objectbox.sync.SyncHybrid
- String - Static variable in class io.objectbox.model.PropertyType
-
UTF-8 encoded string (variable length)
- string_pool - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- StringArrayCondition(Property<T>, PropertyQueryConditionImpl.StringArrayCondition.Operation, String[]) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition
- StringArrayCondition(Property<T>, PropertyQueryConditionImpl.StringArrayCondition.Operation, String[], QueryBuilder.StringOrder) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition
- StringCondition(Property<T>, PropertyQueryConditionImpl.StringCondition.Operation, String) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.StringCondition
- StringCondition(Property<T>, PropertyQueryConditionImpl.StringCondition.Operation, String, QueryBuilder.StringOrder) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.StringCondition
- StringFlexMapConverter - Class in io.objectbox.converter
- StringFlexMapConverter() - Constructor for class io.objectbox.converter.StringFlexMapConverter
- StringLongMapConverter - Class in io.objectbox.converter
-
Like
StringFlexMapConverter, but always restores integer map values asLong. - StringLongMapConverter() - Constructor for class io.objectbox.converter.StringLongMapConverter
- StringMapConverter - Class in io.objectbox.converter
-
Converts a String map entity property to a byte array database value using FlexBuffers.
- StringMapConverter() - Constructor for class io.objectbox.converter.StringMapConverter
- StringOrder() - Constructor for enum class io.objectbox.query.QueryBuilder.StringOrder
- stringPool - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- strings(int) - Method in class io.objectbox.sync.Credentials
-
Credentials provided by a string array.
- stringsLength() - Method in class io.objectbox.sync.Credentials
- StringStringCondition(Property<T>, PropertyQueryConditionImpl.StringStringCondition.Operation, String, String, QueryBuilder.StringOrder) - Constructor for class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition
- stringsVector() - Method in class io.objectbox.sync.Credentials
- stringsVector(StringVector) - Method in class io.objectbox.sync.Credentials
- StringVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of String.
- StringVector - Static variable in class io.objectbox.model.PropertyType
-
Variable sized vector of String values (UTF-8 encoded strings).
- StringVector() - Constructor for class io.objectbox.flatbuffers.StringVector
- Struct - Class in io.objectbox.flatbuffers
-
All structs in the generated code derive from this class, and add their own accessors.
- Struct() - Constructor for class io.objectbox.flatbuffers.Struct
- 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
DataObservercan be subscribed to data changes using the returned builder. - subscribe() - Method in class io.objectbox.query.Query
-
A
DataObservercan be subscribed to data changes using the returned builder. - subscribe(DataObserver<Class>, Object) - Method in class io.objectbox.ObjectClassPublisher
- subscribe(DataObserver<List<T>>, Object) - Method in class io.objectbox.query.QueryPublisher
- subscribe(DataObserver<T>, Object) - Method in interface io.objectbox.reactive.DataPublisher
- subscribe(DataSubscriptionList) - Method in class io.objectbox.query.Query
-
Convenience for
Query.subscribe()with a subsequent call toSubscriptionBuilder.dataSubscriptionList(DataSubscriptionList). - subscribe(Class<T>) - Method in class io.objectbox.BoxStore
-
Like
BoxStore.subscribe(), but wires the supplied @DataObserveronly to the given object class for notifications. - SUBSCRIBED_OBSERVERS - Variable in class io.objectbox.query.QueryPublisher
-
Placeholder observer to use if all subscribed observers should be notified.
- SubscribedObservers() - Constructor for class io.objectbox.query.QueryPublisher.SubscribedObservers
- subscription - Variable in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
- subscription - Variable in class io.objectbox.reactive.WeakDataObserver
- SubscriptionBuilder<T> - Class in io.objectbox.reactive
- SubscriptionBuilder(DataPublisher<T>, Object) - Constructor for class io.objectbox.reactive.SubscriptionBuilder
- SubscriptionBuilder.ActionObserver - Class in io.objectbox.reactive
-
Wraps a
DataObserversupplied toSubscriptionBuilder.observer(DataObserver)to support result transformation, an error observer or scheduler for result delivery. - SubscriptionBuilder.ActionObserver.SchedulerRunOnChange - Class in io.objectbox.reactive
- SubscriptionBuilder.ActionObserver.SchedulerRunOnError - Class in io.objectbox.reactive
- subscriptions - Variable in class io.objectbox.reactive.DataSubscriptionList
- 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
-
ObjectBox Sync makes data available on other devices.
- Sync - Annotation Interface in io.objectbox.annotation
-
Enables sync for an
Entityclass. - Sync() - Constructor for class io.objectbox.sync.Sync
- SYNC - Enum constant in enum class io.objectbox.internal.Feature
-
Sync client availability.
- SYNC_ENABLED - Static variable in class io.objectbox.model.EntityFlags
-
Enable "data synchronization" for this entity type: objects will be synced with other stores over the network.
- SYNC_SERVER - Enum constant in enum class io.objectbox.internal.Feature
-
Embedded Sync server availability.
- SyncBuilder - Class in io.objectbox.sync
-
A builder to create a
SyncClient; the builder itself should be created viaSync.client(BoxStore, String, SyncCredentials). - SyncBuilder(BoxStore, SyncCredentials) - Constructor for class io.objectbox.sync.SyncBuilder
- SyncBuilder(BoxStore, SyncCredentials[]) - Constructor for class io.objectbox.sync.SyncBuilder
- SyncBuilder(BoxStore, String, SyncCredentials) - Constructor for class io.objectbox.sync.SyncBuilder
- SyncBuilder(BoxStore, String, SyncCredentials[]) - Constructor for class io.objectbox.sync.SyncBuilder
- SyncBuilder.RequestUpdatesMode - Enum Class in io.objectbox.sync
- SyncChange - Class in io.objectbox.sync
-
A collection of changes made to one entity type during a sync transaction.
- SyncChange(int, long[], long[]) - Constructor for class io.objectbox.sync.SyncChange
- SyncChange(long, long[], long[]) - Constructor for class io.objectbox.sync.SyncChange
-
Deprecated.
- syncChangeListener - Variable in class io.objectbox.sync.server.SyncServerImpl
-
Protects listener instance from garbage collection.
- SyncChangeListener - Interface in io.objectbox.sync.listener
-
Notifies of fine granular changes on the object level happening during sync.
- syncClient - Variable in class io.objectbox.BoxStore
-
Keeps a reference so the library user does not have to.
- syncClient - Variable in class io.objectbox.sync.ConnectivityMonitor
- syncClient - Variable in class io.objectbox.sync.SyncClientImpl.ObjectsMessageBuilderImpl
- SyncClient - Interface in io.objectbox.sync
-
ObjectBox sync client.
- SyncClientImpl - Class in io.objectbox.sync
-
Internal sync client implementation.
- SyncClientImpl(SyncBuilder) - Constructor for class io.objectbox.sync.SyncClientImpl
- SyncClientImpl.InternalSyncClientListener - Class in io.objectbox.sync
-
Methods on this class must match those expected by JNI implementation.
- SyncClientImpl.ObjectsMessageBuilderImpl - Class in io.objectbox.sync
- SyncCompletedListener - Interface in io.objectbox.sync.listener
-
Listens to sync completed events.
- SyncConnectionListener - Interface in io.objectbox.sync.listener
-
Listens to sync connection events.
- SyncCredentials - Class in io.objectbox.sync
-
Use the static helper methods to build Sync credentials, for example
SyncCredentials.sharedSecret("secret"). - SyncCredentials(SyncCredentials.CredentialsType) - Constructor for class io.objectbox.sync.SyncCredentials
- SyncCredentials.CredentialsType - Enum Class in io.objectbox.sync
- SyncCredentialsToken - Class in io.objectbox.sync
-
Internal credentials implementation.
- SyncCredentialsToken(SyncCredentials.CredentialsType) - Constructor for class io.objectbox.sync.SyncCredentialsToken
- SyncCredentialsToken(SyncCredentials.CredentialsType, byte[]) - Constructor for class io.objectbox.sync.SyncCredentialsToken
- SyncCredentialsToken(SyncCredentials.CredentialsType, String) - Constructor for class io.objectbox.sync.SyncCredentialsToken
- SyncCredentialsUserPassword - Class in io.objectbox.sync
-
Internal credentials implementation for user and password authentication.
- SyncCredentialsUserPassword(SyncCredentials.CredentialsType, String, String) - Constructor for class io.objectbox.sync.SyncCredentialsUserPassword
- syncFlags - Variable in class io.objectbox.sync.server.SyncServerBuilder
- syncFlags() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Bit flags to configure the Sync Server that are also shared with Sync clients.
- syncFlags(int) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets bit flags to adjust Sync behavior, like additional logging.
- SyncFlags - Class in io.objectbox.sync
-
Flags to adjust sync behavior like additional logging.
- SyncFlags() - Constructor for class io.objectbox.sync.SyncFlags
- SyncHybrid - Class in io.objectbox.sync
-
Combines the functionality of a Sync client and a Sync server.
- SyncHybrid(BoxStore, SyncClient, BoxStore, SyncServer) - Constructor for class io.objectbox.sync.SyncHybrid
- SyncHybridBuilder - Class in io.objectbox.sync
-
Builder for a Sync client and server hybrid setup, a
SyncHybrid. - SyncHybridBuilder(BoxStoreBuilder, String, SyncCredentials) - Constructor for class io.objectbox.sync.SyncHybridBuilder
-
Internal API; use
Sync.hybrid(BoxStoreBuilder, String, SyncCredentials)instead. - SyncListener - Interface in io.objectbox.sync.listener
-
This listener has callback methods invoked by all fundamental synchronization events.
- SyncLoginCodes - Class in io.objectbox.sync
-
Codes used by
SyncLoginListener.onLoginFailed(long). - SyncLoginCodes() - Constructor for class io.objectbox.sync.SyncLoginCodes
- SyncLoginListener - Interface in io.objectbox.sync.listener
-
Listens to login events.
- SyncServer - Interface in io.objectbox.sync.server
-
ObjectBox sync server.
- SyncServerBuilder - Class in io.objectbox.sync.server
-
Creates a
SyncServerand allows to set additional configuration. - SyncServerBuilder(BoxStore, String, SyncCredentials) - Constructor for class io.objectbox.sync.server.SyncServerBuilder
-
Use
Sync.server(BoxStore, String, SyncCredentials)instead. - SyncServerBuilder(BoxStore, String, SyncCredentials[]) - Constructor for class io.objectbox.sync.server.SyncServerBuilder
-
Use
Sync.server(BoxStore, String, SyncCredentials)instead. - syncServerFlags - Variable in class io.objectbox.sync.server.SyncServerBuilder
- syncServerFlags() - Method in class io.objectbox.sync.server.SyncServerOptions
-
Bit flags to configure the Sync Server.
- syncServerFlags(int) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets bit flags to configure the Sync server.
- SyncServerFlags - Class in io.objectbox.sync.server
-
Bit flags to configure the Sync Server.
- SyncServerFlags() - Constructor for class io.objectbox.sync.server.SyncServerFlags
- SyncServerImpl - Class in io.objectbox.sync.server
-
Internal sync server implementation.
- SyncServerImpl(SyncServerBuilder) - Constructor for class io.objectbox.sync.server.SyncServerImpl
- SyncServerOptions - Class in io.objectbox.sync.server
-
The Sync server configuration used to configure a starting Sync Server.
- SyncServerOptions() - Constructor for class io.objectbox.sync.server.SyncServerOptions
- SyncServerOptions.Vector - Class in io.objectbox.sync.server
- SyncState - Enum Class in io.objectbox.sync
-
Returned by
SyncClientImpl.getSyncState(). - SyncState(int) - Constructor for enum class io.objectbox.sync.SyncState
- SyncTimeListener - Interface in io.objectbox.sync.listener
- sysProcMeminfoKb(String) - Static method in class io.objectbox.BoxStore
-
Linux only: extracts a kB value from /proc/meminfo (system wide memory information).
- sysProcStatusKb(String) - Static method in class io.objectbox.BoxStore
-
Linux only: extracts a kB value from /proc/self/status (process specific information).
T
- Table - Class in io.objectbox.flatbuffers
-
All tables in the generated code derive from this class, and add their own accessors.
- Table() - Constructor for class io.objectbox.flatbuffers.Table
- target - Variable in class io.objectbox.relation.ToOne
-
Resolved target entity is cached
- targetBox - Variable in class io.objectbox.relation.ToMany
- targetBox - Variable in class io.objectbox.relation.ToOne
- targetEntity() - Method in class io.objectbox.model.ModelProperty
-
For relations only: name of the target entity (will be replaced by "target entity ID" at the schema level)
- targetEntityAsByteBuffer() - Method in class io.objectbox.model.ModelProperty
- targetEntityId() - Method in class io.objectbox.model.ModelRelation
- targetEntityId(IdUid) - Method in class io.objectbox.model.ModelRelation
- targetEntityInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelProperty
- targetEntityOffset - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- targetId - Variable in class io.objectbox.relation.ToOne
- targetIdField - Variable in class io.objectbox.relation.ToOne
- targetIdProperty - Variable in class io.objectbox.relation.RelationInfo
-
For relations based on a target ID property (null otherwise).
- TargetIdProperty - Annotation Interface 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).
- threadCount - Variable in class io.objectbox.internal.ObjectBoxThreadPool.ObjectBoxThreadFactory
- threadLocalReader - Variable in class io.objectbox.Box
- threadPool - Variable in class io.objectbox.BoxStore
- TIME_SERIES - Enum constant in enum class io.objectbox.internal.Feature
-
TimeSeries support (date/date-nano companion ID and other time-series functionality).
- timeListener - Variable in class io.objectbox.sync.SyncBuilder
- timeListener - Variable in class io.objectbox.sync.SyncClientImpl
- timeListener(SyncTimeListener) - Method in class io.objectbox.sync.SyncBuilder
-
Sets a listener to only observe Sync time events.
- to() - Element in annotation interface 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
- token - Variable in class io.objectbox.sync.SyncCredentialsToken
- ToMany<TARGET> - Class in io.objectbox.relation
-
A to-many relation of an entity that references multiple objects of a
ToManyentity. - ToMany(Object, RelationInfo<?, TARGET>) - Constructor for class io.objectbox.relation.ToMany
- toManyGetter - Variable in class io.objectbox.relation.RelationInfo
-
Only set for ToMany relations
- ToManyGetter<SOURCE,
TARGET> - Interface in io.objectbox.internal - ToOne<TARGET> - Class in io.objectbox.relation
-
A to-one relation of an entity that references one object of a
ToOneentity. - ToOne(Object, RelationInfo<?, TARGET>) - 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
- ToOneGetter<SOURCE,
TARGET> - Interface in io.objectbox.internal - toString() - Method in class io.objectbox.Cursor
- toString() - Method in exception class io.objectbox.exception.DbException
- toString() - Method in class io.objectbox.flatbuffers.FlexBuffers.Blob
-
Returns a text(JSON) representation of the
FlexBuffers.Blob - toString() - Method in class io.objectbox.flatbuffers.FlexBuffers.Key
- toString() - Method in class io.objectbox.flatbuffers.FlexBuffers.KeyVector
-
Returns a text(JSON) representation
- toString() - Method in class io.objectbox.flatbuffers.FlexBuffers.Object
- toString() - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Returns text representation of the element (JSON)
- toString() - Method in class io.objectbox.Property
- toString() - Method in class io.objectbox.relation.RelationInfo
- toString() - Method in class io.objectbox.Transaction
- toString(StringBuilder) - Method in class io.objectbox.flatbuffers.FlexBuffers.Blob
-
Append a text(JSON) representation of the
FlexBuffers.Blobinto a `StringBuilder` - toString(StringBuilder) - Method in class io.objectbox.flatbuffers.FlexBuffers.Key
-
Appends a text(JSON) representation to a `StringBuilder`
- toString(StringBuilder) - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
-
Writes text (json) representation of map in a
StringBuilder. - toString(StringBuilder) - Method in class io.objectbox.flatbuffers.FlexBuffers.Object
- toString(StringBuilder) - Method in class io.objectbox.flatbuffers.FlexBuffers.Reference
-
Appends a text(JSON) representation to a `StringBuilder`
- toString(StringBuilder) - Method in class io.objectbox.flatbuffers.FlexBuffers.Vector
-
Appends a text(JSON) representation to a `StringBuilder`
- toTypedVector(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
-
Return a vector type our of a original element type
- toTypedVectorElementType(int) - Static method in class io.objectbox.flatbuffers.FlexBuffers
- TRACK_CREATION_STACK - Static variable in class io.objectbox.Cursor
-
May be set by tests
- TRACK_CREATION_STACK - Static variable in class io.objectbox.Transaction
-
May be set by tests
- trackAdd(Collection<? extends TARGET>) - Method in class io.objectbox.relation.ToMany
-
Must be called from a synchronized method
- trackAdd(TARGET) - Method in class io.objectbox.relation.ToMany
-
Must be called from a synchronized method
- trackRemove(TARGET) - Method in class io.objectbox.relation.ToMany
-
Must be called from a synchronized method
- trailingByteValue(byte) - Static method in class io.objectbox.flatbuffers.Utf8.DecodeUtil
-
Returns the actual value of the trailing byte (removes the prefix '10') for composition.
- transaction - Variable in class io.objectbox.Transaction
- Transaction - Class in io.objectbox
- Transaction(BoxStore, long, int) - Constructor for class io.objectbox.Transaction
- transactions - Variable in class io.objectbox.BoxStore
- 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 some other type.
- transformAndContinue(T) - Method in class io.objectbox.reactive.SubscriptionBuilder.ActionObserver
-
Runs on the thread of the
SubscriptionBuilder.ActionObserver.onData(Object)caller to ensure data is delivered in the same order asSubscriptionBuilder.ActionObserver.onData(Object)was called, to prevent delivering stale data. - transformer - Variable in class io.objectbox.reactive.SubscriptionBuilder
- Transient - Annotation Interface in io.objectbox.annotation
-
Transient fields are not persisted in the database.
- tree - Variable in class io.objectbox.tree.Branch
- Tree - Class in io.objectbox.tree
-
A higher level tree API operating on branch and leaf nodes.
- Tree(BoxStore, long) - Constructor for class io.objectbox.tree.Tree
-
Create a tree instance for the given data-branch root ID.
- Tree(BoxStore, String) - Constructor for class io.objectbox.tree.Tree
-
Create a tree instance for the given meta-branch root
uid, or find a singular root if 0 is given. - TreeOptionFlags - Class in io.objectbox.config
-
Options flags for trees.
- TreeOptionFlags() - Constructor for class io.objectbox.config.TreeOptionFlags
- TREES - Enum constant in enum class io.objectbox.internal.Feature
-
Trees invalid input: '&' GraphQL support
- trustedCertificates(String[]) - Method in class io.objectbox.sync.SyncBuilder
-
Configures a custom set of directory or file paths to search for trusted certificates in.
- trustedCertPaths - Variable in class io.objectbox.sync.SyncBuilder
- tx - Variable in class io.objectbox.Cursor
- tx - Variable in class io.objectbox.internal.DebugCursor
- TX_VIOLATED_UNIQUE - Static variable in class io.objectbox.sync.SyncLoginCodes
- TxCallback<T> - Interface in io.objectbox
-
Callback to be used for
BoxStore.runInTxAsync(Runnable, TxCallback)andBoxStore.callInTxAsync(Callable, TxCallback). - txCommitCountLock - Variable in class io.objectbox.BoxStore
- txCommitted(Transaction) - Method in class io.objectbox.Box
- txCommitted(Transaction, int[]) - Method in class io.objectbox.BoxStore
- txFinished(T, Throwable) - Method in interface io.objectbox.TxCallback
-
Called when an asynchronous transaction finished.
- type - Variable in class io.objectbox.flatbuffers.FlexBuffers.Reference
- type - Variable in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- type - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- type - Variable in class io.objectbox.Property
-
One of the supported types to be mapped to the DB.
- type - Variable in class io.objectbox.sync.SyncCredentials
- type() - Element in annotation interface io.objectbox.annotation.Index
-
Sets the
IndexType, defaults toIndexType.DEFAULT. - type() - Method in class io.objectbox.model.ModelProperty
- type() - Method in class io.objectbox.sync.Credentials
- Type - Annotation Interface in io.objectbox.annotation
-
Use on a property to override how its value is stored and interpreted in the database.
- TypedVector(ReadBuf, int, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.TypedVector
U
- uid - Variable in class io.objectbox.ModelBuilder.EntityBuilder
- uid - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- uid() - Method in class io.objectbox.model.IdUid
-
Unique ID (within the model) used to verify external managed IDs.
- Uid - Annotation Interface in io.objectbox.annotation
-
UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
- uInt16(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- uInt32(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- uInt64(int, long) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- uInt8(int, int) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- uncommittedAcks - Variable in class io.objectbox.sync.SyncBuilder
- uncommittedAcks() - Method in class io.objectbox.sync.SyncBuilder
-
Turns on sending of uncommitted acks.
- UnionVector - Class in io.objectbox.flatbuffers
-
Helper type for accessing vector of unions.
- UnionVector() - Constructor for class io.objectbox.flatbuffers.UnionVector
- unique - Variable in class io.objectbox.query.PropertyQuery
- unique() - Method in class io.objectbox.query.PropertyQuery
-
For find methods returning single values, e.g.
- Unique - Annotation Interface 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.
- UNIQUE - Static variable in class io.objectbox.model.PropertyFlags
-
Unique index
- UNIQUE_ON_CONFLICT_REPLACE - Static variable in class io.objectbox.model.PropertyFlags
-
Unique on-conflict strategy: the object being put replaces any existing conflicting object (deletes it).
- UniqueViolationException - Exception Class in io.objectbox.exception
-
Thrown when a @
Uniqueconstraint would be violated during a put operation. - UniqueViolationException(String) - Constructor for exception class io.objectbox.exception.UniqueViolationException
- Unknown - Static variable in class io.objectbox.config.ValidateOnOpenModeKv
-
Not a real type, just best practice (e.g.
- Unknown - Static variable in class io.objectbox.config.ValidateOnOpenModePages
-
Not a real type, just best practice (e.g.
- Unknown - Static variable in class io.objectbox.model.HnswDistanceType
-
Not a real type, just best practice (e.g.
- Unknown - Static variable in class io.objectbox.model.PropertyType
-
Not a real type, just best practice (e.g.
- Unknown - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.Not a real type, just best practice (e.g.
- UNKNOWN - Enum constant in enum class io.objectbox.sync.SyncState
- UNKNOWN - Static variable in class io.objectbox.sync.SyncLoginCodes
- UnpairedSurrogateException(int, int) - Constructor for exception class io.objectbox.flatbuffers.Utf8.UnpairedSurrogateException
- UnpairedSurrogateException(int, int) - Constructor for exception class io.objectbox.flatbuffers.Utf8Safe.UnpairedSurrogateException
- unregisterTransaction(Transaction) - Method in class io.objectbox.BoxStore
- Unsigned - Annotation Interface in io.objectbox.annotation
-
Indicates that values of an integer property (e.g.
- Unsigned() - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Unsigned
- UNSIGNED - Static variable in class io.objectbox.model.PropertyFlags
-
Unused yet: While our default are signed ints, queries and indexes need do know signing info.
- 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<Class>, int) - Method in class io.objectbox.ObjectClassPublisher
- unsubscribe(DataObserver<Class>, Object) - Method in class io.objectbox.ObjectClassPublisher
-
Removes the given observer from all object classes it added itself to earlier (forClass == null).
- unsubscribe(DataObserver<List<T>>, Object) - Method in class io.objectbox.query.QueryPublisher
- unsubscribe(DataObserver<T>, Object) - Method in interface io.objectbox.reactive.DataPublisher
- updateModel(ModelModifier, long, long) - Method in interface io.objectbox.ideasonly.ModelUpdate
- url - Variable in class io.objectbox.sync.server.ClusterPeerInfo
- url - Variable in class io.objectbox.sync.server.SyncServerBuilder
- url - Variable in class io.objectbox.sync.server.SyncServerImpl
- url - Variable in class io.objectbox.sync.SyncBuilder
- url() - Method in class io.objectbox.sync.server.ClusterPeerConfig
- url() - Method in class io.objectbox.sync.server.SyncServerOptions
-
URL of this Sync Server on which the Sync protocol is exposed (where the server "binds" to).
- urlAsByteBuffer() - Method in class io.objectbox.sync.server.ClusterPeerConfig
- urlAsByteBuffer() - Method in class io.objectbox.sync.server.SyncServerOptions
- urlInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.ClusterPeerConfig
- urlInByteBuffer(ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- USE_NO_ARG_CONSTRUCTOR - Static variable in class io.objectbox.model.EntityFlags
-
Use the default (no arguments) constructor to create entities
- useNoArgConstructor() - Element in annotation interface io.objectbox.annotation.Entity
-
Use a no-arg constructor instead of an all properties constructor (generated).
- usePreviousCommit - Variable in class io.objectbox.BoxStoreBuilder
- usePreviousCommit() - Method in class io.objectbox.BoxStoreBuilder
-
Ignores the latest data snapshot (committed transaction state) and uses the previous snapshot instead.
- usePreviousCommit() - Method in class io.objectbox.config.FlatStoreOptions
-
Advanced setting recommended to be used together with read-only mode to ensure no data is lost.
- usePreviousCommitOnValidationFailure() - Method in class io.objectbox.config.FlatStoreOptions
-
NOT IMPLEMENTED YET.
- USER_PASSWORD - Enum constant in enum class io.objectbox.sync.SyncCredentials.CredentialsType
- userAndPassword(String, String) - Static method in class io.objectbox.sync.SyncCredentials
-
Generic credential type suitable for ObjectBox admin (and possibly others in the future)
- username - Variable in class io.objectbox.sync.SyncCredentialsUserPassword
- UserPassword - Static variable in class io.objectbox.sync.CredentialsType
-
Generic credential type suitable for ObjectBox admin (and possibly others in the future)
- utf8 - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- utf8 - Variable in class io.objectbox.flatbuffers.StringVector
- utf8 - Variable in class io.objectbox.flatbuffers.Table
- Utf8 - Class in io.objectbox.flatbuffers
- Utf8() - Constructor for class io.objectbox.flatbuffers.Utf8
- Utf8.DecodeUtil - Class in io.objectbox.flatbuffers
-
Utility methods for decoding bytes into
String. - Utf8.UnpairedSurrogateException - Exception Class in io.objectbox.flatbuffers
- Utf8Old - Class in io.objectbox.flatbuffers
-
This class implements the Utf8 API using the Java Utf8 encoder.
- Utf8Old() - Constructor for class io.objectbox.flatbuffers.Utf8Old
- Utf8Old.Cache - Class in io.objectbox.flatbuffers
- Utf8Safe - Class in io.objectbox.flatbuffers
-
A set of low-level, high-performance static utility methods related to the UTF-8 character encoding.
- Utf8Safe() - Constructor for class io.objectbox.flatbuffers.Utf8Safe
- Utf8Safe.UnpairedSurrogateException - Exception Class in io.objectbox.flatbuffers
V
- validate(long, boolean) - Method in class io.objectbox.BoxStore
-
Validate database pages, a lower level storage unit (integrity check).
- validateOnOpen(short) - Method in class io.objectbox.BoxStoreBuilder
-
When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
- validateOnOpenKv() - Method in class io.objectbox.BoxStoreBuilder
-
When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
- validateOnOpenKv() - Method in class io.objectbox.config.FlatStoreOptions
-
When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
- validateOnOpenKv(short) - Method in class io.objectbox.BoxStoreBuilder
-
When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
- ValidateOnOpenMode - Class in io.objectbox.model
-
Deprecated.This class has moved to the config package, use
ValidateOnOpenModePagesinstead. - ValidateOnOpenMode() - Constructor for class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.
- validateOnOpenModeKv - Variable in class io.objectbox.BoxStoreBuilder
- ValidateOnOpenModeKv - Class in io.objectbox.config
-
Defines if and how the database is checked for valid key/value (KV) entries when opening it.
- ValidateOnOpenModeKv() - Constructor for class io.objectbox.config.ValidateOnOpenModeKv
- validateOnOpenModePages - Variable in class io.objectbox.BoxStoreBuilder
- ValidateOnOpenModePages - Class in io.objectbox.config
-
Defines if and how the database is checked for structural consistency (pages) when opening it.
- ValidateOnOpenModePages() - Constructor for class io.objectbox.config.ValidateOnOpenModePages
- validateOnOpenPageLimit - Variable in class io.objectbox.BoxStoreBuilder
- validateOnOpenPageLimit() - Method in class io.objectbox.config.FlatStoreOptions
-
To fine-tune database validation, you can specify a limit on how much data is looked at.
- validateOnOpenPageLimit(long) - Method in class io.objectbox.BoxStoreBuilder
-
To fine-tune
BoxStoreBuilder.validateOnOpen(short), you can specify a limit on how much data is looked at. - validateOnOpenPages() - Method in class io.objectbox.config.FlatStoreOptions
-
When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
- ValidateVersion() - Static method in class io.objectbox.config.FlatStoreOptions
- ValidateVersion() - Static method in class io.objectbox.model.HnswParams
- ValidateVersion() - Static method in class io.objectbox.model.Model
- ValidateVersion() - Static method in class io.objectbox.model.ModelEntity
- ValidateVersion() - Static method in class io.objectbox.model.ModelProperty
- ValidateVersion() - Static method in class io.objectbox.model.ModelRelation
- ValidateVersion() - Static method in class io.objectbox.sync.Credentials
- ValidateVersion() - Static method in class io.objectbox.sync.server.ClusterPeerConfig
- ValidateVersion() - Static method in class io.objectbox.sync.server.JwtConfig
- ValidateVersion() - Static method in class io.objectbox.sync.server.SyncServerOptions
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.LongCondition
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition
- value - Variable in class io.objectbox.query.PropertyQueryConditionImpl.StringCondition
- value() - Element in annotation interface io.objectbox.annotation.DefaultValue
- value() - Element in annotation interface io.objectbox.annotation.NameInDb
-
Name used in the database.
- value() - Element in annotation interface io.objectbox.annotation.OrderBy
-
Comma-separated list of properties, e.g.
- value() - Element in annotation interface io.objectbox.annotation.TargetIdProperty
-
Name used in the database.
- value() - Element in annotation interface io.objectbox.annotation.Type
- value() - Element in annotation interface io.objectbox.annotation.Uid
-
The UID associated with an entity/property.
- Value(int, int, int, double) - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- Value(int, int, int, long) - Constructor for class io.objectbox.flatbuffers.FlexBuffersBuilder.Value
- VALUE - Enum constant in enum class io.objectbox.annotation.IndexType
-
Use the property value to build the index.
- valueOf(String) - Static method in enum class io.objectbox.annotation.ConflictStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.annotation.DatabaseType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.annotation.IndexType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.annotation.VectorDistanceType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.internal.Feature
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.NullCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition.Operation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.QueryBuilder.Operator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.query.QueryBuilder.StringOrder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.sync.SyncBuilder.RequestUpdatesMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.sync.SyncCredentials.CredentialsType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.objectbox.sync.SyncState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.objectbox.annotation.ConflictStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.annotation.DatabaseType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.annotation.IndexType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.annotation.VectorDistanceType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class io.objectbox.flatbuffers.FlexBuffers.Map
- values() - Static method in enum class io.objectbox.internal.Feature
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.ByteArrayCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.DoubleDoubleCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.IntArrayCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.LongArrayCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.LongCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.LongLongCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.NullCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.StringArrayCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.StringCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.PropertyQueryConditionImpl.StringStringCondition.Operation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.QueryBuilder.Operator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.query.QueryBuilder.StringOrder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.sync.SyncBuilder.RequestUpdatesMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.sync.SyncCredentials.CredentialsType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.objectbox.sync.SyncState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- valueType - Variable in class io.objectbox.tree.LeafNode
-
See
PropertyTypefor values. - vec - Variable in class io.objectbox.flatbuffers.FlexBuffers.KeyVector
- vector - Variable in class io.objectbox.flatbuffers.BaseVector
-
Used to hold the vector data position.
- Vector() - Constructor for class io.objectbox.config.FlatStoreOptions.Vector
- Vector() - Constructor for class io.objectbox.model.HnswParams.Vector
- Vector() - Constructor for class io.objectbox.model.IdUid.Vector
- Vector() - Constructor for class io.objectbox.model.Model.Vector
- Vector() - Constructor for class io.objectbox.model.ModelEntity.Vector
- Vector() - Constructor for class io.objectbox.model.ModelProperty.Vector
- Vector() - Constructor for class io.objectbox.model.ModelRelation.Vector
- Vector() - Constructor for class io.objectbox.sync.Credentials.Vector
- Vector() - Constructor for class io.objectbox.sync.server.ClusterPeerConfig.Vector
- Vector() - Constructor for class io.objectbox.sync.server.JwtConfig.Vector
- Vector() - Constructor for class io.objectbox.sync.server.SyncServerOptions.Vector
- Vector(ReadBuf, int, int) - Constructor for class io.objectbox.flatbuffers.FlexBuffers.Vector
- vector_num_elems - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- vectorCacheHintSizeKb() - Method in class io.objectbox.model.HnswParams
-
A non-binding hint at the maximum size of the vector cache in KB (default: 2097152 or 2 GB/GiB).
- vectorCacheHintSizeKB() - Element in annotation interface io.objectbox.annotation.HnswIndex
-
A non-binding hint at the maximum size of the vector cache in KB (default: 2097152 or 2 GB/GiB).
- vectorCacheSimdPaddingOff() - Element in annotation interface io.objectbox.annotation.HnswFlags
-
Padding for SIMD is enabled by default, which uses more memory but may be faster.
- VectorCacheSimdPaddingOff - Static variable in class io.objectbox.model.HnswFlags
-
Padding for SIMD is enabled by default, which uses more memory but may be faster.
- VectorDistanceType - Enum Class in io.objectbox.annotation
-
The vector distance algorithm used by an
HnswIndex(vector search). - VectorDistanceType() - Constructor for enum class io.objectbox.annotation.VectorDistanceType
- verifyHandle() - Method in class io.objectbox.query.QueryBuilder
- verifyId(int) - Method in class io.objectbox.Property
- verifyIsDouble() - Method in class io.objectbox.tree.Leaf
- verifyIsInt() - Method in class io.objectbox.tree.Leaf
- verifyIsString() - Method in class io.objectbox.tree.Leaf
- verifyIsStringArray() - Method in class io.objectbox.tree.Leaf
- verifyNotAlreadyOpen(String) - Static method in class io.objectbox.BoxStore
- verifyNotSubQuery() - Method in class io.objectbox.query.QueryBuilder
- verifyObjectBrowserNotRunning() - Method in class io.objectbox.BoxStore
- version - Variable in class io.objectbox.ModelBuilder
- version() - Method in class io.objectbox.model.Model
-
User controlled version, not really used at the moment
- version(long) - Method in class io.objectbox.ModelBuilder
- VERSION - Static variable in class io.objectbox.BoxStore
-
The native or core version of ObjectBox the Java library is known to work with.
- VIRTUAL - Static variable in class io.objectbox.model.PropertyFlags
-
Virtual properties may not have a dedicated field in their entity class, e.g.
- virtualProperty - Variable in class io.objectbox.relation.ToOne
- virtualTarget() - Method in class io.objectbox.model.ModelProperty
-
This will probably move out of the core model into something binding specific.
- virtualTargetAsByteBuffer() - Method in class io.objectbox.model.ModelProperty
- virtualTargetInByteBuffer(ByteBuffer) - Method in class io.objectbox.model.ModelProperty
- virtualTargetOffset - Variable in class io.objectbox.ModelBuilder.PropertyBuilder
- vtable - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- vtable_in_use - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
- vtable_size - Variable in class io.objectbox.flatbuffers.Table
-
Used to hold the vtable size.
- vtable_start - Variable in class io.objectbox.flatbuffers.Table
-
Used to hold the vtable position.
- vtables - Variable in class io.objectbox.flatbuffers.FlatBufferBuilder
W
- weak - Variable in class io.objectbox.reactive.SubscriptionBuilder
- weak() - Method in class io.objectbox.reactive.SubscriptionBuilder
-
Uses a weak reference for the observer.
- WeakDataObserver<T> - Class in io.objectbox.reactive
- WeakDataObserver(DataObserver<T>) - Constructor for class io.objectbox.reactive.WeakDataObserver
- weakDelegate - Variable in class io.objectbox.reactive.WeakDataObserver
- WIDTH_16 - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- WIDTH_32 - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- WIDTH_64 - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- WIDTH_8 - Static variable in class io.objectbox.flatbuffers.FlexBuffersBuilder
- widthUInBits(long) - Static method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- WithLeaves - Static variable in class io.objectbox.config.ValidateOnOpenModePages
-
Performs a limited number of checks on database structures including "data leaves".
- WithLeaves - Static variable in class io.objectbox.model.ValidateOnOpenMode
-
Deprecated.Performs a limited number of checks on database structures including "data leaves".
- workerThreads - Variable in class io.objectbox.sync.server.SyncServerBuilder
- workerThreads() - Method in class io.objectbox.sync.server.SyncServerOptions
-
By default (absent or zero given), this uses a hardware dependent default, e.g.
- workerThreads(int) - Method in class io.objectbox.sync.server.SyncServerBuilder
-
Sets the number of workers for the main task pool.
- writeAny(FlexBuffersBuilder.Value, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- writeBlob(int, byte[], int, boolean) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- writeDouble(double, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- writeInt(long, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- writeOffset(long, int) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
- writePos - Variable in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- writePosition() - Method in class io.objectbox.flatbuffers.ArrayReadWriteBuf
- writePosition() - Method in class io.objectbox.flatbuffers.ByteBufferReadWriteBuf
- writePosition() - Method in interface io.objectbox.flatbuffers.ReadWriteBuf
- writeString(int, String) - Method in class io.objectbox.flatbuffers.FlexBuffersBuilder
_
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.config.FlatStoreOptions.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.flatbuffers.StringVector
-
Assigns vector access object to vector data.
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.flatbuffers.UnionVector
-
Assigns vector access object to vector data.
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.model.HnswParams.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.model.IdUid.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.model.Model.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.model.ModelEntity.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.model.ModelProperty.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.model.ModelRelation.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.sync.Credentials.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.sync.server.ClusterPeerConfig.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig.Vector
- __assign(int, int, ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions.Vector
- __assign(int, ByteBuffer) - Method in class io.objectbox.config.FlatStoreOptions
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.BooleanVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.ByteVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.DoubleVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.FloatVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.IntVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.LongVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.ShortVector
-
Assigns vector access object to vector data.
- __assign(int, ByteBuffer) - Method in class io.objectbox.model.HnswParams
- __assign(int, ByteBuffer) - Method in class io.objectbox.model.IdUid
- __assign(int, ByteBuffer) - Method in class io.objectbox.model.Model
- __assign(int, ByteBuffer) - Method in class io.objectbox.model.ModelEntity
- __assign(int, ByteBuffer) - Method in class io.objectbox.model.ModelProperty
- __assign(int, ByteBuffer) - Method in class io.objectbox.model.ModelRelation
- __assign(int, ByteBuffer) - Method in class io.objectbox.sync.Credentials
- __assign(int, ByteBuffer) - Method in class io.objectbox.sync.server.ClusterPeerConfig
- __assign(int, ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig
- __assign(int, ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- __element(int) - Method in class io.objectbox.flatbuffers.BaseVector
-
Gets the element position in vector's ByteBuffer.
- __has_identifier(ByteBuffer, String) - Static method in class io.objectbox.flatbuffers.Table
-
Check if a
ByteBuffercontains a file identifier. - __indirect(int) - Method in class io.objectbox.flatbuffers.Table
-
Retrieve a relative offset.
- __indirect(int, ByteBuffer) - Static method in class io.objectbox.flatbuffers.Table
-
Retrieve a relative offset.
- __init(int, ByteBuffer) - Method in class io.objectbox.config.FlatStoreOptions
- __init(int, ByteBuffer) - Method in class io.objectbox.model.HnswParams
- __init(int, ByteBuffer) - Method in class io.objectbox.model.IdUid
- __init(int, ByteBuffer) - Method in class io.objectbox.model.Model
- __init(int, ByteBuffer) - Method in class io.objectbox.model.ModelEntity
- __init(int, ByteBuffer) - Method in class io.objectbox.model.ModelProperty
- __init(int, ByteBuffer) - Method in class io.objectbox.model.ModelRelation
- __init(int, ByteBuffer) - Method in class io.objectbox.sync.Credentials
- __init(int, ByteBuffer) - Method in class io.objectbox.sync.server.ClusterPeerConfig
- __init(int, ByteBuffer) - Method in class io.objectbox.sync.server.JwtConfig
- __init(int, ByteBuffer) - Method in class io.objectbox.sync.server.SyncServerOptions
- __offset(int) - Method in class io.objectbox.flatbuffers.Table
-
Look up a field in the vtable.
- __offset(int, int, ByteBuffer) - Static method in class io.objectbox.flatbuffers.Table
- __reset() - Method in class io.objectbox.flatbuffers.Struct
-
Resets internal state with a null
ByteBufferand a zero position. - __reset() - Method in class io.objectbox.flatbuffers.Table
-
Resets the internal state with a null
ByteBufferand a zero position. - __reset(int, int, ByteBuffer) - Method in class io.objectbox.flatbuffers.BaseVector
-
Re-init the internal state with an external buffer
ByteBuffer, an offset within and element size. - __reset(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.Struct
-
Re-init the internal state with an external buffer
ByteBufferand an offset within. - __reset(int, ByteBuffer) - Method in class io.objectbox.flatbuffers.Table
-
Re-init the internal state with an external buffer
ByteBufferand an offset within. - __string(int) - Method in class io.objectbox.flatbuffers.Table
-
Create a Java `String` from UTF-8 data stored inside the FlatBuffer.
- __string(int, ByteBuffer, Utf8) - Static method in class io.objectbox.flatbuffers.Table
-
Create a Java `String` from UTF-8 data stored inside the FlatBuffer.
- __union(Table, int) - Method in class io.objectbox.flatbuffers.Table
-
Initialize any Table-derived type to point to the union at the given `offset`.
- __union(Table, int, ByteBuffer) - Static method in class io.objectbox.flatbuffers.Table
-
Initialize any Table-derived type to point to the union at the given `offset`.
- __vector() - Method in class io.objectbox.flatbuffers.BaseVector
-
Get the start data of a vector.
- __vector(int) - Method in class io.objectbox.flatbuffers.Table
-
Get the start data of a vector.
- __vector_as_bytebuffer(int, int) - Method in class io.objectbox.flatbuffers.Table
-
Get a whole vector as a ByteBuffer.
- __vector_in_bytebuffer(ByteBuffer, int, int) - Method in class io.objectbox.flatbuffers.Table
-
Initialize vector as a ByteBuffer.
- __vector_len(int) - Method in class io.objectbox.flatbuffers.Table
-
Get the length of a vector.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form