one.microstream.persistence.types

Class Persistence

java.lang.Object

one.microstream.persistence.types.Persistence

public class Persistence
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Persistence.IdType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Persistence() Dummy constructor to prevent instantiation of this static-only utility class.

Method Summary

Modifier and Type	Method and Description
static long	classTypeId()
static Object[]	collectEnumConstants(PersistenceTypeHandler<?,?> typeHandler)
static PersistenceTypeIdLookup	createDefaultTypeLookup()
static String	customRootIdentifier() Deprecated.
static long	defaultBoundConstantId()
static PersistenceFieldEvaluator	defaultFieldEvaluatorCollection()
static PersistenceFieldEvaluator	defaultFieldEvaluatorEnum()
static PersistenceFieldEvaluator	defaultFieldEvaluatorPersistable()
static PersistenceFieldEvaluator	defaultFieldEvaluatorPersister()
static String	defaultFilenameTypeDictionary()
static PersistenceEagerStoringFieldEvaluator	defaultReferenceFieldEagerEvaluator()
static String	defaultRootIdentifier() Deprecated.
static long	defaultStartConstantId()
static long	defaultStartObjectId()
static long	defaultStartTypeId()
static PersistenceTypeEvaluator	defaultTypeEvaluatorPersistable()
static String	deriveEnumRootIdentifier(PersistenceTypeHandler<?,?> typeHandler)
static String	derivePersistentTypeName(Class<?> type)
static String	derivePersistentTypeName(Class<?> type, String substituteClassIdentifierSeparator)
static String	derivePersistentTypeNameEnum(Class<?> type, String substituteClassIdentifierSeparator)
static String	engineName()
static String	enumRootIdentifierStart()
static Long	getNativeTypeId(Class<?> type)
static boolean	isEnumRootIdentifier(String enumRootIdentifier)
static boolean	isHandleableCollectionField(Class<?> collectionClass, Field field)
static boolean	isHandleableEnumField(Class<?> enumClass, Field field)
static boolean	isNativeType(Class<?> type)
static boolean	isPersistable(Class<?> type)
static boolean	isPersistableField(Class<?> entityType, Field field)
static boolean	isPersisterField(Field field)
static boolean	isPotentialEnumRootIdentifier(String enumRootIdentifier)
static boolean	isUnpersistable(Class<?> type)
static <C extends BiConsumer<Class<?>,Long>> C	iterateJavaBasicTypes(C iterator)
static void	iterateReferences(PersistenceFunction iterator, Object[] array, int offset, int length)
static void	iterateReferences(PersistenceFunction iterator, one.microstream.collections.types.XIterable<?> elements)
static void	iterateReferencesIterable(PersistenceFunction iterator, Iterable<?> elements)
static void	iterateReferencesMap(PersistenceFunction iterator, Map<?,?> elements)
static String	objectIdLabel()
static String	objectIdShortLabel()
static Class<?>	objectIdType() Central architectural information method that always returns long.class.
static Long	parseEnumRootIdentifierTypeId(String enumRootIdentifier)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	parseRefactoringMappings(one.microstream.chars.StringTable stringTable)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(AFile file)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(File file) Deprecated. replaced by readRefactoringMappings(Path), will be removed in version 8
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(Path file)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(String string)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(String string, char valueSeparator)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(String string, one.microstream.util.xcsv.XCsvConfiguration configuration)
static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>>	readRefactoringMappings(String string, one.microstream.util.xcsv.XCsvDataType dataType)
static PersistenceRefactoringMappingProvider	RefactoringMapping(File refactoringsFile) Deprecated. replaced by RefactoringMapping(Path), will be removed in version 8
static PersistenceRefactoringMappingProvider	RefactoringMapping(Path refactoringsFile)
static PersistenceRefactoringMappingProvider	RefactoringMapping(String refactoringMappings)
static PersistenceRefactoringMappingProvider	RefactoringMapping(String refactoringMappings, char valueSeparator)
static PersistenceRefactoringMappingProvider	RefactoringMapping(String refactoringMappings, one.microstream.util.xcsv.XCsvConfiguration configuration)
static PersistenceRefactoringMappingProvider	RefactoringMapping(String refactoringMappings, one.microstream.util.xcsv.XCsvDataType dataType)
static PersistenceRefactoringMappingProvider	RefactoringMapping(one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> refactoringMappings)
static <R extends PersistenceTypeRegistry> R	registerJavaBasicTypes(R registry)
static <R extends PersistenceObjectRegistry> R	registerJavaConstants(R registry)
static <R extends PersistenceObjectRegistry> R	registerJavaNatives(R registry)
static <T> Class<T>	resolveEnumeratedClassIdentifierSeparatedType(String typeName, ClassLoader classLoader, String substituteClassIdentifierSeparator)
static <T> Class<T>	resolveType(String typeName, ClassLoader classLoader)
static <T> Class<T>	resolveType(String typeName, ClassLoader classLoader, String substituteClassIdentifierSeparator)
static String	rootIdentifier()
static <D,T> PersistenceTypeHandler<D,T>	searchProvidedTypeHandler(Class<D> dataType, Class<T> entityType, Predicate<? super Method> selector) Searches the methods of the passed entityType for a static method with arbitrary name and visibility, no arguments and PersistenceTypeHandler or a sub type of it as its return type.
static Charset	standardCharset() Reasons for choosing UTF8 as the standard charset: 1.) It is independent from endianess.
static String	substituteClassIdentifierSeparator() Persistence-specific separator between a class name and a proper identifier that replaces unreliable class names (like "$1", "$2" etc.) by a reliably identifying substitute name.
static <T> Class<T>	tryResolveType(String typeName, ClassLoader classLoader)
static <D> PersistenceTypeMismatchValidator<D>	typeMismatchValidatorFailing()
static <D> PersistenceTypeMismatchValidator<D>	typeMismatchValidatorNoOp()
static one.microstream.collections.types.XGettingEnum<Class<?>>	unpersistableTypes() Types whose instances cannot be persisted.
static long	validateObjectId(long id)
static long	validateTypeId(long id)

