javax.persistence.OptimisticLockException Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.persistence;
/**
* 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
*/
public class OptimisticLockException extends PersistenceException {
/** The object that caused the exception */
Object entity;
/**
* Constructs a new OptimisticLockException exception
* with null as its detail message.
*/
public OptimisticLockException() {
super();
}
/**
* Constructs a new OptimisticLockException exception
* with the specified detail message.
* @param message the detail message.
*/
public OptimisticLockException(String message) {
super(message);
}
/**
* Constructs a new OptimisticLockException exception
* with the specified detail message and cause.
* @param message the detail message.
* @param cause the cause.
*/
public OptimisticLockException(String message, Throwable cause) {
super(message, cause);
}
/**
* Constructs a new OptimisticLockException exception
* with the specified cause.
* @param cause the cause.
*/
public OptimisticLockException(Throwable cause) {
super(cause);
}
/**
* Constructs a new OptimisticLockException exception
* with the specified entity.
* @param entity the entity.
*/
public OptimisticLockException(Object entity) {
this.entity = entity;
}
/**
* Constructs a new OptimisticLockException exception
* with the specified detail message, cause, and entity.
* @param message the detail message.
* @param cause the cause.
* @param entity the entity.
*/
public OptimisticLockException(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;
}
};