EclipseLink 2.3.2, build 'v20111125-r10461' API Reference

org.eclipse.persistence.annotations
Enum CacheCoordinationType

java.lang.Object
  extended by java.lang.Enum<CacheCoordinationType>
      extended by org.eclipse.persistence.annotations.CacheCoordinationType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CacheCoordinationType>

public enum CacheCoordinationType
extends java.lang.Enum<CacheCoordinationType>

An enum that is used within the Cache annotation.

See Also:
Cache
Author:
Guy Pelletier
Since:
Oracle TopLink 11.1.1.0.0

Enum Constant Summary
INVALIDATE_CHANGED_OBJECTS
          Sends a list of the identities of the objects that have changed.
NONE
          Does no cache coordination.
SEND_NEW_OBJECTS_WITH_CHANGES
          Same as SEND_OBJECT_CHANGES except it also includes any newly created objects from the transaction.
SEND_OBJECT_CHANGES
          Sends a list of changed objects including data about the changes.
 
Method Summary
static CacheCoordinationType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CacheCoordinationType[] 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

SEND_OBJECT_CHANGES

public static final CacheCoordinationType SEND_OBJECT_CHANGES
Sends a list of changed objects including data about the changes. This data is merged into the receiving cache.


INVALIDATE_CHANGED_OBJECTS

public static final CacheCoordinationType INVALIDATE_CHANGED_OBJECTS
Sends a list of the identities of the objects that have changed. The receiving cache invalidates the objects (rather than changing any of the data)


SEND_NEW_OBJECTS_WITH_CHANGES

public static final CacheCoordinationType SEND_NEW_OBJECTS_WITH_CHANGES
Same as SEND_OBJECT_CHANGES except it also includes any newly created objects from the transaction.


NONE

public static final CacheCoordinationType NONE
Does no cache coordination.

Method Detail

values

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

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

valueOf

public static CacheCoordinationType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

EclipseLink 2.3.2, build 'v20111125-r10461' API Reference