one.microstream.persistence.types

Interface PersistenceStoring

All Known Subinterfaces:

PersistenceManager<D>, PersistenceStorer, Persister, Storer

All Known Implementing Classes:

PersistenceManager.Default

public interface PersistenceStoring

A type defining that an action to store an object graph can be performed. For more complex (i.e. stateful transaction-like) storing, see Storer.

Method Summary

Modifier and Type	Method and Description
long	store(Object instance) Stores the passed instance in any case and all referenced instances of persistable references recursively, but stores referenced instances only if they are newly encountered (e.g.
void	storeAll(Iterable<?> instances) Convenience method to store(Object) all instances of an Iterable type, usually a collection. The passed instance itself is NOT stored. Note that this method does not return an array of objectIds, since the amount of instances supplied by the passed Iterable cannot be known until after all instances have been stored and the memory and performance overhead to collect them dynamically would not be worth it in most cases since the returned array is hardly ever needed.
long[]	storeAll(Object... instances) Convenience method to store(Object) multiple instances.

Method Detail

store

long store(Object instance)

Stores the passed instance in any case and all referenced instances of persistable references recursively, but stores referenced instances only if they are newly encountered (e.g. don't have an id associated with them in the object registry, yet and are therefore required to be handled). This is useful for the common case of just storing an updated instance and potentially newly created instances along with it while skipping all existing (and normally unchanged) referenced instances.

Parameters:

instance - the root instance of the subgraph of required instances to be stored.

Returns:

the object id representing the passed instance.

storeAll

long[] storeAll(Object... instances)

Convenience method to store(Object) multiple instances. The passed array (maybe implicitely created by the compiler) itself is NOT stored.

Parameters:

instances - multiple root instances of the subgraphs of required instances to be stored.

Returns:

an array containing the object ids representing the passed instances.

storeAll

void storeAll(Iterable<?> instances)

Convenience method to store(Object) all instances of an Iterable type, usually a collection.
The passed instance itself is NOT stored.
Note that this method does not return an array of objectIds, since the amount of instances supplied by the passed Iterable cannot be known until after all instances have been stored and the memory and performance overhead to collect them dynamically would not be worth it in most cases since the returned array is hardly ever needed. If it should be needed, the desired behavior can be easily achieved with a tiny custom-made utility method.

Parameters:

instances - multiple root instances of the subgraphs of required instances to be stored.