Package org.hibernate.annotations

Enum CascadeType

java.lang.Object

java.lang.Enum<CascadeType>

org.hibernate.annotations.CascadeType

All Implemented Interfaces:

Serializable, Comparable<CascadeType>

public enum CascadeType
extends Enum<CascadeType>

Enumerates the persistence operations which may be cascaded from one entity instance to associated entity instances.

This enumeration of cascade types competes with the JPA-defined enumeration CascadeType, but offers additional options, including LOCK.

To enable cascade LOCK, use @Cascade, for example:

 @OneToMany(mappedBy="parent")
 @Cascade({PERSIST,REFRESH,REMOVE,LOCK})
 Set<Child> children;
 

See Also:

Cascade

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Includes all types listed here.
DELETE	Deprecated. since Session.delete(Object) is deprecated
DELETE_ORPHAN	Ancient versions of Hibernate treated orphan removal as a specialized type of cascade.
DETACH	Equivalent to CascadeType.DETACH.
LOCK	A cascade type for the lock() operation.
MERGE	Equivalent to CascadeType.MERGE.
PERSIST	Equivalent to CascadeType.PERSIST.
REFRESH	Equivalent to CascadeType.REFRESH.
REMOVE	Equivalent to CascadeType.REMOVE.
REPLICATE	Deprecated. since Session.replicate(Object, ReplicationMode) is deprecated
SAVE_UPDATE	Deprecated. since Session.saveOrUpdate(Object) is deprecated

Method Summary

Modifier and Type	Method	Description
static CascadeType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CascadeType[]	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

ALL

public static final CascadeType ALL

Includes all types listed here. Equivalent to CascadeType.ALL.

PERSIST

public static final CascadeType PERSIST

Equivalent to CascadeType.PERSIST.

See Also:

EntityManager.persist(Object)

MERGE

public static final CascadeType MERGE

Equivalent to CascadeType.MERGE.

See Also:

EntityManager.merge(Object)

REMOVE

public static final CascadeType REMOVE

Equivalent to CascadeType.REMOVE.

See Also:

EntityManager.remove(Object)

REFRESH

public static final CascadeType REFRESH

Equivalent to CascadeType.REFRESH.

See Also:

EntityManager.refresh(Object)

DETACH

public static final CascadeType DETACH

Equivalent to CascadeType.DETACH.

See Also:

EntityManager.detach(Object)

LOCK

public static final CascadeType LOCK

A cascade type for the lock() operation.

This cascade type has no equivalent in JPA.

See Also:

Session.lock(Object, LockMode)

DELETE

@Deprecated
public static final CascadeType DELETE

Deprecated.

since Session.delete(Object) is deprecated

A cascade type for the delete() operation.

This is actually a synonym for REMOVE.

See Also:

Session.delete(Object)

SAVE_UPDATE

@Deprecated
public static final CascadeType SAVE_UPDATE

Deprecated.

since Session.saveOrUpdate(Object) is deprecated

A cascade type for the saveOrUpdate() operation.

See Also:

Session.saveOrUpdate(Object)

REPLICATE

@Deprecated
public static final CascadeType REPLICATE

Deprecated.

since Session.replicate(Object, ReplicationMode) is deprecated

A cascade type for the replicate() operation.

See Also:

Session.replicate(Object, ReplicationMode)

DELETE_ORPHAN

@Internal
public static final CascadeType DELETE_ORPHAN

Ancient versions of Hibernate treated orphan removal as a specialized type of cascade. But since JPA 1.0, orphan removal is considered a completely separate setting, and may be enabled by annotating a one-to-one or one-to-many association @OneToOne(orphanRemoval=true) or @OneToMany(orphanRemoval=true).

API Note:

This is now valid only for internal usage.

Method Detail

values

public static CascadeType[] 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 (CascadeType c : CascadeType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CascadeType 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