Package com.palmergames.bukkit.towny.db

Class TownyDatabaseHandler

java.lang.Object

com.palmergames.bukkit.towny.db.TownyDataSource

com.palmergames.bukkit.towny.db.TownyDatabaseHandler

Direct Known Subclasses:

TownyFlatFileSource, TownySQLSource

public abstract class TownyDatabaseHandler
extends TownyDataSource

Author:

ElgarL

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleDateFormat	BACKUP_DATE_FORMAT
protected final Queue<Runnable>	queryQueue

Fields inherited from class com.palmergames.bukkit.towny.db.TownyDataSource

plugin, universe

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TownyDatabaseHandler(Towny plugin, TownyUniverse universe)

Method Summary

Modifier and Type	Method	Description
boolean	backup()
void	deleteFile(String fileName)
void	deletePlotData(PlotBlockData plotChunk)
void	finishTasks()
String	generateReplacementName(boolean town)	Generates a town or nation replacementname.
String	getLegacyPlotFilename(TownBlock townBlock)
boolean	hasPlotData(TownBlock townBlock)
PlotBlockData	loadPlotData(TownBlock townBlock)	Load PlotBlockData for regen at unclaim First attempts to load a .zip file containing the data file.
PlotBlockData	loadPlotData(String worldName, int x, int z)	Load PlotBlockData
boolean	loadRegenList()
void	mergeNation(Nation succumbingNation, Nation prevailingNation)	Merges the succumbingNation into the prevailingNation.
void	mergeTown(Town mergeInto, Town mergeFrom)	Merges the mergeFrom town into the mergeInto town.
void	newNation(String name)
void	newNation(String name, @Nullable UUID uuid)
@NotNull Resident	newResident(String name)
@NotNull Resident	newResident(String name, UUID uuid)
void	newWorld(String name)
void	removeDistrict(District district)
void	removeJail(Jail jail)
boolean	removeNation(@NotNull Nation nation, DeleteNationEvent.Cause cause, @Nullable org.bukkit.command.CommandSender sender)
void	removePlotGroup(PlotGroup group)
void	removeResident(Resident resident)
boolean	removeTown(@NotNull Town town, DeleteTownEvent.Cause cause, @Nullable org.bukkit.command.CommandSender sender, boolean delayFullRemoval)
void	removeTownBlock(TownBlock townBlock)
void	removeTownBlocks(Town town)
void	removeWorld(TownyWorld world)
void	renameDistrict(District district, String newName)
void	renameGroup(PlotGroup group, String newName)
void	renameNation(Nation nation, String newName)
void	renamePlayer(Resident resident, String newName)
void	renameTown(Town town, String newName)
boolean	savePlotData(PlotBlockData plotChunk)	Save PlotBlockData
boolean	saveRegenList()
protected final String	serializeMetadata(TownyObject obj)
UUID[]	toUUIDArray(String[] uuidArray)
List<UUID>	toUUIDList(Collection<Resident> residents)

Methods inherited from class com.palmergames.bukkit.towny.db.TownyDataSource

cleanup, deleteDistrict, deleteHibernatedResident, deleteJail, deleteNation, deletePlotGroup, deleteResident, deleteTown, deleteTownBlock, deleteWorld, getHibernatedResidentRegistered, loadAll, loadCooldowns, loadDistrict, loadDistrictList, loadDistricts, loadJail, loadJailList, loadJails, loadNation, loadNationList, loadNations, loadPlotGroup, loadPlotGroupList, loadPlotGroups, loadResident, loadResidentList, loadResidents, loadTown, loadTownBlockList, loadTownBlocks, loadTownList, loadTowns, loadWorld, loadWorldList, loadWorlds, removeNation, removeNation, removeTown, removeTown, removeTown, saveAll, saveAllWorlds, saveCooldowns, saveDistrict, saveDistricts, saveHibernatedResident, saveJail, saveJails, saveNation, saveNations, savePlotGroup, savePlotGroups, saveQueues, saveResident, saveResidents, saveTown, saveTownBlock, saveTownBlocks, saveTowns, saveWorld, saveWorlds

Methods inherited from class java.lang.Object

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

Field Details

BACKUP_DATE_FORMAT

public static final SimpleDateFormat BACKUP_DATE_FORMAT

queryQueue

protected final Queue<Runnable> queryQueue

Constructor Details

TownyDatabaseHandler

protected TownyDatabaseHandler(Towny plugin,
 TownyUniverse universe)

Method Details

finishTasks

public void finishTasks()

Specified by:

finishTasks in class TownyDataSource

backup

public boolean backup()
               throws IOException

Specified by:

backup in class TownyDataSource

Throws:

IOException

newResident

@NotNull
public @NotNull Resident newResident(String name)
                              throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

newResident in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

newResident

@NotNull
public @NotNull Resident newResident(String name,
 UUID uuid)
                              throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

newResident in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

newNation

public void newNation(String name)
               throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

newNation in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

newNation

public void newNation(String name,
 @Nullable
 @Nullable UUID uuid)
               throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

newNation in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

newWorld

public void newWorld(String name)
              throws AlreadyRegisteredException

Specified by:

newWorld in class TownyDataSource

Throws:

