Package io.permazen

Abstraction layer allowing access to a Database using normal Java objects.

See: Description

Interface Summary

Interface	Description
JFieldSwitch<R>	Visitor pattern interface for JFields.
JObject	Interface implemented by Permazen Java model objects.
Session.Action	Callback interface used by Session.performSessionAction() and Session.performSessionActionWithCurrentTransaction().
Session.HasTransactionOptions	Interface implemented by Session.TransactionalAction's that want to provide custom transaction options.
Session.RetryableAction	Tagging interface indicating a Session.TransactionalAction that should be retried if a RetryTransactionException is thrown.
Session.TransactionalAction	Tagging interface indicating an Session.Action that requires there to be an open transaction.
StorageIdGenerator	Used to auto-generate storage ID's for Java model classes, fields, and composite indexes when not specified explicitly in the corresponding @PermazenType, @JField, etc., annotations.
UniquenessConstraints	JSR 303 validation group for Permazen uniqueness constraints.

Class Summary

Class	Description
CopyState	Maintains state about a multi-object copy operation.
Counter	Represents a 64-bit counter value that can be adjusted concurrently by multiple transactions, typically without locking (depending on the underlying key/value store).
DefaultStorageIdGenerator	Default StorageIdGenerator implementation.
EnumConverter<T extends Enum<T>>	Converts between core database EnumValue objects and the corresponding Java Enum model values.
ExportContext	Context for exporting plain (POJO) objects from a JTransaction.
ImportContext	Context for importing plain (POJO) objects into a JTransaction.
JClass<T>	Information about a Java class that is used to represent a specific Permazen object type.
JCollectionField	Represents a collection field in a JClass.
JComplexField	Represents a complex field in a JClass.
JCompositeIndex	A composite index.
JCounterField	Represents a counter field in a JClass.
JEnumArrayField	Represents an Enum array field in a JClass.
JEnumField	Represents an Enum field in a JClass.
JField	Represents a field in a Java model object.
JFieldSwitchAdapter<R>	Adapter class for JFieldSwitch.
JListField	Represents a list field in a JClass.
JMapField	Represents a map field in a JClass.
JReferenceField	Represents a reference field in a JClass or a reference sub-field of a complex field in a JClass.
JSchemaObject	Superclass for the JClass and JField classes which define the schema associated with a Permazen.
JSetField	Represents a set field in a JClass.
JSimpleField	Represents a simple field in a JClass or a simple sub-field of a complex field in a JClass.
JTransaction	A transaction associated with a Permazen instance.
Permazen	Permazen Java persistence layer.
PermazenFactory	Factory for Permazen instances.
ReferencePath	Reference paths.
Session	Utility class for programmatic Permazen database access.
SnapshotJTransaction	A "snapshot" JTransaction that persists indefinitely.
UntypedJObject	Represents a JObject for which no Java model type is defined in the instance's associated schema version.
Util	Various utility routines.
Version	Contains Permazen library version information.

Enum Summary

Enum	Description
SessionMode	Session modes.
UpgradeConversionPolicy	Policies to apply when a simple or counter field's type changes during a schema update.
ValidationMode	Configures whether and how objects are enqueued for validation in a JTransaction.

Exception Summary

Exception	Description
PermazenException	Superclass of all unchecked exceptions thrown by the Permazen API.
UpgradeConversionException	Exception thrown when an object is upgraded, some simple field's type changes, the field is configured with UpgradeConversionPolicy.REQUIRE, and automated conversion of the field's value to the new type fails.
ValidationException	Thrown when JTransaction.validate() (or JTransaction.commit()) fails due to one or more validation errors.

Package io.permazen Description

Abstraction layer allowing access to a Database using normal Java objects.

See Also:

Permazen, Database, The Permazen Project