one.microstream.persistence.types

Class PersistenceTypeDescriptionMemberField.Abstract

java.lang.Object

one.microstream.persistence.types.PersistenceTypeDescriptionMemberField.Abstract

All Implemented Interfaces:

PersistenceTypeDescriptionMember, PersistenceTypeDescriptionMemberField

Direct Known Subclasses:

PersistenceTypeDescriptionMemberFieldGeneric.Abstract, PersistenceTypeDescriptionMemberFieldReflective.Default

Enclosing interface:

PersistenceTypeDescriptionMemberField

public abstract static class PersistenceTypeDescriptionMemberField.Abstract
extends Object
implements PersistenceTypeDescriptionMemberField

Nested Class Summary

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

PersistenceTypeDescriptionMemberField.Abstract

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

PersistenceTypeDescriptionMember.IdentityHashEqualator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Abstract(String typeName, String qualifier, String name, boolean isReference, boolean isPrimitive, boolean hasReferences, long persistentMinimumLength, long persistentMaximumLength)

Method Summary

Modifier and Type	Method and Description
boolean	hasReferences()
String	identifier() The name of the member identifying it in its parent group of members. E.g.
boolean	isEnumConstant()
boolean	isInstanceMember()
boolean	isPrimitive()
boolean	isPrimitiveDefinition()
boolean	isReference()
boolean	isValidPersistentLength(long persistentLength)
String	name() The simple or "primary" name of the member.
long	persistentMaximumLength() Returns the highest possible length value that a member of the persistent form for values of the type represented by this instance can have.
long	persistentMinimumLength() Returns the lowest possible length value that a member of the persistent form for values of the type represented by this instance can have.
String	qualifier() A type-internal qualifier to distinct different members with equal "primary" name.
String	toString()
String	typeName()
void	validatePersistentLength(long persistentLength)

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.PersistenceTypeDescriptionMember

assembleTypeDescription, calculatePersistentMaximumLength, calculatePersistentMinimumLength, createDefinitionMember, determineHasReferences, determineIsPrimitive, equalDescription, equalDescriptions, equalMembers, equalsDescription, equalsStructure, equalStructure, equalStructures, equalTypeAndName, equalTypeAndNameAndQualifier, identityHash, identityHashEqualator, isFixedLength, isIdentical, isIdentical, isVariableLength

Constructor Detail

Abstract

protected Abstract(String typeName,
                   String qualifier,
                   String name,
                   boolean isReference,
                   boolean isPrimitive,
                   boolean hasReferences,
                   long persistentMinimumLength,
                   long persistentMaximumLength)

Method Detail

typeName

public final String typeName()

Specified by:

typeName in interface PersistenceTypeDescriptionMember

Specified by:

typeName in interface PersistenceTypeDescriptionMemberField

qualifier

public final String qualifier()

Description copied from interface: PersistenceTypeDescriptionMemberField

A type-internal qualifier to distinct different members with equal "primary" name. E.g. reflection-based type handling where fields names are only unique in combination with their declaring class.

May never be null.

Specified by:

qualifier in interface PersistenceTypeDescriptionMember

Specified by:

qualifier in interface PersistenceTypeDescriptionMemberField

Returns:

the member's qualifier string to ensure a unique PersistenceTypeDescriptionMember.identifier() in a group of member fields.

name

public final String name()

Description copied from interface: PersistenceTypeDescriptionMemberField

The simple or "primary" name of the member. E.g. "lastName".

May never be null.

Specified by:

name in interface PersistenceTypeDescriptionMember

Specified by:

name in interface PersistenceTypeDescriptionMemberField

Returns:

the member field's simple name.

identifier

public final String identifier()

Description copied from interface: PersistenceTypeDescriptionMember

The name of the member identifying it in its parent group of members.
E.g. "com.my.app.entities.Person#lastname".

May never be null.

Specified by:

identifier in interface PersistenceTypeDescriptionMember

Returns:

the member's uniquely identifying name.

isReference

public final boolean isReference()

Specified by:

isReference in interface PersistenceTypeDescriptionMember

Returns:

if this member directly is a reference.

isPrimitive

public final boolean isPrimitive()

Specified by:

isPrimitive in interface PersistenceTypeDescriptionMember

Returns:

if this member is primitive value.

isPrimitiveDefinition

public final boolean isPrimitiveDefinition()

Specified by:

isPrimitiveDefinition in interface PersistenceTypeDescriptionMember

Returns:

if this member is a primitive type definition instead of a field definition.

isEnumConstant

public final boolean isEnumConstant()

Specified by:

isEnumConstant in interface PersistenceTypeDescriptionMember

Returns:

if this member is a enum constant name definition instead of an isntance field definition.

hasReferences

public boolean hasReferences()

Specified by:

hasReferences in interface PersistenceTypeDescriptionMember

Returns:

if this field contains references. Either because it is a reference itself, see PersistenceTypeDescriptionMember.isReference(), or because it is a complex type that contains one or more nested members that have references.

persistentMinimumLength

public long persistentMinimumLength()

Description copied from interface: PersistenceTypeDescriptionMember

Returns the lowest possible length value that a member of the persistent form for values of the type represented by this instance can have. The precise meaning of the length value depends on the actual persistence form.

Specified by:

persistentMinimumLength in interface PersistenceTypeDescriptionMember

Returns:

the persistent form length of null if variable length.

See Also:

PersistenceTypeDescriptionMember.persistentMaximumLength()

persistentMaximumLength

public long persistentMaximumLength()

Description copied from interface: PersistenceTypeDescriptionMember

Returns the highest possible length value that a member of the persistent form for values of the type represented by this instance can have. The precise meaning of the length value depends on the actual persistence form.

Specified by:

persistentMaximumLength in interface PersistenceTypeDescriptionMember

Returns:

the persistent form length of null if variable length.

See Also:

PersistenceTypeDescriptionMember.persistentMinimumLength()

isValidPersistentLength

public boolean isValidPersistentLength(long persistentLength)

Specified by:

isValidPersistentLength in interface PersistenceTypeDescriptionMember

validatePersistentLength

public void validatePersistentLength(long persistentLength)

Specified by:

validatePersistentLength in interface PersistenceTypeDescriptionMember

isInstanceMember

public final boolean isInstanceMember()

Specified by:

isInstanceMember in interface PersistenceTypeDescriptionMember

Specified by:

isInstanceMember in interface PersistenceTypeDescriptionMemberField

toString

public String toString()

Overrides:

toString in class Object