Package com.palmergames.bukkit.towny.db

Class TownyDataSource

java.lang.Object

com.palmergames.bukkit.towny.db.TownyDataSource

Direct Known Subclasses:

TownyDatabaseHandler

public abstract class TownyDataSource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final Towny	plugin
protected final TownyUniverse	universe

Method Summary

Modifier and Type	Method	Description
abstract boolean	backup()
boolean	cleanup()
abstract void	deleteFile(String file)
abstract void	deleteHibernatedResident(UUID uuid)
abstract void	deleteJail(Jail jail)
abstract void	deleteNation(Nation nation)
abstract void	deletePlotData(PlotBlockData plotChunk)
abstract void	deletePlotGroup(PlotGroup group)
abstract void	deleteResident(Resident resident)
abstract void	deleteTown(Town town)
abstract void	deleteTownBlock(TownBlock townBlock)
abstract void	deleteWorld(TownyWorld world)
abstract void	finishTasks()
abstract CompletableFuture<Optional<Long>>	getHibernatedResidentRegistered(UUID uuid)
abstract boolean	hasPlotData(TownBlock townBlock)
boolean	loadAll()
abstract boolean	loadCooldowns()
abstract boolean	loadJail(Jail jail)
abstract boolean	loadJailList()
boolean	loadJails()
abstract boolean	loadNation(Nation nation)
abstract boolean	loadNationList()
boolean	loadNations()
abstract PlotBlockData	loadPlotData(TownBlock townBlock)
abstract PlotBlockData	loadPlotData(String worldName, int x, int z)
abstract boolean	loadPlotGroup(PlotGroup group)
abstract boolean	loadPlotGroupList()
boolean	loadPlotGroups()
abstract boolean	loadRegenList()
abstract boolean	loadResident(Resident resident)
abstract boolean	loadResidentList()
boolean	loadResidents()
abstract boolean	loadTown(Town town)
abstract boolean	loadTownBlockList()
abstract boolean	loadTownBlocks()
abstract boolean	loadTownList()
boolean	loadTowns()
abstract boolean	loadWorld(TownyWorld world)
abstract boolean	loadWorldList()
boolean	loadWorlds()
abstract void	mergeNation(Nation succumbingNation, Nation prevailingNation)
abstract void	mergeTown(Town mergeInto, Town mergeFrom)
abstract void	newNation(String name)
abstract void	newNation(String name, UUID uuid)
abstract @NotNull Resident	newResident(String name)
abstract @NotNull Resident	newResident(String name, UUID uuid)
abstract void	newWorld(String name)
abstract void	removeJail(Jail jail)
boolean	removeNation(@NotNull Nation nation, DeleteNationEvent.Cause cause)
abstract boolean	removeNation(@NotNull Nation nation, DeleteNationEvent.Cause cause, @Nullable org.bukkit.command.CommandSender sender)
void	removeNation(Nation nation)	Deprecated. since 0.100.2.96 use removeNation(Nation, com.palmergames.bukkit.towny.event.DeleteNationEvent.Cause) instead.
abstract void	removePlotGroup(PlotGroup group)
abstract void	removeResident(Resident resident)
boolean	removeTown(@NotNull Town town, DeleteTownEvent.Cause cause, @Nullable org.bukkit.command.CommandSender sender)
abstract boolean	removeTown(@NotNull Town town, DeleteTownEvent.Cause cause, @Nullable org.bukkit.command.CommandSender sender, boolean delayFullRemoval)
void	removeTown(Town town)	Deprecated. since 0.100.2.9 use removeTown(Town, com.palmergames.bukkit.towny.event.DeleteTownEvent.Cause) instead.
boolean	removeTown(Town town, DeleteTownEvent.Cause cause)
abstract void	removeTownBlock(TownBlock townBlock)
abstract void	removeTownBlocks(Town town)
abstract void	removeWorld(TownyWorld world)
abstract void	renameGroup(PlotGroup group, String newName)
abstract void	renameNation(Nation nation, String newName)
abstract void	renamePlayer(Resident resident, String newName)
abstract void	renameTown(Town town, String newName)
boolean	saveAll()
boolean	saveAllWorlds()
abstract boolean	saveCooldowns()
abstract boolean	saveHibernatedResident(UUID uuid, long registered)
abstract boolean	saveJail(Jail jail)
boolean	saveJails()
abstract boolean	saveNation(Nation nation)
boolean	saveNations()
abstract boolean	savePlotData(PlotBlockData plotChunk)
abstract boolean	savePlotGroup(PlotGroup group)
boolean	savePlotGroups()
boolean	saveQueues()
abstract boolean	saveRegenList()
abstract boolean	saveResident(Resident resident)
boolean	saveResidents()
abstract boolean	saveTown(Town town)
abstract boolean	saveTownBlock(TownBlock townBlock)
boolean	saveTownBlocks()
boolean	saveTowns()
abstract boolean	saveWorld(TownyWorld world)
boolean	saveWorlds()

Methods inherited from class java.lang.Object

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

Field Details

plugin

protected final Towny plugin

universe

protected final TownyUniverse universe

Method Details

backup

public abstract boolean backup()
                        throws IOException

Throws:

IOException

loadAll

public boolean loadAll()

saveAll

public boolean saveAll()

saveAllWorlds

public boolean saveAllWorlds()

saveQueues

public boolean saveQueues()

finishTasks

public abstract void finishTasks()

loadTownBlockList

public abstract boolean loadTownBlockList()

loadResidentList

public abstract boolean loadResidentList()

