org.firebirdsql.jdbc.Synchronizable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaybird-jdk15 Show documentation

JDBC Driver for the Firebird RDBMS

There is a newer version: 2.2.7

/*
 * Firebird Open Source J2ee connector - jdbc driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a CVS history command.
 *
 * All rights reserved.
 */

package org.firebirdsql.jdbc;

import java.sql.SQLException;

/**
 * Provides synchronization object. Instances implementing this interface
 * provide objects that are later used in synchronized block:
 *  * Object syncObject = someSynchronizable.getSynchronizationObject();
 * synchronized(syncObject) {
 *     // do something...
 * }
 * 
 * 
 * @author Roman Rokytskyy
 */
public interface Synchronizable {
    
    /**
     * Get synchronization object.
     * 
     * @return object, cannot be null.
     * 
     * @throws SQLException if something went wrong.
     */
    Object getSynchronizationObject() throws SQLException;
}