Module eclipselink

Package org.eclipse.persistence.annotations

Enum Class DatabaseChangeNotificationType

java.lang.Object

java.lang.Enum<DatabaseChangeNotificationType>

org.eclipse.persistence.annotations.DatabaseChangeNotificationType

All Implemented Interfaces:

Serializable, Comparable<DatabaseChangeNotificationType>, Constable

public enum DatabaseChangeNotificationType
extends Enum<DatabaseChangeNotificationType>

Configures what type of database change notification an entity/descriptor should use. This is only relevant if the persistence unit/session has been configured with a DatabaseEventListener, such as the org.eclipse.persistence.platform.database.oracle.dcn.OracleChangeNotificationListener that receives database change events. This allows for the EclipseLink cache to be invalidated or updated from database changes.

See Also:

• Cache.databaseChangeNotificationType()
• CachePolicy.setDatabaseChangeNotificationType(DatabaseChangeNotificationType)

Author:

James Sutherland

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
INVALIDATE	Invalidates the EclipseLink cache when a database change event is received for an object.
NONE	No database change events will be processed.

Method Summary

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

NONE

public static final DatabaseChangeNotificationType NONE

No database change events will be processed.

INVALIDATE

public static final DatabaseChangeNotificationType INVALIDATE

Invalidates the EclipseLink cache when a database change event is received for an object. This requires a DatabaseEventListener to be configured with the persistence unit or session. This requires that the database change can be determined to affect the object, some database change events, such as the org.eclipse.persistence.platform.database.oracle.dcn.OracleChangeNotificationListener (Oracle DCN/QCN) only give the ROWID, so changes to secondary table or relationships may not be able to be determined to affect and object unless its version is also changed.

Method Details

values

public static DatabaseChangeNotificationType[] 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 DatabaseChangeNotificationType 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