loadTownList

public abstract boolean loadTownList()

loadNationList

public abstract boolean loadNationList()

loadWorldList

public abstract boolean loadWorldList()

loadRegenList

public abstract boolean loadRegenList()

loadTownBlocks

public abstract boolean loadTownBlocks()

loadJailList

public abstract boolean loadJailList()

loadResident

public abstract boolean loadResident(Resident resident)

loadTown

public abstract boolean loadTown(Town town)

loadNation

public abstract boolean loadNation(Nation nation)

loadWorld

public abstract boolean loadWorld(TownyWorld world)

loadJail

public abstract boolean loadJail(Jail jail)

loadPlotGroupList

public abstract boolean loadPlotGroupList()

loadPlotGroup

public abstract boolean loadPlotGroup(PlotGroup group)

saveRegenList

public abstract boolean saveRegenList()

saveResident

public abstract boolean saveResident(Resident resident)

saveHibernatedResident

public abstract boolean saveHibernatedResident(UUID uuid,
 long registered)

saveTown

public abstract boolean saveTown(Town town)

savePlotGroup

public abstract boolean savePlotGroup(PlotGroup group)

saveJail

public abstract boolean saveJail(Jail jail)

saveNation

public abstract boolean saveNation(Nation nation)

saveWorld

public abstract boolean saveWorld(TownyWorld world)

saveTownBlock

public abstract boolean saveTownBlock(TownBlock townBlock)

savePlotData

public abstract boolean savePlotData(PlotBlockData plotChunk)

loadPlotData

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

loadPlotData

public abstract PlotBlockData loadPlotData(TownBlock townBlock)

hasPlotData

public abstract boolean hasPlotData(TownBlock townBlock)

deletePlotData

public abstract void deletePlotData(PlotBlockData plotChunk)

deleteResident

public abstract void deleteResident(Resident resident)

deleteHibernatedResident

public abstract void deleteHibernatedResident(UUID uuid)

deleteTown

public abstract void deleteTown(Town town)

deleteNation

public abstract void deleteNation(Nation nation)

deleteWorld

public abstract void deleteWorld(TownyWorld world)

deleteTownBlock

public abstract void deleteTownBlock(TownBlock townBlock)

deleteFile

public abstract void deleteFile(String file)

deletePlotGroup

public abstract void deletePlotGroup(PlotGroup group)

deleteJail

public abstract void deleteJail(Jail jail)

getHibernatedResidentRegistered

public abstract CompletableFuture<Optional<Long>> getHibernatedResidentRegistered(UUID uuid)

cleanup

public boolean cleanup()

loadResidents

public boolean loadResidents()

loadTowns

public boolean loadTowns()

loadNations

public boolean loadNations()

loadWorlds

public boolean loadWorlds()

loadJails

public boolean loadJails()

loadPlotGroups

public boolean loadPlotGroups()

loadCooldowns

public abstract boolean loadCooldowns()

saveResidents

public boolean saveResidents()

savePlotGroups

public boolean savePlotGroups()

saveJails

public boolean saveJails()

saveTowns

public boolean saveTowns()

saveNations

public boolean saveNations()

saveWorlds

public boolean saveWorlds()

saveTownBlocks

public boolean saveTownBlocks()

saveCooldowns

public abstract boolean saveCooldowns()

removeResident

public abstract void removeResident(Resident resident)

removeTownBlock

public abstract void removeTownBlock(TownBlock townBlock)

removeTownBlocks

public abstract void removeTownBlocks(Town town)

removeNation

public boolean removeNation(@NotNull
 @NotNull Nation nation,
 @NotNull
 DeleteNationEvent.Cause cause)

removeNation

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

newResident

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

Throws:

AlreadyRegisteredException

NotRegisteredException

newResident

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

Throws:

AlreadyRegisteredException

NotRegisteredException

newNation

public abstract void newNation(String name)
                        throws AlreadyRegisteredException,
NotRegisteredException

Throws:

AlreadyRegisteredException

NotRegisteredException

newNation

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

Throws:

AlreadyRegisteredException

NotRegisteredException

newWorld

public abstract void newWorld(String name)
                       throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

removeTown

public boolean removeTown(Town town,
 @NotNull
 DeleteTownEvent.Cause cause)

removeTown

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

removeTown

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

removeWorld

public abstract void removeWorld(TownyWorld world)
                          throws UnsupportedOperationException

Throws:

UnsupportedOperationException

removeJail

public abstract void removeJail(Jail jail)

removePlotGroup

public abstract void removePlotGroup(PlotGroup group)

renameTown

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

Throws:

AlreadyRegisteredException

NotRegisteredException

renameNation

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

Throws:

AlreadyRegisteredException

NotRegisteredException

mergeNation

public abstract void mergeNation(Nation succumbingNation,
 Nation prevailingNation)

mergeTown

public abstract void mergeTown(Town mergeInto,
 Town mergeFrom)

renamePlayer

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

Throws:

AlreadyRegisteredException

NotRegisteredException

renameGroup

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

Throws:

AlreadyRegisteredException

removeTown

@Deprecated
public void removeTown(Town town)

Deprecated.

since 0.100.2.9 use removeTown(Town, com.palmergames.bukkit.towny.event.DeleteTownEvent.Cause) instead.

Parameters:

town -

removeNation

@Deprecated
public void removeNation(Nation nation)

Deprecated.

since 0.100.2.96 use removeNation(Nation, com.palmergames.bukkit.towny.event.DeleteNationEvent.Cause) instead.

Parameters:

nation -