Package one.microstream.persistence.binary.one.microstream.entity

Class BinaryHandlerEntityLoading.Default<T>

java.lang.Object

one.microstream.persistence.binary.one.microstream.entity.BinaryHandlerEntityLoading.Default<T>

All Implemented Interfaces:

BinaryHandlerEntityLoading<T>, BinaryTypeHandler<T>, PersistenceDataTypeHolder<Binary>, PersistenceTypeDefinition, PersistenceTypeDescription, PersistenceTypeHandler<Binary,T>, PersistenceTypeIdentity, PersistenceTypeIdOwner, PersistenceTypeLink

Enclosing interface:

BinaryHandlerEntityLoading<T>

public static class BinaryHandlerEntityLoading.Default<T>
extends Object
implements BinaryHandlerEntityLoading<T>

Nested Class Summary

Nested classes/interfaces inherited from interface one.microstream.persistence.binary.one.microstream.entity.BinaryHandlerEntityLoading

BinaryHandlerEntityLoading.Default<T>

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

BinaryTypeHandler.Abstract<T>

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

PersistenceTypeDescription.Identity

Method Summary

Modifier and Type	Method	Description
XGettingEnum<? extends PersistenceTypeDefinitionMember>	allMembers()
Object[]	collectEnumConstants()
void	complete(Binary data, T instance, PersistenceLoadHandler handler)	Completes an initially built instance after all loaded instances have been built.
T	create(Binary data, PersistenceLoadHandler handler)
BinaryTypeHandler<T>	createStoringEntityHandler()
Class<Binary>	dataType()
int	getPersistedEnumOrdinal(Binary data)
void	guaranteeSpecificInstanceViablity()	Guarantees that the PersistenceTypeHandler implementation is actually viably usable to handle instances.
void	guaranteeSubTypeInstanceViablity()
boolean	hasPersistedReferences()
boolean	hasPersistedVariableLength()	Provides information if two instances of the handled type can have different length in persisted form.
boolean	hasVaryingPersistedLengthInstances()	Provides information if one particular instance can have variing binary length from one store to another.
PersistenceTypeHandler<Binary,T>	initialize(long typeId)
void	initializeState(Binary data, T instance, PersistenceLoadHandler handler)
XGettingEnum<? extends PersistenceTypeDefinitionMember>	instanceMembers()	Enum (unique elements with order), using PersistenceTypeDescriptionMember.identityHashEqualator().
XGettingSequence<? extends PersistenceTypeDescriptionMember>	instancePrimitiveMembers()
XGettingSequence<? extends PersistenceTypeDescriptionMember>	instanceReferenceMembers()
boolean	isPrimitiveType()
boolean	isSpecificInstanceViable()
boolean	isSubTypeInstanceViable()
boolean	isValidEntityType(Class<? extends T> type)
void	iterateInstanceReferences(T instance, PersistenceFunction iterator)
void	iterateLoadableReferences(Binary data, PersistenceReferenceLoader iterator)
<C extends Consumer<? super Class<?>>> C	iterateMemberTypes(C logic)	Iterates the types of persistent members (e.g.
XGettingEnum<? extends PersistenceTypeDefinitionMember>	membersInDeclaredOrder()
long	membersPersistedLengthMaximum()
long	membersPersistedLengthMinimum()
String	runtimeTypeName()	The name of the corresponding runtime type.
XGettingEnum<? extends PersistenceTypeDescriptionMember>	settingMembers()
XGettingEnum<? extends PersistenceTypeDescriptionMember>	storingMembers()
String	toRuntimeTypeIdentifier()
String	toTypeIdentifier()
Class<T>	type()
long	typeId()	The biuniquely associated id value identifying a type description.
String	typeName()	The name of the type as defined in the type dictionary.
void	updateState(Binary data, T instance, PersistenceLoadHandler handler)
void	validateEntityType(Class<? extends T> type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface one.microstream.persistence.binary.one.microstream.entity.BinaryHandlerEntityLoading

store

Method Details

initialize

public PersistenceTypeHandler<Binary,T> initialize(long typeId)

Specified by:

initialize in interface PersistenceTypeHandler<Binary,T>

dataType

public Class<Binary> dataType()

Specified by:

dataType in interface BinaryTypeHandler<T>

Specified by:

dataType in interface PersistenceDataTypeHolder<T>

Specified by:

dataType in interface PersistenceTypeHandler<Binary,T>

typeId

public long typeId()

Description copied from interface: PersistenceTypeDefinition

The biuniquely associated id value identifying a type description.

Specified by:

typeId in interface PersistenceTypeDefinition

Specified by:

typeId in interface PersistenceTypeIdentity

Specified by:

typeId in interface PersistenceTypeIdOwner

Specified by:

typeId in interface PersistenceTypeLink

typeName

public String typeName()

Description copied from interface: PersistenceTypeDefinition

The name of the type as defined in the type dictionary. This name may never change for a given typeId, even if the runtime PersistenceTypeDefinition.runtimeTypeName() did to reflect a design-level type renaming.

Specified by:

typeName in interface PersistenceTypeDefinition

Specified by:

typeName in interface PersistenceTypeDescription

Specified by:

typeName in interface PersistenceTypeIdentity

instanceReferenceMembers

public XGettingSequence<? extends PersistenceTypeDescriptionMember> instanceReferenceMembers()

Specified by:

instanceReferenceMembers in interface PersistenceTypeDescription

runtimeTypeName

public String runtimeTypeName()

Description copied from interface: PersistenceTypeDefinition

The name of the corresponding runtime type. If not implemented otherwise (e.g. to cache the name), this method simply calls Class.getName() of a non-null PersistenceTypeDefinition.type() reference.

Specified by:

runtimeTypeName in interface PersistenceTypeDefinition

Returns:

the name of the corresponding runtime type

type

public Class<T> type()

Specified by:

type in interface PersistenceTypeDefinition

Specified by:

type in interface PersistenceTypeHandler<Binary,T>

Specified by:

type in interface PersistenceTypeLink

isValidEntityType

public boolean isValidEntityType(Class<? extends T> type)

Specified by:

isValidEntityType in interface PersistenceTypeHandler<Binary,T>

instancePrimitiveMembers

public XGettingSequence<? extends PersistenceTypeDescriptionMember> instancePrimitiveMembers()

Specified by:

instancePrimitiveMembers in interface PersistenceTypeDescription

validateEntityType

public void validateEntityType(Class<? extends T> type)

Specified by:

validateEntityType in interface PersistenceTypeHandler<Binary,T>

allMembers

public XGettingEnum<? extends PersistenceTypeDefinitionMember> allMembers()

Specified by:

allMembers in interface PersistenceTypeDefinition

Specified by:

allMembers in interface PersistenceTypeDescription

Specified by:

allMembers in interface PersistenceTypeHandler<Binary,T>

instanceMembers

public 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

Specified by:

instanceMembers in interface PersistenceTypeHandler<Binary,T>

iterateInstanceReferences

public void iterateInstanceReferences(T instance, PersistenceFunction iterator)

Specified by:

iterateInstanceReferences in interface PersistenceTypeHandler<Binary,T>

iterateLoadableReferences

public void iterateLoadableReferences(Binary data, PersistenceReferenceLoader iterator)

Specified by:

iterateLoadableReferences in interface PersistenceTypeHandler<Binary,T>

create

public T create(Binary data, PersistenceLoadHandler handler)

Specified by:

create in interface PersistenceTypeHandler<Binary,T>

hasPersistedReferences

public boolean hasPersistedReferences()

Specified by:

hasPersistedReferences in interface PersistenceTypeDefinition

membersPersistedLengthMinimum

public long membersPersistedLengthMinimum()

Specified by:

membersPersistedLengthMinimum in interface PersistenceTypeDefinition

toTypeIdentifier

public String toTypeIdentifier()

Specified by:

toTypeIdentifier in interface PersistenceTypeDescription

initializeState

public void initializeState(Binary data, T instance, PersistenceLoadHandler handler)

Specified by:

initializeState in interface PersistenceTypeHandler<Binary,T>

membersPersistedLengthMaximum

public long membersPersistedLengthMaximum()

Specified by:

membersPersistedLengthMaximum in interface PersistenceTypeDefinition

hasPersistedVariableLength

public boolean hasPersistedVariableLength()

Description copied from interface: PersistenceTypeDefinition

Provides information if two instances of the handled type can have different length in persisted form.

Examples for variable length types:

• arrays
• java.lang.String
• java.util.ArrayList
• java.math.BigDecimal

Examples for fixed length types:

• primitive value wrapper types
• java.lang.Object
• java.util.Date
• typical entity types (without unshared inlined variable length component instances)

Specified by:

hasPersistedVariableLength in interface PersistenceTypeDefinition

Returns:

if two instances of the handled type can have different length in persisted form

updateState

public void updateState(Binary data, T instance, PersistenceLoadHandler handler)

Specified by:

updateState in interface PersistenceTypeHandler<Binary,T>

complete

public void complete(Binary 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<Binary,T>

Parameters:

data - the data target

instance - the source instance

handler - the appropriate handler

isPrimitiveType

public boolean isPrimitiveType()

Specified by:

isPrimitiveType in interface PersistenceTypeDefinition

hasVaryingPersistedLengthInstances

public boolean hasVaryingPersistedLengthInstances()

Description copied from interface: PersistenceTypeDefinition

Provides information if one particular instance can have variing binary length from one store to another.

Examples for variable length instances:

• variable size collection instances
• variable size pesudo collection instances like java.util.StringBuilder
• instances of custom defined types similar to collections

Examples for fixed length instances:

• arrays
• all immutable type instances (like java.lang.String )
• all fixed length types (see PersistenceTypeDefinition.hasVaryingPersistedLengthInstances()

Specified by:

hasVaryingPersistedLengthInstances in interface PersistenceTypeDefinition

Returns:

if one particular instance can have variing binary length from one store to another

iterateMemberTypes

public <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<Binary,T>

Type Parameters:

C - the logic type

Parameters:

logic - the iteration logic

Returns:

the given logic

toRuntimeTypeIdentifier

public String toRuntimeTypeIdentifier()

Specified by:

toRuntimeTypeIdentifier in interface PersistenceTypeDefinition

membersInDeclaredOrder

public XGettingEnum<? extends PersistenceTypeDefinitionMember> membersInDeclaredOrder()

Specified by:

membersInDeclaredOrder in interface PersistenceTypeHandler<Binary,T>

storingMembers

public XGettingEnum<? extends PersistenceTypeDescriptionMember> storingMembers()

Specified by:

storingMembers in interface PersistenceTypeHandler<Binary,T>

settingMembers

public XGettingEnum<? extends PersistenceTypeDescriptionMember> settingMembers()

Specified by:

settingMembers in interface PersistenceTypeHandler<Binary,T>

guaranteeSpecificInstanceViablity

public void guaranteeSpecificInstanceViablity() throws PersistenceExceptionTypeNotPersistable

Description copied from interface: PersistenceTypeHandler

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.

Specified by:

guaranteeSpecificInstanceViablity in interface PersistenceTypeHandler<Binary,T>

Throws:

PersistenceExceptionTypeNotPersistable - if the handler's type is not persistable

See Also:

PersistenceExceptionTypeNotPersistable

isSpecificInstanceViable

public boolean isSpecificInstanceViable()

Specified by:

isSpecificInstanceViable in interface PersistenceTypeHandler<Binary,T>

guaranteeSubTypeInstanceViablity

public void guaranteeSubTypeInstanceViablity() throws PersistenceExceptionTypeNotPersistable

Specified by:

guaranteeSubTypeInstanceViablity in interface PersistenceTypeHandler<Binary,T>

Throws:

PersistenceExceptionTypeNotPersistable

isSubTypeInstanceViable

public boolean isSubTypeInstanceViable()

Specified by:

isSubTypeInstanceViable in interface PersistenceTypeHandler<Binary,T>

collectEnumConstants

public Object[] collectEnumConstants()

Specified by:

collectEnumConstants in interface PersistenceTypeHandler<Binary,T>

getPersistedEnumOrdinal

public int getPersistedEnumOrdinal(Binary data)

Specified by:

getPersistedEnumOrdinal in interface PersistenceTypeHandler<Binary,T>

createStoringEntityHandler

public BinaryTypeHandler<T> createStoringEntityHandler()

Specified by:

createStoringEntityHandler in interface BinaryHandlerEntityLoading<T>