one.microstream.persistence.types

Interface PersistenceTypeDescriptionMemberField

All Superinterfaces:

PersistenceTypeDescriptionMember

All Known Subinterfaces:

PersistenceTypeDefinitionMemberField, PersistenceTypeDefinitionMemberFieldGeneric, PersistenceTypeDefinitionMemberFieldGenericComplex, PersistenceTypeDefinitionMemberFieldGenericSimple, PersistenceTypeDefinitionMemberFieldGenericVariableLength, PersistenceTypeDefinitionMemberFieldReflective, PersistenceTypeDescriptionMemberFieldGeneric, PersistenceTypeDescriptionMemberFieldGenericComplex, PersistenceTypeDescriptionMemberFieldGenericSimple, PersistenceTypeDescriptionMemberFieldGenericVariableLength, PersistenceTypeDescriptionMemberFieldReflective

All Known Implementing Classes:

PersistenceTypeDefinitionMemberFieldGenericComplex.Default, PersistenceTypeDefinitionMemberFieldGenericSimple.Default, PersistenceTypeDefinitionMemberFieldGenericVariableLength.Default, PersistenceTypeDefinitionMemberFieldReflective.Default, PersistenceTypeDescriptionMemberField.Abstract, PersistenceTypeDescriptionMemberFieldGeneric.Abstract, PersistenceTypeDescriptionMemberFieldGenericComplex.Default, PersistenceTypeDescriptionMemberFieldGenericSimple.Default, PersistenceTypeDescriptionMemberFieldGenericVariableLength.Default, PersistenceTypeDescriptionMemberFieldReflective.Default

public interface PersistenceTypeDescriptionMemberField
extends PersistenceTypeDescriptionMember

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PersistenceTypeDescriptionMemberField.Abstract

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

PersistenceTypeDescriptionMember.IdentityHashEqualator

Method Summary

Modifier and Type	Method and Description
default boolean	isInstanceMember()
String	name() The simple or "primary" name of the member.
String	qualifier() A type-internal qualifier to distinct different members with equal "primary" name.
String	typeName()

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

assembleTypeDescription, calculatePersistentMaximumLength, calculatePersistentMinimumLength, createDefinitionMember, determineHasReferences, determineIsPrimitive, equalDescription, equalDescriptions, equalMembers, equalsDescription, equalsStructure, equalStructure, equalStructures, equalTypeAndName, equalTypeAndNameAndQualifier, hasReferences, identifier, identityHash, identityHashEqualator, isEnumConstant, isFixedLength, isIdentical, isIdentical, isPrimitive, isPrimitiveDefinition, isReference, isValidPersistentLength, isVariableLength, persistentMaximumLength, persistentMinimumLength, validatePersistentLength

Method Detail

typeName

String typeName()

Specified by:

typeName in interface PersistenceTypeDescriptionMember

qualifier

String qualifier()

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

Returns:

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

name

String name()

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

May never be null.

Specified by:

name in interface PersistenceTypeDescriptionMember

Returns:

the member field's simple name.

isInstanceMember

default boolean isInstanceMember()

Specified by:

isInstanceMember in interface PersistenceTypeDescriptionMember