/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence;

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

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

  
Constructs a new LockTimeoutException exception
with the specified detail message.
Params:
message – the detail message./**
   * Constructs a new <code>LockTimeoutException</code> exception
   * with the specified detail message.
   *
   * @param message the detail message.
   */
  public LockTimeoutException(String message) {
    super(message);
  }

  
Constructs a new LockTimeoutException exception
with the specified detail message and cause.
Params:
message – the detail message.
cause –   the cause./**
   * Constructs a new <code>LockTimeoutException</code> exception
   * with the specified detail message and cause.
   *
   * @param message the detail message.
   * @param cause   the cause.
   */
  public LockTimeoutException(String message, Throwable cause) {
    super(message, cause);
  }

  
Constructs a new LockTimeoutException exception
with the specified cause.
Params:
cause – the cause./**
   * Constructs a new <code>LockTimeoutException</code> exception
   * with the specified cause.
   *
   * @param cause the cause.
   */
  public LockTimeoutException(Throwable cause) {
    super(cause);
  }

  
Constructs a new LockTimeoutException exception
with the specified object.
Params:
entity – the entity./**
   * Constructs a new <code>LockTimeoutException</code> exception
   * with the specified object.
   *
   * @param entity the entity.
   */
  public LockTimeoutException(Object entity) {
    this.entity = entity;
  }

  
Constructs a new LockTimeoutException exception
with the specified detail message, cause, and entity.
Params:
message – the detail message.
cause –   the cause.
entity –  the entity./**
   * Constructs a new <code>LockTimeoutException</code> exception
   * with the specified detail message, cause, and entity.
   *
   * @param message the detail message.
   * @param cause   the cause.
   * @param entity  the entity.
   */
  public LockTimeoutException(String message, Throwable cause, Object entity) {
    super(message, cause);
    this.entity = entity;
  }

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