Package io.permazen

Class PermazenConfig

java.lang.Object

io.permazen.PermazenConfig

public final class PermazenConfig
extends Object

Configuration object used to create new Permazen instances.

See Also:

• Permazen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PermazenConfig.Builder	Builder for PermazenConfigs.

Method Summary

Modifier and Type	Method	Description
static PermazenConfig.Builder	builder()	Create a PermazenConfig.Builder.
Database	getDatabase()	Get the underlying Database to be used.
Set<Class<?>>	getModelClasses()	Get the Java model classes to be used.
jakarta.validation.ValidatorFactory	getValidatorFactory()	Get the ValidatorFactory that will create the Validators used for validation within transactions.
boolean	isInitializeOnCreation()	Determine whether the Permazen instance should initialize() automatically on instantiation.
Permazen	newPermazen()	Convenience method that uses this instance to create a new Permazen instance.

Methods inherited from class java.lang.Object

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

Method Details

getDatabase

public Database getDatabase()

Get the underlying Database to be used.

Returns:

core API database to use

getValidatorFactory

public jakarta.validation.ValidatorFactory getValidatorFactory()

Get the ValidatorFactory that will create the Validators used for validation within transactions.

Returns:

factory for validators, or null to use the default

getModelClasses

public Set<Class<?>> getModelClasses()

Get the Java model classes to be used.

Returns:

Java database model classes

isInitializeOnCreation

public boolean isInitializeOnCreation()

Determine whether the Permazen instance should initialize() automatically on instantiation.

Returns:

true to initialize on instantiation, false to defer initialization

builder

public static PermazenConfig.Builder builder()

Create a PermazenConfig.Builder.

Returns:

new PermazenConfig builder

newPermazen

public Permazen newPermazen()

Convenience method that uses this instance to create a new Permazen instance.

Returns:

new database instance using this configuration

See Also:

• Permazen(PermazenConfig)