Methods inherited from class java.lang.Object

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

Constructor Detail

Persistence

protected Persistence()

Dummy constructor to prevent instantiation of this static-only utility class.

Throws:

UnsupportedOperationException - when called

Method Detail

engineName

public static String engineName()

objectIdLabel

public static final String objectIdLabel()

objectIdShortLabel

public static final String objectIdShortLabel()

objectIdType

public static final Class<?> objectIdType()

Central architectural information method that always returns long.class.

Returns:

long.class

createDefaultTypeLookup

public static final PersistenceTypeIdLookup createDefaultTypeLookup()

defaultStartTypeId

public static final long defaultStartTypeId()

defaultStartConstantId

public static final long defaultStartConstantId()

defaultStartObjectId

public static final long defaultStartObjectId()

defaultBoundConstantId

public static final long defaultBoundConstantId()

classTypeId

public static final long classTypeId()

isNativeType

public static final boolean isNativeType(Class<?> type)

getNativeTypeId

public static final Long getNativeTypeId(Class<?> type)

registerJavaNatives

public static final <R extends PersistenceObjectRegistry> R registerJavaNatives(R registry)

registerJavaBasicTypes

public static final <R extends PersistenceTypeRegistry> R registerJavaBasicTypes(R registry)

iterateJavaBasicTypes

public static final <C extends BiConsumer<Class<?>,Long>> C iterateJavaBasicTypes(C iterator)

registerJavaConstants

public static final <R extends PersistenceObjectRegistry> R registerJavaConstants(R registry)

validateObjectId

public static long validateObjectId(long id)
                             throws PersistenceExceptionConsistencyInvalidObjectId

Throws:

PersistenceExceptionConsistencyInvalidObjectId

validateTypeId

public static long validateTypeId(long id)
                           throws PersistenceExceptionConsistencyInvalidTypeId

Throws:

PersistenceExceptionConsistencyInvalidTypeId

iterateReferences

