javax.persistence.PessimisticLockException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation

Hibernate definition of the Java Persistence 2.0 (JSR 317) API.

There is a newer version: 1.0.1.Final

Show newest version

// $Id: PessimisticLockException.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence;

/**
 * Thrown by the persistence provider when an pessimistic locking conflict
 * occurs. This exception may be thrown as part of an API call, a flush or at
 * commit time. The current transaction, if one is active, will be marked for
 * rollback.
 *
 * @since Java Persistence 2.0
 */
public class PessimisticLockException extends PersistenceException {
	/**
	 * The object that caused the exception
	 */
	Object entity;

	/**
	 * Constructs a new PessimisticLockException exception
	 * with null as its detail message.
	 */
	public PessimisticLockException() {
		super();
	}

	/**
	 * Constructs a new PessimisticLockException exception
	 * with the specified detail message.
	 *
	 * @param message the detail message.
	 */
	public PessimisticLockException(String message) {
		super( message );
	}

	/**
	 * Constructs a new PessimisticLockException exception
	 * with the specified detail message and cause.
	 *
	 * @param message the detail message.
	 * @param cause the cause.
	 */
	public PessimisticLockException(String message, Throwable cause) {
		super( message, cause );
	}

	/**
	 * Constructs a new PessimisticLockException exception
	 * with the specified cause.
	 *
	 * @param cause the cause.
	 */
	public PessimisticLockException(Throwable cause) {
		super( cause );
	}

	/**
	 * Constructs a new PessimisticLockException exception
	 * with the specified entity.
	 *
	 * @param entity the entity.
	 */
	public PessimisticLockException(Object entity) {
		this.entity = entity;
	}

	/**
	 * Constructs a new PessimisticLockException exception
	 * with the specified detail message, cause, and entity.
	 *
	 * @param message the detail message.
	 * @param cause the cause.
	 * @param entity the entity.
	 */
	public PessimisticLockException(String message, Throwable cause, Object entity) {
		super( message, cause );
		this.entity = entity;
	}

	/**
	 * Returns the entity that caused this exception.
	 *
	 * @return the entity.
	 */
	public Object getEntity() {
		return this.entity;
	}
}