io.permazen.core

Enum DeleteAction

java.lang.Object

java.lang.Enum<DeleteAction>

io.permazen.core.DeleteAction

All Implemented Interfaces:

Serializable, Comparable<DeleteAction>

public enum DeleteAction
extends Enum<DeleteAction>

Describes what action to take when an object that is still referred to by some other object is deleted.

See Also:

Transaction.delete(), ReferenceSchemaField.getOnDelete()

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE Also delete the object containing the reference.
EXCEPTION Disallow deleting the object, instead throwing ReferencedObjectException.
NOTHING Do nothing.
UNREFERENCE Remove the reference, either by setting it to null (in the case of a SimpleField in an object), or by removing the corresponding collection element or key/value pair (in the case of a ComplexField sub-field).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOTHING

public static final DeleteAction NOTHING

Do nothing. The reference will still exist, but subsequent attempts to access the fields of the deleted object will result in DeletedObjectException.

EXCEPTION

public static final DeleteAction EXCEPTION

Disallow deleting the object, instead throwing ReferencedObjectException. This is the default if not specified.

Note: deleting an object that is only referred to by itself will not cause any exception to be thrown.

UNREFERENCE

public static final DeleteAction UNREFERENCE

Remove the reference, either by setting it to null (in the case of a SimpleField in an object), or by removing the corresponding collection element or key/value pair (in the case of a ComplexField sub-field).

DELETE

public static final DeleteAction DELETE

Also delete the object containing the reference. This action will be repeated recursively, if necessary.

Method Detail

values

public static DeleteAction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DeleteAction c : DeleteAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static DeleteAction valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null