public static final void iterateReferences(PersistenceFunction iterator,
                                           Object[] array,
                                           int offset,
                                           int length)

iterateReferences

public static final void iterateReferences(PersistenceFunction iterator,
                                           one.microstream.collections.types.XIterable<?> elements)

iterateReferencesIterable

public static final void iterateReferencesIterable(PersistenceFunction iterator,
                                                   Iterable<?> elements)

iterateReferencesMap

public static final void iterateReferencesMap(PersistenceFunction iterator,
                                              Map<?,?> elements)

standardCharset

public static final Charset standardCharset()

Reasons for choosing UTF8 as the standard charset: 1.) It is independent from endianess. 2.) It is massively smaller due to most content containing almost only single-byte ASCII characters 3.) It is overall more commonly and widespread used and compatible than any specific format.

Returns:

the UTF8 charset

defaultFilenameTypeDictionary

public static String defaultFilenameTypeDictionary()

unpersistableTypes

public static one.microstream.collections.types.XGettingEnum<Class<?>> unpersistableTypes()

Types whose instances cannot be persisted. E.g. Unpersistable, Thread, ClassLoader, etc. Note that the Class instances representing these types are very well persistable and will get empty type descriptions to assign type ids to them. Only their instances cannot be persisted.

Returns:

the types whose instances cannot be persisted

isPersistable

public static boolean isPersistable(Class<?> type)

isUnpersistable

public static boolean isUnpersistable(Class<?> type)

typeMismatchValidatorFailing

public static final <D> PersistenceTypeMismatchValidator<D> typeMismatchValidatorFailing()

typeMismatchValidatorNoOp

public static final <D> PersistenceTypeMismatchValidator<D> typeMismatchValidatorNoOp()

defaultTypeEvaluatorPersistable

public static final PersistenceTypeEvaluator defaultTypeEvaluatorPersistable()

isPersistableField

public static final boolean isPersistableField(Class<?> entityType,
                                               Field field)

defaultFieldEvaluatorPersistable

public static final PersistenceFieldEvaluator defaultFieldEvaluatorPersistable()

defaultFieldEvaluatorPersister

public static final PersistenceFieldEvaluator defaultFieldEvaluatorPersister()

isPersisterField

public static final boolean isPersisterField(Field field)

isHandleableEnumField

public static boolean isHandleableEnumField(Class<?> enumClass,
                                            Field field)

defaultFieldEvaluatorEnum

public static final PersistenceFieldEvaluator defaultFieldEvaluatorEnum()

isHandleableCollectionField

public static boolean isHandleableCollectionField(Class<?> collectionClass,
                                                  Field field)

defaultFieldEvaluatorCollection

public static final PersistenceFieldEvaluator defaultFieldEvaluatorCollection()

defaultReferenceFieldEagerEvaluator

public static final PersistenceEagerStoringFieldEvaluator defaultReferenceFieldEagerEvaluator()

resolveEnumeratedClassIdentifierSeparatedType

public static <T> Class<T> resolveEnumeratedClassIdentifierSeparatedType(String typeName,
                                                                         ClassLoader classLoader,
                                                                         String substituteClassIdentifierSeparator)

resolveType

public static <T> Class<T> resolveType(String typeName,
                                       ClassLoader classLoader)

resolveType

public static <T> Class<T> resolveType(String typeName,
                                       ClassLoader classLoader,
                                       String substituteClassIdentifierSeparator)

tryResolveType

public static <T> Class<T> tryResolveType(String typeName,
                                          ClassLoader classLoader)

deriveEnumRootIdentifier

public static String deriveEnumRootIdentifier(PersistenceTypeHandler<?,?> typeHandler)

collectEnumConstants

public static Object[] collectEnumConstants(PersistenceTypeHandler<?,?> typeHandler)

enumRootIdentifierStart

public static String enumRootIdentifierStart()

parseEnumRootIdentifierTypeId

public static Long parseEnumRootIdentifierTypeId(String enumRootIdentifier)

isEnumRootIdentifier

public static boolean isEnumRootIdentifier(String enumRootIdentifier)

