Package io.permazen

Enum Class ValidationMode

java.lang.Object

java.lang.Enum<ValidationMode>

io.permazen.ValidationMode

All Implemented Interfaces:

Serializable, Comparable<ValidationMode>, Constable

public enum ValidationMode
extends Enum<ValidationMode>

Configures whether and how objects are enqueued for validation in a PermazenTransaction.

See Also:

• PermazenTransaction.validate()
• PermazenObject.revalidate(java.lang.Class<?>...)
• OnValidate

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC	Objects are enqueued for validation automatically (if necessary) when they are modified.
DISABLED	Validation is disabled.
MANUAL	Objects are enqueued for validation only when PermazenObject.revalidate(java.lang.Class<?>...) is explicitly invoked.

Method Summary

Modifier and Type	Method	Description
static ValidationMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ValidationMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final ValidationMode DISABLED

Validation is disabled. No objects are enqueued for validation, even if PermazenObject.revalidate(java.lang.Class<?>...) is invoked.

MANUAL

public static final ValidationMode MANUAL

Objects are enqueued for validation only when PermazenObject.revalidate(java.lang.Class<?>...) is explicitly invoked.

AUTOMATIC

public static final ValidationMode AUTOMATIC

Objects are enqueued for validation automatically (if necessary) when they are modified.

In this mode, objects are enqueued for validation whenever PermazenObject.revalidate(java.lang.Class<?>...) is invoked; in addition, objects are enqueued for validation automatically as if by PermazenObject.revalidate(java.lang.Class<?>...) when:

• An instance is created, and the Java model type (or any super-type) has a JSR 303 annotated public method or @OnValidate annoted method
• An instance is migrated, and the Java model type (or any super-type) has a JSR 303 annotated public method or @OnValidate annoted method
• An instance field is modified, and the corresponding Java model `getter' method has any JSR 303 annotations

Note that the presence of a @OnValidate annotation on a method does not in itself result in automatic validation when any field changes (it merely specifies an action to take when validation occurs). To trigger revalidation after field changes, add @OnChange-annotated method(s) that invoke this.revalidate().

Note that AUTOMATIC enqueues as if by PermazenObject.revalidate(java.lang.Class<?>...), i.e., the Default validation group applies. Therefore, if a constraint has explicit groups(), and none extend Default, then it will not be applied automatically.

Method Details

values

public static ValidationMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ValidationMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null