one.microstream.persistence.types

Class PersistenceTypeDefinition.Default

java.lang.Object

one.microstream.persistence.types.PersistenceTypeDefinition.Default

All Implemented Interfaces:

PersistenceTypeDefinition, PersistenceTypeDescription, PersistenceTypeIdentity, PersistenceTypeIdOwner, PersistenceTypeLink

Enclosing interface:

PersistenceTypeDefinition

public static final class PersistenceTypeDefinition.Default
extends Object
implements PersistenceTypeDefinition

Nested Class Summary

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 and Description
one.microstream.collections.types.XImmutableEnum<? extends PersistenceTypeDefinitionMember>	allMembers()
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.
one.microstream.collections.types.XImmutableEnum<? extends PersistenceTypeDefinitionMember>	instanceMembers() Enum (unique elements with order), using PersistenceTypeDescriptionMember.identityHashEqualator().
boolean	isPrimitiveType()
long	membersPersistedLengthMaximum()
long	membersPersistedLengthMinimum()
String	runtimeTypeName() The name of the corresponding runtime type.
String	toString()
Class<?>	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.

Methods inherited from class java.lang.Object

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

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

determineIsPrimitive, determineVariableLength, New, toRuntimeTypeIdentifier

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

typeId

public final 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 final 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

runtimeTypeName

public final 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 final Class<?> type()

Specified by:

type in interface PersistenceTypeDefinition

Specified by:

type in interface PersistenceTypeLink

allMembers

public final one.microstream.collections.types.XImmutableEnum<? extends PersistenceTypeDefinitionMember> allMembers()

Specified by:

allMembers in interface PersistenceTypeDefinition

Specified by:

allMembers in interface PersistenceTypeDescription

instanceMembers

public final one.microstream.collections.types.XImmutableEnum<? 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

hasPersistedReferences

public final boolean hasPersistedReferences()

Specified by:

hasPersistedReferences in interface PersistenceTypeDefinition

isPrimitiveType

public final boolean isPrimitiveType()

Specified by:

isPrimitiveType in interface PersistenceTypeDefinition

hasPersistedVariableLength

public final 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

hasVaryingPersistedLengthInstances

public final 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

toString

public final String toString()

Overrides:

toString in class Object

membersPersistedLengthMinimum

public final long membersPersistedLengthMinimum()

Specified by:

membersPersistedLengthMinimum in interface PersistenceTypeDefinition

membersPersistedLengthMaximum

public final long membersPersistedLengthMaximum()

Specified by:

membersPersistedLengthMaximum in interface PersistenceTypeDefinition