PlotSquared/PlotSquared/src/main/java/com/intellectualcrafters/plot/database/Database.java

////////////////////////////////////////////////////////////////////////////////////////////////////
// PlotSquared - A plot manager and world generator for the Bukkit API                             /
// Copyright (c) 2014 IntellectualSites/IntellectualCrafters                                       /
//                                                                                                 /
// This program is free software; you can redistribute it and/or modify                            /
// it under the terms of the GNU General Public License as published by                            /
// the Free Software Foundation; either version 3 of the License, or                               /
// (at your option) any later version.                                                             /
//                                                                                                 /
// 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                                   /
// GNU General Public License for more details.                                                    /
//                                                                                                 /
// You should have received a copy of the GNU General Public License                               /
// along with this program; if not, write to the Free Software Foundation,                         /
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA                               /
//                                                                                                 /
// You can contact us via: support@intellectualsites.com                                           /
////////////////////////////////////////////////////////////////////////////////////////////////////
package com.intellectualcrafters.plot.database;

import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;

import com.intellectualcrafters.plot.PlotSquared;

/**
 * Abstract Database class, serves as a base for any connection method (MySQL, SQLite, etc.)
 *
 * @author -_Husky_-
 * @author tips48
 */
public abstract class Database {
    /**
     * Plugin instance, use for plugin.getDataFolder()
     */
    protected final PlotSquared plotsquared;
    
    /**
     * Creates a new Database
     *
     * @param plotsquared Plugin instance
     */
    protected Database(final PlotSquared plotsquared) {
        this.plotsquared = plotsquared;
    }
    
    /**
     * Opens a connection with the database
     *
     * @return Opened connection
     *
     * @throws SQLException           if the connection can not be opened
     * @throws ClassNotFoundException if the driver cannot be found
     */
    public abstract Connection openConnection() throws SQLException, ClassNotFoundException;
    
    /**
     * Checks if a connection is open with the database
     *
     * @return true if the connection is open
     *
     * @throws SQLException if the connection cannot be checked
     */
    public abstract boolean checkConnection() throws SQLException;
    
    /**
     * Gets the connection with the database
     *
     * @return Connection with the database, null if none
     */
    public abstract Connection getConnection();
    
    /**
     * Closes the connection with the database
     *
     * @return true if successful
     *
     * @throws SQLException if the connection cannot be closed
     */
    public abstract boolean closeConnection() throws SQLException;
    
    /**
     * Executes a SQL Query<br> If the connection is closed, it will be opened
     *
     * @param query Query to be run
     *
     * @return the results of the query
     *
     * @throws SQLException           If the query cannot be executed
     * @throws ClassNotFoundException If the driver cannot be found; see {@link #openConnection()}
     */
    public abstract ResultSet querySQL(final String query) throws SQLException, ClassNotFoundException;
    
    /**
     * Executes an Update SQL Query<br> See {@link java.sql.Statement#executeUpdate(String)}<br> If the connection is
     * closed, it will be opened
     *
     * @param query Query to be run
     *
     * @return Result Code, see {@link java.sql.Statement#executeUpdate(String)}
     *
     * @throws SQLException           If the query cannot be executed
     * @throws ClassNotFoundException If the driver cannot be found; see {@link #openConnection()}
     */
    public abstract int updateSQL(final String query) throws SQLException, ClassNotFoundException;
}