Package one.microstream.persistence.types

Interface PersistenceTypeHandler<M,T>

All Superinterfaces:

PersistenceTypeDefinition, PersistenceTypeDescription, PersistenceTypeIdentity, PersistenceTypeIdOwner, PersistenceTypeLink

All Known Subinterfaces:

BinaryLegacyTypeHandler<T>, BinaryTypeHandler<T>, PersistenceLegacyTypeHandler<M,T>, PersistenceTypeHandlerCustom<M,T>, PersistenceTypeHandlerGeneric<M,T>, PersistenceTypeHandlerReflective<M,T>, PersistenceUnreachableTypeHandler<M,T>

All Known Implementing Classes:

AbstractBinaryHandlerAbstractStringBuilder, AbstractBinaryHandlerCollection, AbstractBinaryHandlerCustom, AbstractBinaryHandlerCustomCollection, AbstractBinaryHandlerCustomEnum, AbstractBinaryHandlerCustomIterable, AbstractBinaryHandlerCustomIterableSimpleListElements, AbstractBinaryHandlerCustomIterableSizedArray, AbstractBinaryHandlerCustomValue, AbstractBinaryHandlerCustomValueFixedLength, AbstractBinaryHandlerCustomValueVariableLength, AbstractBinaryHandlerList, AbstractBinaryHandlerMap, AbstractBinaryHandlerNativeArray, AbstractBinaryHandlerNativeArrayPrimitive, AbstractBinaryHandlerQueue, AbstractBinaryHandlerReflective, AbstractBinaryHandlerSet, AbstractBinaryHandlerStateless, AbstractBinaryHandlerTrivial, AbstractBinaryLegacyTypeHandlerReflective, AbstractBinaryLegacyTypeHandlerTranslating, BinaryHandlerAbstractType, BinaryHandlerArrayDeque, BinaryHandlerArrayList, BinaryHandlerArrayList, BinaryHandlerBigDecimal, BinaryHandlerBigInteger, BinaryHandlerBoolean, BinaryHandlerBulkList, BinaryHandlerByte, BinaryHandlerCharacter, BinaryHandlerClass, BinaryHandlerConcurrentHashMap, BinaryHandlerConcurrentLinkedDeque, BinaryHandlerConcurrentLinkedQueue, BinaryHandlerConcurrentSkipListMap, BinaryHandlerConcurrentSkipListSet, BinaryHandlerConstHashEnum, BinaryHandlerConstHashTable, BinaryHandlerConstList, BinaryHandlerCopyOnWriteArrayList, BinaryHandlerCustomEnumTrivial, BinaryHandlerDate, BinaryHandlerDouble, BinaryHandlerEqBulkList, BinaryHandlerEqConstHashEnum, BinaryHandlerEqConstHashTable, BinaryHandlerEqHashEnum, BinaryHandlerEqHashTable, BinaryHandlerFile, BinaryHandlerFixedList, BinaryHandlerFloat, BinaryHandlerGenericCollection, BinaryHandlerGenericEnum, BinaryHandlerGenericList, BinaryHandlerGenericMap, BinaryHandlerGenericQueue, BinaryHandlerGenericSet, BinaryHandlerGenericType, BinaryHandlerHashEnum, BinaryHandlerHashMap, BinaryHandlerHashMap, BinaryHandlerHashMapFlattened, BinaryHandlerHashSet, BinaryHandlerHashSet, BinaryHandlerHashtable, BinaryHandlerHashtable, BinaryHandlerHashTable, BinaryHandlerHashtableFlattened, BinaryHandlerIdentityHashMap, BinaryHandlerInteger, BinaryHandlerLazyDefault, BinaryHandlerLimitList, BinaryHandlerLinkedHashMap, BinaryHandlerLinkedHashMap, BinaryHandlerLinkedHashMapFlattened, BinaryHandlerLinkedHashSet, BinaryHandlerLinkedHashSet, BinaryHandlerLinkedList, BinaryHandlerLocale, BinaryHandlerLong, BinaryHandlerNativeArray_boolean, BinaryHandlerNativeArray_byte, BinaryHandlerNativeArray_char, BinaryHandlerNativeArray_double, BinaryHandlerNativeArray_float, BinaryHandlerNativeArray_int, BinaryHandlerNativeArray_long, BinaryHandlerNativeArray_short, BinaryHandlerNativeArrayObject, BinaryHandlerNoOp, BinaryHandlerObject, BinaryHandlerOptionalDouble, BinaryHandlerOptionalInt, BinaryHandlerOptionalLong, BinaryHandlerPath, BinaryHandlerPersistenceRootsDefault, BinaryHandlerPrimitive, BinaryHandlerPriorityQueue, BinaryHandlerPriorityQueue, BinaryHandlerProperties, BinaryHandlerProperties, BinaryHandlerShort, BinaryHandlerSingletonStatelessEnum, BinaryHandlerStack, BinaryHandlerStack, BinaryHandlerStateless, BinaryHandlerStatelessConstant, BinaryHandlerString, BinaryHandlerStringBuffer, BinaryHandlerStringBuilder, BinaryHandlerSubstituterDefault, BinaryHandlerTreeMap, BinaryHandlerTreeSet, BinaryHandlerUnpersistable, BinaryHandlerVector, BinaryHandlerVector, BinaryHandlerVoid, BinaryHandlerWeakHashMap, BinaryLegacyTypeHandler.Abstract, BinaryLegacyTypeHandler.AbstractCustom, BinaryLegacyTypeHandlerGenericEnum, BinaryLegacyTypeHandlerGenericEnumMapped, BinaryLegacyTypeHandlerGenericType, BinaryLegacyTypeHandlerRerouting, BinaryTypeHandler.Abstract, PersistenceLegacyTypeHandler.Abstract, PersistenceLegacyTypeHandlerWrapper, PersistenceLegacyTypeHandlerWrapperEnum, PersistenceTypeHandler.Abstract, PersistenceUnreachableTypeHandler.Default

