org.eclipse.persistence.config.PessimisticLock Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 1998, 2024 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:
// Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.config;
/**
* PessimisticLock hint values.
*
* The class contains all the valid values for QueryHints.PESSIMISTIC_LOCK query hint.
*
* JPA Query Hint Usage:
*
*
query.setHint(QueryHints.PESSIMISTIC_LOCK, PessimisticLock.Lock);
*
or
*
@QueryHint(name=QueryHints.PESSIMISTIC_LOCK, value=PessimisticLock.Lock)
*
*
Hint values are case-insensitive.
* "" could be used instead of default value PessimisticLock.DEFAULT.
*
* @see QueryHints
*
* Note: As of JPA 2.0 there is a standard way to configure pessimistic locking.
* @see jakarta.persistence.LockModeType
* @see jakarta.persistence.EntityManager (find(), refresh(), lock())
* @see jakarta.persistence.Query (setLockMode())
*/
public class PessimisticLock {
public static final String NoLock = "NoLock";
public static final String Lock = "Lock";
public static final String LockNoWait = "LockNoWait";
public static final String DEFAULT = NoLock;
/**
* @deprecated This constructor will be marked private and the class final. It is not designed for extensibility.
*/
@Deprecated(since = "4.0.3", forRemoval = true)
public PessimisticLock() {
// no instance please
}
}