AlreadyRegisteredException

removeResident

public void removeResident(Resident resident)

Specified by:

removeResident in class TownyDataSource

removeTownBlock

public void removeTownBlock(TownBlock townBlock)

Specified by:

removeTownBlock in class TownyDataSource

removeTownBlocks

public void removeTownBlocks(Town town)

Specified by:

removeTownBlocks in class TownyDataSource

removeTown

public boolean removeTown(@NotNull
 @NotNull Town town,
 @NotNull
 DeleteTownEvent.Cause cause,
 @Nullable
 @Nullable org.bukkit.command.CommandSender sender,
 boolean delayFullRemoval)

Specified by:

removeTown in class TownyDataSource

removeNation

public boolean removeNation(@NotNull
 @NotNull Nation nation,
 @NotNull
 DeleteNationEvent.Cause cause,
 @Nullable
 @Nullable org.bukkit.command.CommandSender sender)

Specified by:

removeNation in class TownyDataSource

removeWorld

public void removeWorld(TownyWorld world)
                 throws UnsupportedOperationException

Specified by:

removeWorld in class TownyDataSource

Throws:

UnsupportedOperationException

removeJail

public void removeJail(Jail jail)

Specified by:

removeJail in class TownyDataSource

removePlotGroup

public void removePlotGroup(PlotGroup group)

Specified by:

removePlotGroup in class TownyDataSource

removeDistrict

public void removeDistrict(District district)

Specified by:

removeDistrict in class TownyDataSource

renameTown

public void renameTown(Town town,
 String newName)
                throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

renameTown in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

renameNation

public void renameNation(Nation nation,
 String newName)
                  throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

renameNation in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

renameGroup

public void renameGroup(PlotGroup group,
 String newName)
                 throws AlreadyRegisteredException

Specified by:

renameGroup in class TownyDataSource

Throws:

AlreadyRegisteredException

renameDistrict

public void renameDistrict(District district,
 String newName)
                    throws AlreadyRegisteredException

Specified by:

renameDistrict in class TownyDataSource

Throws:

AlreadyRegisteredException

renamePlayer

public void renamePlayer(Resident resident,
 String newName)
                  throws AlreadyRegisteredException,
NotRegisteredException

Specified by:

renamePlayer in class TownyDataSource

Throws:

AlreadyRegisteredException

NotRegisteredException

savePlotData

public boolean savePlotData(PlotBlockData plotChunk)

Save PlotBlockData

Specified by:

savePlotData in class TownyDataSource

Parameters:

plotChunk - - Plot for data to be saved for.

Returns:

true if saved

loadPlotData

public PlotBlockData loadPlotData(String worldName,
 int x,
 int z)

Load PlotBlockData

Specified by:

loadPlotData in class TownyDataSource

Parameters:

worldName - - World in which to load PlotBlockData for.

x - - Coordinate for X.

z - - Coordinate for Z.

Returns:

PlotBlockData or null

loadPlotData

public PlotBlockData loadPlotData(TownBlock townBlock)

Load PlotBlockData for regen at unclaim First attempts to load a .zip file containing the data file. Fallback attempts to load old .data files instead. Once it finds a zip or data file it will send it to be unpacked by loadDataStream(PlotBlockData, InputStream) which will return the populated PlotBlockData object.

Specified by:

loadPlotData in class TownyDataSource

Parameters:

townBlock - - townBlock being reverted

Returns:

PlotBlockData or null

deletePlotData

public void deletePlotData(PlotBlockData plotChunk)

Specified by:

deletePlotData in class TownyDataSource

hasPlotData

public boolean hasPlotData(TownBlock townBlock)

Specified by:

hasPlotData in class TownyDataSource

getLegacyPlotFilename

public String getLegacyPlotFilename(TownBlock townBlock)

loadRegenList

public boolean loadRegenList()

Specified by:

loadRegenList in class TownyDataSource

serializeMetadata

protected final String serializeMetadata(TownyObject obj)

saveRegenList

public boolean saveRegenList()

Specified by:

saveRegenList in class TownyDataSource

deleteFile

public void deleteFile(String fileName)

Specified by:

deleteFile in class TownyDataSource

mergeNation

public void mergeNation(Nation succumbingNation,
 Nation prevailingNation)

Merges the succumbingNation into the prevailingNation.

Specified by:

mergeNation in class TownyDataSource

Parameters:

succumbingNation - - Nation to be removed, towns put into prevailingNation.

prevailingNation - - Nation which survives, absorbs other nation's towns.

mergeTown

public void mergeTown(Town mergeInto,
 Town mergeFrom)

Merges the mergeFrom town into the mergeInto town.

Specified by:

mergeTown in class TownyDataSource

Parameters:

mergeInto - The town that the other town merges into.

mergeFrom - The town that will be deleted.

toUUIDList

public List<UUID> toUUIDList(Collection<Resident> residents)

toUUIDArray

public UUID[] toUUIDArray(String[] uuidArray)

generateReplacementName

public String generateReplacementName(boolean town)

Generates a town or nation replacementname. i.e.: Town1 or Nation2

Parameters:

town - Boolean for whether it's a town or a nation we're creating a name for.

Returns:

replacementName String.