public interface PersistenceTypeHandler<M,T>
extends PersistenceTypeDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PersistenceTypeHandler.Abstract<M,T>

Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceTypeDefinition

PersistenceTypeDefinition.Default

Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceTypeDescription

PersistenceTypeDescription.Identity

Method Summary

Modifier and Type	Method	Description
XGettingEnum<? extends PersistenceTypeDefinitionMember>	allMembers()
default Object[]	collectEnumConstants()
void	complete(M medium, T instance, PersistenceObjectIdResolver idResolver)	Completes an initially built instance after all loaded instances have been built.
T	create(M medium, PersistenceObjectIdResolver idResolver)
default int	getPersistedEnumOrdinal(M medium)
default void	guaranteeSpecificInstanceViablity()	Guarantees that the PersistenceTypeHandler implementation is actually viably usable to handle instances.
default void	guaranteeSubTypeInstanceViablity()
boolean	hasInstanceReferences()
PersistenceTypeHandler<M,T>	initialize(long typeId)
XGettingEnum<? extends PersistenceTypeDefinitionMember>	instanceMembers()	Enum (unique elements with order), using PersistenceTypeDescriptionMember.identityHashEqualator().
default boolean	isSpecificInstanceViable()
default boolean	isSubTypeInstanceViable()
void	iterateInstanceReferences(T instance, PersistenceFunction iterator)
void	iterateLoadableReferences(M medium, PersistenceObjectIdAcceptor iterator)
<C extends Consumer<? super Class<?>>> C	iterateMemberTypes(C logic)	Iterates the types of persistent members (e.g.
default XGettingEnum<? extends PersistenceTypeDefinitionMember>	membersInDeclaredOrder()
static <T,M> T	resolveEnumConstant(Class<T> type, int ordinal)
default XGettingEnum<? extends PersistenceTypeDescriptionMember>	settingMembers()
void	store(M medium, T instance, long objectId, PersistenceStoreHandler handler)
default XGettingEnum<? extends PersistenceTypeDescriptionMember>	storingMembers()
Class<T>	type()
void	update(M medium, T instance, PersistenceObjectIdResolver idResolver)

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDefinition

hasPersistedReferences, hasPersistedVariableLength, hasVaryingPersistedLengthInstances, isPrimitiveType, membersPersistedLengthMaximum, membersPersistedLengthMinimum, runtimeTypeName, toRuntimeTypeIdentifier, typeId, typeName

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDescription

instancePrimitiveMembers, instanceReferenceMembers, toTypeIdentifier

Method Detail

type

Class<T> type()

Specified by:

type in interface PersistenceTypeDefinition

Specified by:

type in interface PersistenceTypeLink

allMembers

XGettingEnum<? extends PersistenceTypeDefinitionMember> allMembers()

Specified by:

allMembers in interface PersistenceTypeDefinition

Specified by:

allMembers in interface PersistenceTypeDescription

instanceMembers

XGettingEnum<? extends PersistenceTypeDefinitionMember> instanceMembers()

Description copied from interface: PersistenceTypeDefinition

Enum (unique elements with order), using PersistenceTypeDescriptionMember.identityHashEqualator(). Contains all persistent members (similar, but not identical to fields) in persistent order, which can differ from the declaration order.

Specified by:

instanceMembers in interface PersistenceTypeDefinition

Specified by:

instanceMembers in interface PersistenceTypeDescription

hasInstanceReferences

boolean hasInstanceReferences()

iterateInstanceReferences

void iterateInstanceReferences(T instance,
                               PersistenceFunction iterator)

iterateLoadableReferences

void iterateLoadableReferences(M medium,
                               PersistenceObjectIdAcceptor iterator)

store

void store(M medium,
           T instance,
           long objectId,
           PersistenceStoreHandler handler)

create

T create(M medium,
         PersistenceObjectIdResolver idResolver)

update

void update(M medium,
            T instance,
            PersistenceObjectIdResolver idResolver)

complete

void complete(M medium,
              T instance,
              PersistenceObjectIdResolver idResolver)

Completes an initially built instance after all loaded instances have been built. E.g. can be used to cause a hash collection to hash all its initially collected entries after their instances have been built.

Parameters:

medium -

instance -

handler -

initialize

PersistenceTypeHandler<M,T> initialize(long typeId)

iterateMemberTypes

<C extends Consumer<? super Class<?>>> C iterateMemberTypes(C logic)

Iterates the types of persistent members (e.g. non-transient Fields). The same type may occur more than once. The order in which the types are provided is undefined, i.e. depending on the implementation.

Parameters:

logic -

membersInDeclaredOrder

default XGettingEnum<? extends PersistenceTypeDefinitionMember> membersInDeclaredOrder()

storingMembers

default XGettingEnum<? extends PersistenceTypeDescriptionMember> storingMembers()

settingMembers

default XGettingEnum<? extends PersistenceTypeDescriptionMember> settingMembers()

guaranteeSpecificInstanceViablity

default void guaranteeSpecificInstanceViablity()
                                        throws PersistenceExceptionTypeNotPersistable

Guarantees that the PersistenceTypeHandler implementation is actually viably usable to handle instances. That is the natural purpose of type handlers, but there are exceptions, like type handlers created for abstract types or unpersistable types just to have a metadata representation that links a type and a type id.

See occurances of PersistenceExceptionTypeNotPersistable.

Throws:

PersistenceExceptionTypeNotPersistable

See Also:

PersistenceExceptionTypeNotPersistable

isSpecificInstanceViable

default boolean isSpecificInstanceViable()

guaranteeSubTypeInstanceViablity

default void guaranteeSubTypeInstanceViablity()
                                       throws PersistenceExceptionTypeNotPersistable

Throws:

PersistenceExceptionTypeNotPersistable

isSubTypeInstanceViable

default boolean isSubTypeInstanceViable()

collectEnumConstants

default Object[] collectEnumConstants()

getPersistedEnumOrdinal

default int getPersistedEnumOrdinal(M medium)

resolveEnumConstant

static <T,M> T resolveEnumConstant(Class<T> type,
                                         int ordinal)