one.microstream.persistence.types

Interface PersistenceUnreachableTypeHandler<D,T>

Type Parameters:

D - the data type

T - the handled type

All Superinterfaces:

PersistenceDataTypeHolder<D>, PersistenceLegacyTypeHandler<D,T>, PersistenceTypeDefinition, PersistenceTypeDescription, PersistenceTypeHandler<D,T>, PersistenceTypeIdentity, PersistenceTypeIdOwner, PersistenceTypeLink

All Known Implementing Classes:

PersistenceUnreachableTypeHandler.Default

public interface PersistenceUnreachableTypeHandler<D,T>
extends PersistenceLegacyTypeHandler<D,T>

This is, of course, not a handler that is unreachable, but a handler for a type whose instances are (decided by the developer) no longer reachable in the entity graph, despite potentially still being present in a live database, but not having been cleaned up, yet. However, this effectively means that the handler itself should be kind of "unreachable", too, in the sense that it may never be necessary to access and use it. Without such a handler, a class could never be removed at the design level without replacement until the last instance of it has been cleaned up the the storage housekeeping. That is an unpleasent dependency. The preferable way is to explicitly tell the typing system to "ignore" those types. That is done by registering a kind of dummy type handler. That dummy handler is this type here.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PersistenceUnreachableTypeHandler.Default<D,T>

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

PersistenceLegacyTypeHandler.Abstract<D,T>

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

PersistenceTypeDescription.Identity

Method Summary

Modifier and Type	Method and Description
default void	complete(D data, T instance, PersistenceLoadHandler handler) Completes an initially built instance after all loaded instances have been built.
default T	create(D data, PersistenceLoadHandler handler)
default Class<D>	dataType()
default void	iterateInstanceReferences(T instance, PersistenceFunction iterator)
default void	iterateLoadableReferences(D data, PersistenceReferenceLoader iterator)
default <C extends Consumer<? super Class<?>>> C	iterateMemberTypes(C logic) Iterates the types of persistent members (e.g.
static <D,T> PersistenceUnreachableTypeHandler<D,T>	New(PersistenceTypeDefinition typeDefinition)
default Class<T>	type()
default void	updateState(D data, T instance, PersistenceLoadHandler handler)

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

collectEnumConstants, initialize, resolveEnumConstant, store

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

allMembers, getPersistedEnumOrdinal, guaranteeSpecificInstanceViablity, guaranteeSubTypeInstanceViablity, initializeState, instanceMembers, isSpecificInstanceViable, isSubTypeInstanceViable, isValidEntityType, membersInDeclaredOrder, resolveEnumConstant, settingMembers, storingMembers, validateEntityType

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

determineIsPrimitive, determineVariableLength, hasPersistedReferences, hasPersistedVariableLength, hasVaryingPersistedLengthInstances, isPrimitiveType, membersPersistedLengthMaximum, membersPersistedLengthMinimum, New, runtimeTypeName, toRuntimeTypeIdentifier, typeId, typeName

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

buildTypeIdentifier, buildTypeIdentifier, equalDescription, equalStructure, Identity, instancePrimitiveMembers, instanceReferenceMembers, toTypeIdentifier, typeIdentifierSeparator

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

equals, hashCode

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

orderAscending, sortByTypeIdAscending

Method Detail

dataType

default Class<D> dataType()

Specified by:

dataType in interface PersistenceDataTypeHolder<D>

Specified by:

dataType in interface PersistenceTypeHandler<D,T>

iterateInstanceReferences

default void iterateInstanceReferences(T instance,
                                       PersistenceFunction iterator)

Specified by:

iterateInstanceReferences in interface PersistenceTypeHandler<D,T>

iterateLoadableReferences

default void iterateLoadableReferences(D data,
                                       PersistenceReferenceLoader iterator)

Specified by:

iterateLoadableReferences in interface PersistenceTypeHandler<D,T>

type

default Class<T> type()

Specified by:

type in interface PersistenceTypeDefinition

Specified by:

type in interface PersistenceTypeHandler<D,T>

Specified by:

type in interface PersistenceTypeLink

create

default T create(D data,
                 PersistenceLoadHandler handler)

Specified by:

create in interface PersistenceTypeHandler<D,T>

updateState

default void updateState(D data,
                         T instance,
                         PersistenceLoadHandler handler)

Specified by:

updateState in interface PersistenceTypeHandler<D,T>

complete

default void complete(D data,
                      T instance,
                      PersistenceLoadHandler handler)

Description copied from interface: PersistenceTypeHandler

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.

Specified by:

complete in interface PersistenceTypeHandler<D,T>

Parameters:

data - the data target

instance - the source instance

handler - the appropriate handler

iterateMemberTypes

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

Description copied from interface: PersistenceTypeHandler

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.

Specified by:

iterateMemberTypes in interface PersistenceTypeHandler<D,T>

Type Parameters:

C - the logic type

Parameters:

logic - the iteration logic

Returns:

the given logic

New

static <D,T> PersistenceUnreachableTypeHandler<D,T> New(PersistenceTypeDefinition typeDefinition)