Uses of Annotation Interface
io.objectbox.annotation.apihint.Experimental
Packages that use Experimental
Package
Description
ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
Various exceptions thrown by ObjectBox.
ObjectBox Sync allows to automatically synchronize local data with a sync
destination (e.g.
APIs to interact with tree structures stored in ObjectBox.
-
Uses of Experimental in io.objectbox
Classes in io.objectbox with annotations of type ExperimentalModifier and TypeInterfaceDescriptioninterfaceFactory<T>Generic Factory that provides a resource on demand (if and when it is required).Methods in io.objectbox with annotations of type ExperimentalModifier and TypeMethodDescription<T> TBoxStore.callInReadTxWithRetry(Callable<T> callable, int attempts, int initialBackOffInMs, boolean logAndHeal) CallsBoxStore.callInReadTx(Callable)and retries in case a DbException is thrown.BoxStoreBuilder.failedReadTxAttemptCallback(TxCallback<?> failedReadTxAttemptCallback) Define a callback for failed read transactions during retires (see alsoBoxStoreBuilder.queryAttempts(int)).intBoxStore.getObjectBrowserPort()BoxStoreBuilder.initialDbFile(Factory<InputStream> initialDbFileFactory) Let's you specify a provider for a DB file to be used during initial start of the app (no DB file exists yet).BoxStoreBuilder.initialDbFile(File initialDbFile) Let's you specify an DB file to be used during initial start of the app (no DB file exists yet).longBox.panicModeRemoveAll()WARNING: this method should generally be avoided as it is not transactional and thus may leave the DB in an inconsistent state.BoxStoreBuilder.queryAttempts(int queryAttempts) For massive concurrent setups (app is using a lot of threads), you can enable automatic retries for queries.voidTransaction.reset()Will throw if Cursors are still active for this TX.BoxStore.startObjectBrowser()BoxStore.startObjectBrowser(int port) BoxStore.startObjectBrowser(String urlToBindTo) booleanBoxStore.stopObjectBrowser()static longBoxStore.sysProcMeminfoKb(String key) Linux only: extracts a kB value from /proc/meminfo (system wide memory information).static longBoxStore.sysProcStatusKb(String key) Linux only: extracts a kB value from /proc/self/status (process specific information). -
Uses of Experimental in io.objectbox.exception
Methods in io.objectbox.exception with annotations of type ExperimentalModifier and TypeMethodDescriptionstatic voidDbExceptionListener.cancelCurrentException()WARNING/DISCLAIMER: Please avoid this method and handle exceptions "properly" instead. -
Uses of Experimental in io.objectbox.relation
Classes in io.objectbox.relation with annotations of type ExperimentalMethods in io.objectbox.relation with annotations of type ExperimentalModifier and TypeMethodDescriptionvoidToMany.setComparator(Comparator<TARGET> comparator) Set an comparator to define the order of entities.voidToMany.setListFactory(ListFactory listFactory) Currently only used for non-persisted entities (id == 0).voidToMany.setRemoveFromTargetBox(boolean removeFromTargetBox) On put, this also deletes removed entities from the target Box. -
Uses of Experimental in io.objectbox.sync
Classes in io.objectbox.sync with annotations of type ExperimentalMethods in io.objectbox.sync with annotations of type ExperimentalModifier and TypeMethodDescriptionbooleanSyncClient.requestFullSync()Experimental.booleanSyncClientImpl.requestFullSync()Temporary only, try not to use it.booleanSyncClientImpl.requestFullSyncAndUpdates()Temporary only, try not to use it.SyncClient.startObjectsMessage(long flags, String topic) Experimental. -
Uses of Experimental in io.objectbox.sync.listener
Classes in io.objectbox.sync.listener with annotations of type ExperimentalModifier and TypeClassDescriptionclassASyncListenerwith empty implementations of all interface methods.interfaceNotifies of fine granular changes on the object level happening during sync.interfaceThis listener has callback methods invoked by all fundamental synchronization events. -
Uses of Experimental in io.objectbox.tree
Classes in io.objectbox.tree with annotations of type ExperimentalModifier and TypeClassDescriptionclassA branch within aTree.classclass(Potentially internal) value object created in our JNI layer to represent a leaf with all stored data.classA higher level tree API operating on branch and leaf nodes.