javax.persistence.LockTimeoutException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ow2-jpa-2.0-spec Show documentation
JPA API of Java EE 6.0
The newest version!
/*
 * Copyright 2010 Bull S.A.S.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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.
 * @see JPA 2.0 specification
 * @author Florent Benoit
 * @since JPA 2.0 version.
 */
public class LockTimeoutException extends PersistenceException {

    /**
     * UID for serialization.
     */
    private static final long serialVersionUID = 8334214437425731690L;

    /**
     * Entity object.
     */
    // FIXME: not private in the spec !
    Object entity = null;

    /**
     * Default constructor : builds an exception with an empty message.
     */
    public LockTimeoutException() {
        super();
    }

    /**
     * Build an exception with the given entity object.
     * @param entity the given entity to use.
     */
    public LockTimeoutException(Object entity) {
        this();
        this.entity = entity;
    }

    /**
     * Build an exception with the given message.
     * @param message the given message to use.
     */
    public LockTimeoutException(final String message) {
        super(message);
    }

    /**
     * Build an exception with the given exception.
     * @param causedByThrowable the cause of this exception.
     */
    public LockTimeoutException(final Throwable causedByThrowable) {
        super(causedByThrowable);
    }

    /**
     * Builds an exception with a given message and given exception.
     * @param message the message of this exception.
     * @param causedByThrowable the cause of this exception.
     */
    public LockTimeoutException(final String message, final Throwable causedByThrowable) {
        super(message, causedByThrowable);
    }

    /**
     * Builds an exception with a given message and given exception.
     * @param message the message of this exception.
     * @param causedByThrowable the cause of this exception.
     */
    public LockTimeoutException(final String message, final Throwable causedByThrowable, Object entity) {
        super(message, causedByThrowable);
        this.entity = entity;
    }

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

}