main.java.com.djrapitops.plan.database

Class Database

java.lang.Object

main.java.com.djrapitops.plan.database.Database

Direct Known Subclasses:

SQLDB

public abstract class Database
extends Object

Abstract class representing a Database.

Author:

Rsl1122

Constructor Summary

Constructors

Constructor and Description
Database(Plan plugin) Super constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	clean()
abstract void	close()
abstract HashMap<String,Integer>	getCommandUse()
String	getConfigName()
org.bukkit.configuration.ConfigurationSection	getConfigSection()
abstract List<org.bukkit.Location>	getLocations(String userId, HashMap<String,org.bukkit.World> worlds)
abstract String	getName()
abstract Set<UUID>	getSavedUUIDs()
abstract int	getUserId(String uuid)
abstract int	getVersion()
abstract void	giveUserDataToProcessors(UUID uuid, Collection<DBCallableProcessor> processors)
void	giveUserDataToProcessors(UUID uuid, DBCallableProcessor... processors)
boolean	init() Initiates the database.
abstract boolean	removeAccount(String uuid)
abstract boolean	removeAllData()
abstract void	saveCommandUse(HashMap<String,Integer> data)
abstract void	saveMultipleUserData(List<UserData> data)
abstract void	saveUserData(UUID uuid, UserData data)
abstract void	setVersion(int version)
abstract boolean	wasSeenBefore(UUID uuid)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Database

public Database(Plan plugin)

Super constructor.

Parameters:

plugin - current instance of Plan.

Method Detail

init

public boolean init()

Initiates the database. Default method returns false.

Returns:

Was the initiation successful?

giveUserDataToProcessors

public void giveUserDataToProcessors(UUID uuid,
                                     DBCallableProcessor... processors)
                              throws SQLException

Parameters:

uuid -

processors -

Throws:

SQLException

giveUserDataToProcessors

public abstract void giveUserDataToProcessors(UUID uuid,
                                              Collection<DBCallableProcessor> processors)
                                       throws SQLException

Parameters:

uuid -

processors -

Throws:

SQLException

saveUserData

public abstract void saveUserData(UUID uuid,
                                  UserData data)
                           throws SQLException

Parameters:

uuid -

data -

Throws:

SQLException

saveMultipleUserData

public abstract void saveMultipleUserData(List<UserData> data)
                                   throws SQLException

Parameters:

data -

Throws:

SQLException

wasSeenBefore

public abstract boolean wasSeenBefore(UUID uuid)

Parameters:

uuid -

Returns:

clean

public abstract void clean()

getName

public abstract String getName()

Returns:

getConfigName

public String getConfigName()

Returns:

getConfigSection

public org.bukkit.configuration.ConfigurationSection getConfigSection()

Returns:

getVersion

public abstract int getVersion()
                        throws SQLException

Returns:

@throws SQLException

Throws:

SQLException

setVersion

public abstract void setVersion(int version)
                         throws SQLException

Parameters:

version -

Throws:

SQLException

close

public abstract void close()
                    throws SQLException

Throws:

SQLException

removeAccount

public abstract boolean removeAccount(String uuid)
                               throws SQLException

Parameters:

uuid -

Returns:

Throws:

SQLException

removeAllData

public abstract boolean removeAllData()
                               throws SQLException

Returns:

@throws SQLException

Throws:

SQLException

saveCommandUse

public abstract void saveCommandUse(HashMap<String,Integer> data)
                             throws SQLException,
                                    NullPointerException

Parameters:

data -

Throws:

SQLException

NullPointerException

getSavedUUIDs

public abstract Set<UUID> getSavedUUIDs()
                                 throws SQLException

Returns:

@throws SQLException

Throws:

SQLException

getCommandUse

public abstract HashMap<String,Integer> getCommandUse()
                                               throws SQLException

Returns:

@throws SQLException

Throws:

SQLException

getUserId

public abstract int getUserId(String uuid)
                       throws SQLException

Parameters:

uuid -

Returns:

Throws:

SQLException

getLocations

public abstract List<org.bukkit.Location> getLocations(String userId,
                                                       HashMap<String,org.bukkit.World> worlds)
                                                throws SQLException

Parameters:

userId -

worlds -

Returns:

Throws:

SQLException