jsqlite.Backup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgt-dbs Show documentation
The newest version!
package jsqlite;

/**
 * Class wrapping an SQLite backup object.
 */

public class Backup {

    /**
     * Internal handle for the native SQLite API.
     */

    protected long handle = 0;

    /**
     * Finish a backup.
     */

    protected void finish() throws jsqlite.Exception {
        synchronized (this) {
            _finalize();
        }
    }

    /**
     * Destructor for object.
     */

    protected void finalize() {
        synchronized (this) {
            try {
                _finalize();
            } catch (jsqlite.Exception e) {
            }
        }
    }

    protected native void _finalize() throws jsqlite.Exception;

    /**
     * Perform a backup step.
     *
     * @param n number of pages to backup
     * @return true when backup completed
     * @throws jsqlite.Exception  if something goes wrong.
     */

    public boolean step( int n ) throws jsqlite.Exception {
        synchronized (this) {
            return _step(n);
        }
    }

    private native boolean _step( int n ) throws jsqlite.Exception;

    /**
     * Perform the backup in one step.
     */
    public void backup() throws jsqlite.Exception {
        synchronized (this) {
            _step(-1);
        }
    }

    /**
     * Return number of remaining pages to be backed up.
     */

    public int remaining() throws jsqlite.Exception {
        synchronized (this) {
            return _remaining();
        }
    }

    private native int _remaining() throws jsqlite.Exception;

    /**
     * Return the total number of pages in the backup source database.
     */

    public int pagecount() throws jsqlite.Exception {
        synchronized (this) {
            return _pagecount();
        }
    }

    private native int _pagecount() throws jsqlite.Exception;

    /**
     * Internal native initializer.
     */

    private static native void internal_init();

    static {
        internal_init();
    }
}