javax.persistence.SharedCacheMode Maven / Gradle / Ivy

Go to download
package javax.persistence;

/**
 * Specifies how the provider must use a second-level cache for the persistence unit. Corresponds to the value of the
 * persistence.xml shared-cache-mode element, and returned as the result of
 * {@link javax.persistence.spi.PersistenceUnitInfo#getSharedCacheMode()}.
 * 
 * @since Java Persistence 2.0
 */
public enum SharedCacheMode {
	/**
	 * All entities and entity-related state and data are cached.
	 */
	ALL,

	/**
	 * Caching is disabled for the persistence unit.
	 */
	NONE,

	/**
	 * Caching is enabled for all entities for Cacheable(true) is specified. All other entities are not cached.
	 */
	ENABLE_SELECTIVE,

	/**
	 * Caching is enabled for all entities except those for which Cacheable(false) is specified.  Entities for which
	 * Cacheable(false) is specified are not cached.
	 */
	DISABLE_SELECTIVE,

	/**
	 * 
	 * Caching behavior is undefined: provider-specific defaults may apply.
	 */
	UNSPECIFIED
}