isPotentialEnumRootIdentifier

public static boolean isPotentialEnumRootIdentifier(String enumRootIdentifier)

defaultRootIdentifier

@Deprecated
public static final String defaultRootIdentifier()

Deprecated.

customRootIdentifier

@Deprecated
public static final String customRootIdentifier()

Deprecated.

rootIdentifier

public static final String rootIdentifier()

RefactoringMapping

@Deprecated
public static final PersistenceRefactoringMappingProvider RefactoringMapping(File refactoringsFile)

Deprecated. replaced by RefactoringMapping(Path), will be removed in version 8

Parameters:

refactoringsFile - the file to read from

Returns:

a new mapping provider

RefactoringMapping

public static final PersistenceRefactoringMappingProvider RefactoringMapping(Path refactoringsFile)

RefactoringMapping

public static final PersistenceRefactoringMappingProvider RefactoringMapping(String refactoringMappings)

RefactoringMapping

public static final PersistenceRefactoringMappingProvider RefactoringMapping(String refactoringMappings,
                                                                             char valueSeparator)

RefactoringMapping

public static final PersistenceRefactoringMappingProvider RefactoringMapping(String refactoringMappings,
                                                                             one.microstream.util.xcsv.XCsvDataType dataType)

RefactoringMapping

public static final PersistenceRefactoringMappingProvider RefactoringMapping(String refactoringMappings,
                                                                             one.microstream.util.xcsv.XCsvConfiguration configuration)

RefactoringMapping

public static final PersistenceRefactoringMappingProvider RefactoringMapping(one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> refactoringMappings)

readRefactoringMappings

@Deprecated
public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(File file)

Deprecated. replaced by readRefactoringMappings(Path), will be removed in version 8

Parameters:

file - the file to read from

Returns:

refactoring mappings from the file

readRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(Path file)

readRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(AFile file)

readRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(String string)

readRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(String string,
                                                                                                                                         char valueSeparator)

readRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(String string,
                                                                                                                                         one.microstream.util.xcsv.XCsvDataType dataType)

readRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> readRefactoringMappings(String string,
                                                                                                                                         one.microstream.util.xcsv.XCsvConfiguration configuration)

parseRefactoringMappings

public static one.microstream.collections.types.XGettingSequence<one.microstream.typing.KeyValue<String,String>> parseRefactoringMappings(one.microstream.chars.StringTable stringTable)

substituteClassIdentifierSeparator

public static final String substituteClassIdentifierSeparator()

Persistence-specific separator between a class name and a proper identifier that replaces unreliable class names (like "$1", "$2" etc.) by a reliably identifying substitute name.

Returns:

separator between a class name and a proper identifier

derivePersistentTypeName

public static final String derivePersistentTypeName(Class<?> type)

derivePersistentTypeName

public static final String derivePersistentTypeName(Class<?> type,
                                                    String substituteClassIdentifierSeparator)

derivePersistentTypeNameEnum

public static final String derivePersistentTypeNameEnum(Class<?> type,
                                                        String substituteClassIdentifierSeparator)

searchProvidedTypeHandler

public static <D,T> PersistenceTypeHandler<D,T> searchProvidedTypeHandler(Class<D> dataType,
                                                                          Class<T> entityType,
                                                                          Predicate<? super Method> selector)
                                                                   throws ReflectiveOperationException

Searches the methods of the passed entityType for a static method with arbitrary name and visibility, no arguments and PersistenceTypeHandler or a sub type of it as its return type.

Which method to select is also determined by testing the returned PersistenceTypeHandler instance if it has the correct PersistenceTypeHandler.dataType() for the used persistence context and the correct PersistenceTypeHandler.type() for the given entity class.

This mechanism is a convenience shortcut alternative to PersistenceFoundation.registerCustomTypeHandler(PersistenceTypeHandler).

Type Parameters:

D - the data type

T - the entity type

Parameters:

dataType - the class for the data type

entityType - the class for the entity type

selector - custom selector logic

Returns:

the provided type handler if found

Throws:

ReflectiveOperationException - if a reflection error occurs