Uses of Annotation Interface
io.objectbox.annotation.apihint.Internal

Packages that use Internal

Package	Description
io.objectbox	ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
io.objectbox.annotation.apihint	Annotations to mark APIs as for example @Internal or @Experimental.
io.objectbox.internal
io.objectbox.query	Classes related to building a Query or PropertyQuery.
io.objectbox.reactive	Classes to configure a DataSubscription for observing Box or Query changes.
io.objectbox.relation	Classes to manage ToOne and ToMany relations between Entities.
io.objectbox.sync	ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g.
io.objectbox.sync.server

Uses of Internal in io.objectbox

Classes in io.objectbox with annotations of type Internal

Modifier and Type	Class	Description
class	Cursor<T>
interface	EntityInfo<T>
class	InternalAccess	Exposes internal APIs to tests and code in other packages.
class	ModelBuilder
(package private) class	ObjectClassPublisher	A DataPublisher that notifies DataObservers about changes in an entity box.
class	Transaction

Fields in io.objectbox with annotations of type Internal

Modifier and Type	Field	Description
(package private) static boolean	Cursor.LOG_READ_NOT_CLOSED
(package private) static boolean	Cursor.TRACK_CREATION_STACK	May be set by tests
(package private) static boolean	Transaction.TRACK_CREATION_STACK	May be set by tests

Methods in io.objectbox with annotations of type Internal

Modifier and Type	Method	Description
Transaction	BoxStore.beginReadTx()	Internal, low level method: use BoxStore.runInReadTx(Runnable) instead.
Transaction	BoxStore.beginTx()	Internal, low level method: use BoxStore.runInTx(Runnable) instead.
static BoxStoreBuilder	InternalAccess.clone(BoxStoreBuilder original, String namePostfix)
static <T> void	InternalAccess.commitWriter(Box<T> box, Cursor<T> writer)
(package private) BoxStoreBuilder	BoxStoreBuilder.createClone(String namePostfix)
static BoxStoreBuilder	BoxStoreBuilder.createDebugWithoutModel()	Not for application use, for DebugCursor.
static void	InternalAccess.enableCreationStackTracking()	Makes creation more expensive, but lets Finalizers show the creation stack for dangling resources.
void	BoxStoreBuilder.entity(EntityInfo<?> entityInfo)
static Transaction	InternalAccess.getActiveTx(BoxStore boxStore)
static <T> Cursor<T>	InternalAccess.getActiveTxCursor(Box<T> box)
static <T> long	InternalAccess.getActiveTxCursorHandle(Box<T> box)
(package private) int[]	BoxStore.getAllEntityTypeIds()
(package private) List<T>	Cursor.getBacklinkEntities(int entityId, Property<?> relationIdProperty, long key)
(package private) long[]	Cursor.getBacklinkIds(int entityId, Property<?> relationIdProperty, long key)
static Object	BoxStore.getContext()
(package private) Class<?>	BoxStore.getEntityClassOrThrow(int entityTypeId)
int	Property.getEntityId()
(package private) <T> EntityInfo<T>	BoxStore.getEntityInfo(Class<T> entityClass)
int	BoxStore.getEntityTypeIdOrThrow(Class<?> entityClass)
static long	InternalAccess.getHandle(Transaction tx)
long	Box.getId(T entity)
int	Property.getId()
List<T>	Cursor.getRelationEntities(int sourceEntityId, int relationId, long key, boolean backlink)
long[]	Cursor.getRelationIds(int sourceEntityId, int relationId, long key, boolean backlink)
static Object	BoxStore.getRelinker()
static <T> Cursor<T>	InternalAccess.getWriter(Box<T> box)
<RESULT> RESULT	Box.internalCallWithReaderHandle(CallWithHandle<RESULT> task)
<RESULT> RESULT	Box.internalCallWithWriterHandle(CallWithHandle<RESULT> task)
TxCallback<?>	BoxStore.internalFailedReadTxAttemptCallback()
List<T>	Box.internalGetBacklinkEntities(int entityId, Property<?> relationIdProperty, long key)
List<T>	Box.internalGetRelationEntities(int sourceEntityId, int relationId, long key, boolean backlink)
long[]	Box.internalGetRelationIds(int sourceEntityId, int relationId, long key, boolean backlink)
(package private) long	Cursor.internalHandle()
(package private) long	Transaction.internalHandle()
int	BoxStore.internalQueryAttempts()
Future<?>	BoxStore.internalScheduleThread(Runnable runnable)
ExecutorService	BoxStore.internalThreadPool()
boolean	BoxStore.isDebugRelations()
boolean	BoxStore.isNativeStoreClosed()	For internal use only.
void	Cursor.modifyRelations(int relationId, long key, long[] targetKeys, boolean remove)
void	Cursor.modifyRelationsSingle(int relationId, long key, long targetKey, boolean remove)
(package private) static long	BoxStore.nativeGloballyActiveEntityTypes()	A static counter for the alive entity types (entity schema instances); this can be useful to test against leaks.
static void	InternalAccess.setSyncClient(BoxStore boxStore, SyncClient syncClient)
void	BoxStore.unregisterTransaction(Transaction transaction)

Constructors in io.objectbox with annotations of type Internal

