jakarta.persistence.CacheRetrieveMode Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Linda DeMichiel - 2.1
// Linda DeMichiel - 2.0
package jakarta.persistence;
/**
* Specifies how the {@link EntityManager} interacts with the
* second-level cache when data is read from the database via
* the {@link EntityManager#find} methods and execution of
* queries.
*
* - {@link #USE} indicates that data may be read from the
* second-level cache.
*
- {@link #BYPASS} indicates that data may not be read
* from the second-level cache.
*
*
* Enumerates legal values of the property
* {@code jakarta.persistence.cache.retrieveMode}.
*
* @see EntityManager#setCacheRetrieveMode(CacheRetrieveMode)
* @see Query#setCacheRetrieveMode(CacheRetrieveMode)
*
* @since 2.0
*/
public enum CacheRetrieveMode implements FindOption {
/**
* Read entity data from the cache: this is the default
* behavior.
*/
USE,
/**
* Bypass the cache: get data directly from the database.
*/
BYPASS
}