io.permazen

Class PermazenFactory

java.lang.Object

io.permazen.PermazenFactory

public class PermazenFactory
extends Object

Factory for Permazen instances.

If no Database is configured, newly created Permazen instances will use an initially empty, in-memory SimpleKVDatabase.

See Also:

Permazen

Constructor Summary

Constructors

Constructor and Description
PermazenFactory()

Method Summary

Modifier and Type	Method and Description
Permazen	newPermazen() Construct a Permazen instance using this instance's configuration.
PermazenFactory	setDatabase(Database database) Configure the underlying Database for this instance.
PermazenFactory	setModelClasses(Class<?>... modelClasses) Configure the Java model classes.
PermazenFactory	setModelClasses(Iterable<? extends Class<?>> modelClasses) Configure the Java model classes.
PermazenFactory	setSchemaVersion(int schemaVersion) Configure the schema version number associated with the configured Java model classes.
PermazenFactory	setStorageIdGenerator(StorageIdGenerator storageIdGenerator) Configure the StorageIdGenerator for auto-generating storage ID's when not explicitly specified in @PermazenType, @JField, etc., annotations.
PermazenFactory	setValidatorFactory(javax.validation.ValidatorFactory validatorFactory) Configure a custom ValidatorFactory used to create Validators for validation within transactions.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermazenFactory

public PermazenFactory()

Method Detail

setModelClasses

public PermazenFactory setModelClasses(Iterable<? extends Class<?>> modelClasses)

Configure the Java model classes.

Note: @PermazenType-annotated super-types of any class in modelClasses will be included, even if the super-type is not explicitly specified in modelClasses.

Parameters:

modelClasses - classes annotated with @PermazenType annotations

Returns:

this instance

setModelClasses

public PermazenFactory setModelClasses(Class<?>... modelClasses)

Configure the Java model classes.

Equivalent to setModelClasses(Arrays.asList(modelClasses)).

Parameters:

modelClasses - classes annotated with @PermazenType annotations

Returns:

this instance

See Also:

setModelClasses(Iterable)

setDatabase

public PermazenFactory setDatabase(Database database)

Configure the underlying Database for this instance.

By default this instance will use an initially empty, in-memory SimpleKVDatabase.

Parameters:

database - core API database to use

Returns:

this instance

setSchemaVersion

public PermazenFactory setSchemaVersion(int schemaVersion)

Configure the schema version number associated with the configured Java model classes.

A value of zero means to use whatever is the highest version already recorded in the database.

A value of -1 means to auto-generate a version number based on the compatibility hash of the SchemaModel generated from the configured model classes.

Default is -1.

Parameters:

schemaVersion - the schema version number of the schema derived from the configured Java model classes, zero to use the highest version already recorded in the database, or -1 to use an auto-generated schema version

Returns:

this instance

setStorageIdGenerator

public PermazenFactory setStorageIdGenerator(StorageIdGenerator storageIdGenerator)

Configure the StorageIdGenerator for auto-generating storage ID's when not explicitly specified in @PermazenType, @JField, etc., annotations.

This instance will initially be configured with a DefaultStorageIdGenerator. To disable auto-generation of storage ID's altogether, configure a null value here.

Parameters:

storageIdGenerator - storage ID generator, or null to disable auto-generation of storage ID's

Returns:

this instance

setValidatorFactory

public PermazenFactory setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)

Configure a custom ValidatorFactory used to create Validators for validation within transactions.

The default is to use the result from Validation.buildDefaultValidatorFactory().

Parameters:

validatorFactory - factory for validators

Returns:

this instance

Throws:

IllegalArgumentException - if validatorFactory is null

newPermazen

public Permazen newPermazen()

Construct a Permazen instance using this instance's configuration.

Returns:

newly created Permazen database

Throws:

IllegalArgumentException - if this instance has an incomplete or invalid configuration

IllegalArgumentException - if any Java model class has an invalid annotation