Java EE 5 SDK

javax.persistence
Class OptimisticLockException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by javax.persistence.PersistenceException
                  extended by javax.persistence.OptimisticLockException
All Implemented Interfaces:
Serializable

public class OptimisticLockException
extends PersistenceException

Thrown by the persistence provider when an optimistic 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 1.0
See Also:
Serialized Form

Constructor Summary
OptimisticLockException()
          Constructs a new OptimisticLockException exception with null as its detail message.
OptimisticLockException(Object entity)
          Constructs a new OptimisticLockException exception with the specified entity.
OptimisticLockException(String message)
          Constructs a new OptimisticLockException exception with the specified detail message.
OptimisticLockException(String message, Throwable cause)
          Constructs a new OptimisticLockException exception with the specified detail message and cause.
OptimisticLockException(String message, Throwable cause, Object entity)
          Constructs a new OptimisticLockException exception with the specified detail message, cause, and entity.
OptimisticLockException(Throwable cause)
          Constructs a new OptimisticLockException exception with the specified cause.
 
Method Summary
 Object getEntity()
          Returns the entity that caused this exception.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OptimisticLockException

public OptimisticLockException()
Constructs a new OptimisticLockException exception with null as its detail message.


OptimisticLockException

public OptimisticLockException(String message)
Constructs a new OptimisticLockException exception with the specified detail message.

Parameters:
message - the detail message.

OptimisticLockException

public OptimisticLockException(String message,
                               Throwable cause)
Constructs a new OptimisticLockException exception with the specified detail message and cause.

Parameters:
message - the detail message.
cause - the cause.

OptimisticLockException

public OptimisticLockException(Throwable cause)
Constructs a new OptimisticLockException exception with the specified cause.

Parameters:
cause - the cause.

OptimisticLockException

public OptimisticLockException(Object entity)
Constructs a new OptimisticLockException exception with the specified entity.

Parameters:
entity - the entity.

OptimisticLockException

public OptimisticLockException(String message,
                               Throwable cause,
                               Object entity)
Constructs a new OptimisticLockException exception with the specified detail message, cause, and entity.

Parameters:
message - the detail message.
cause - the cause.
entity - the entity.
Method Detail

getEntity

public Object getEntity()
Returns the entity that caused this exception.

Returns:
the entity.

Java EE 5 SDK

Submit a bug or feature

Copyright 2006 Sun Microsystems, Inc. All rights reserved.