javax.persistence.PessimisticLockException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of persistence-api Show documentation
The newest version!
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 {
	private static final long serialVersionUID = 1L;

	/**
	 * 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 entity.
	 * 
	 * @param entity
	 *            the entity.
	 */
	public PessimisticLockException(Object entity) {
		this.entity = entity;
	}

	/**
	 * 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 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;
	}

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

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