Modifier	Constructor	Description
	BoxStoreBuilder(byte[] model)	Called internally from the generated class "MyObjectBox".

Uses of Internal in io.objectbox.annotation.apihint

Classes in io.objectbox.annotation.apihint with annotations of type Internal

Modifier and Type	Class	Description
@interface	Internal	APIs annotated with @Internal must NOT be used.

Uses of Internal in io.objectbox.internal

Classes in io.objectbox.internal with annotations of type Internal

Modifier and Type	Interface	Description
interface	CallWithHandle<RESULT>
interface	CursorFactory<T>
class	ObjectBoxThreadPool	Custom thread pool similar to Executors.newCachedThreadPool() with the following adjustments: Release thread local resources (BoxStore.closeThreadResources()) Reduce keep-alive time for threads to 20 seconds Uses a ThreadFactory to name threads like "ObjectBox-1-Thread-1"
class	ReflectionCache
interface	ToManyGetter<SOURCE,TARGET>
interface	ToOneGetter<SOURCE,TARGET>

Uses of Internal in io.objectbox.query

Classes in io.objectbox.query with annotations of type Internal

Modifier and Type	Class	Description
class	InternalAccess	Exposes internal APIs to tests and code in other packages.
(package private) class	QueryPublisher<T>	A DataPublisher that subscribes to an ObjectClassPublisher if there is at least one observer.

Methods in io.objectbox.query with annotations of type Internal

Modifier and Type	Method	Description
(package private) void	QueryBuilder.internalAnd(long leftCondition, long rightCondition)
(package private) long	QueryBuilder.internalGetLastCondition()
(package private) void	QueryBuilder.internalOr(long leftCondition, long rightCondition)
static <T> void	InternalAccess.nativeFindFirst(Query<T> query, long cursorHandle)

Constructors in io.objectbox.query with annotations of type Internal

Modifier	Constructor	Description
	QueryBuilder(Box<T> box, long storeHandle, String entityName)

Uses of Internal in io.objectbox.reactive

Classes in io.objectbox.reactive with annotations of type Internal

Modifier and Type	Interface	Description
interface	DataPublisher<T>
class	DataPublisherUtils
interface	DelegatingObserver<T>
interface	RunWithParam<T>
class	WeakDataObserver<T>

Constructors in io.objectbox.reactive with annotations of type Internal

Modifier	Constructor	Description
	SubscriptionBuilder(DataPublisher<T> publisher, Object param)

Uses of Internal in io.objectbox.relation

Classes in io.objectbox.relation with annotations of type Internal

Modifier and Type	Class	Description
class	RelationInfo<SOURCE,TARGET>	Meta info describing a relation including source and target entity.

Methods in io.objectbox.relation with annotations of type Internal

Modifier and Type	Method	Description
TARGET	ToOne.getTarget(long targetId)	If property backed, entities can pass the target ID to avoid reflection.
void	ToMany.internalApplyToDb(Cursor<?> sourceCursor, Cursor<TARGET> targetCursor)	For internal use only; do not use in your app.
boolean	ToMany.internalCheckApplyToDbRequired()	For internal use only; do not use in your app.
void	ToOne.internalPutTarget(Cursor<TARGET> targetCursor)
boolean	ToOne.internalRequiresPutTarget()

Uses of Internal in io.objectbox.sync

Classes in io.objectbox.sync with annotations of type Internal

Modifier and Type	Class	Description
final class	SyncClientImpl	Internal sync client implementation.
final class	SyncCredentialsToken	Internal credentials implementation.
final class	SyncCredentialsUserPassword	Internal credentials implementation for user and password authentication.

Methods in io.objectbox.sync with annotations of type Internal

Modifier and Type	Method	Description
(package private) SyncBuilder	SyncBuilder.serverUrl(String url)	Allows internal code to set the Sync server URL after creating this builder.

Constructors in io.objectbox.sync with annotations of type Internal

Modifier	Constructor	Description
	SyncBuilder(BoxStore boxStore, SyncCredentials credentials)
	SyncBuilder(BoxStore boxStore, SyncCredentials[] multipleCredentials)
	SyncBuilder(BoxStore boxStore, String url, SyncCredentials credentials)
	SyncBuilder(BoxStore boxStore, String url, SyncCredentials[] multipleCredentials)
(package private)	SyncHybridBuilder(BoxStoreBuilder storeBuilder, String url, SyncCredentials authenticatorCredentials)	Internal API; use Sync.hybrid(BoxStoreBuilder, String, SyncCredentials) instead.

Uses of Internal in io.objectbox.sync.server

Classes in io.objectbox.sync.server with annotations of type Internal

Modifier and Type	Class	Description
(package private) final class	ClusterPeerInfo	Internal class to keep configuration for a cluster peer.
final class	SyncServerImpl	Internal sync server implementation.

Constructors in io.objectbox.sync.server with annotations of type Internal

Modifier	Constructor	Description
	SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials authenticatorCredentials)	Use Sync.server(BoxStore, String, SyncCredentials) instead.
	SyncServerBuilder(BoxStore boxStore, String url, SyncCredentials[] multipleAuthenticatorCredentials)	Use Sync.server(BoxStore, String, SyncCredentials) instead.