Class DataSource

java.lang.Object
  DataSource

Direct Known Subclasses:

FlatFileSource, MySQLSource

public abstract class DataSource
extends java.lang.Object

DataSource.java - Abstract class for implementing new data sources.

Field Summary

Modifier and Type	Field and Description
protected java.lang.Object	banLock
protected java.util.List<Ban>	bans
protected java.lang.Object	groupLock
protected java.util.List<Group>	groups
protected java.lang.Object	homeLock
protected java.util.List<Warp>	homes
protected java.lang.Object	itemLock
protected java.util.Map<java.lang.String,java.lang.Integer>	items
protected java.lang.Object	kitLock
protected java.util.List<Kit>	kits
protected static java.util.logging.Logger	log
protected net.minecraft.server.MinecraftServer	server
protected java.lang.Object	warpLock
protected java.util.List<Warp>	warps

Constructor and Description

DataSource()

Method Summary

Modifier and Type	Method and Description
abstract void	addGroup(Group group) Adds specified group to the list of groups
abstract void	addHome(Warp home) Adds home to list of homes
abstract void	addKit(Kit kit) Adds kit to list of kits
abstract void	addPlayer(Player player) Adds user to the list
abstract void	addToReserveList(java.lang.String name) Adds player to reservelist
abstract void	addToWhitelist(java.lang.String name) Adds player to whitelist
abstract void	addWarp(Warp warp) Adds warp to list of warps
abstract void	changeHome(Warp home) Modifies home
abstract void	changeWarp(Warp warp) Modifies warp
abstract boolean	doesPlayerExist(java.lang.String player) Checks to see if the specified player exists
Ban	getBan(java.lang.String player, java.lang.String ip) Retrieves the ban details
Group	getDefaultGroup() Returns the default group
Group	getGroup(java.lang.String name) Returns specified group
Warp	getHome(java.lang.String name) Returns specified home
java.lang.String	getItem(int id) Returns the name of the item corresponding to the ID
int	getItem(java.lang.String name) Returns item id corresponding to item name
java.util.Map<java.lang.String,java.lang.Integer>	getItems() Returns an unmodifiable map of items
Kit	getKit(java.lang.String name) Returns specified kit
java.lang.String	getKitNames(Player player) Returns a list of all kits names separated by commas
abstract Player	getPlayer(java.lang.String name) Returns specified user
Warp	getWarp(java.lang.String name) Returns specified warp
java.lang.String	getWarpNames(Player player) Returns a string containing all warp names the player has access to
boolean	hasKits() Returns true if there are any kits
boolean	hasWarps() Returns true if there are any warps
boolean	hasWhitelist() Deprecated. use etc.getInstance().isWhitelistEnabled() instead
abstract void	initialize() Initializes the data source
boolean	isOnBanList(java.lang.String player, java.lang.String ip) Checks to see if this player or IP is on the ban list
abstract boolean	isUserOnReserveList(java.lang.String user) Returns true if player is on reservelist
abstract boolean	isUserOnWhitelist(java.lang.String user) Returns true if the player is on the whitelist
abstract void	loadBanList() Loads the ban list
abstract void	loadGroups() Loads all groups
abstract void	loadHomes() Loads all homes
abstract void	loadItems() Loads all items
abstract void	loadKits() Loads all kits
abstract void	loadWarps() Loads all warps
abstract void	modifyBan(Ban ban) Adds or modifies specified ban
abstract void	modifyGroup(Group group) Modifies group
abstract void	modifyKit(Kit kit) Modifies kit
abstract void	modifyPlayer(Player player) Modifies the provided user
abstract void	removeFromReserveList(java.lang.String name) Removes player from reservelist
abstract void	removeFromWhitelist(java.lang.String name) Removes player from whitelist
abstract void	removeWarp(Warp warp) Removes warp from list of warps

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final java.util.logging.Logger log

groups

protected java.util.List<Group> groups

kits

protected java.util.List<Kit> kits

homes

protected java.util.List<Warp> homes

warps

protected java.util.List<Warp> warps

bans

protected java.util.List<Ban> bans

items

protected java.util.Map<java.lang.String,java.lang.Integer> items

server

protected net.minecraft.server.MinecraftServer server

groupLock

protected final java.lang.Object groupLock

kitLock

protected final java.lang.Object kitLock

banLock

protected final java.lang.Object banLock

homeLock

protected final java.lang.Object homeLock

warpLock

protected final java.lang.Object warpLock

itemLock

protected final java.lang.Object itemLock

Constructor Detail

DataSource

public DataSource()

Method Detail

initialize

public abstract void initialize()

Initializes the data source

loadGroups

public abstract void loadGroups()

Loads all groups

loadKits

public abstract void loadKits()

Loads all kits

loadHomes

public abstract void loadHomes()

Loads all homes

loadWarps

public abstract void loadWarps()

Loads all warps

loadItems

public abstract void loadItems()

Loads all items

loadBanList

public abstract void loadBanList()

Loads the ban list

addPlayer

public abstract void addPlayer(Player player)

Adds user to the list

Parameters:

player -

modifyPlayer

public abstract void modifyPlayer(Player player)

Modifies the provided user

Parameters:

player -

doesPlayerExist

public abstract boolean doesPlayerExist(java.lang.String player)

Checks to see if the specified player exists

Parameters:

player -

Returns:

true if player exists

getPlayer

public abstract Player getPlayer(java.lang.String name)

Returns specified user

Parameters:

name -

Returns:

user

addGroup

public abstract void addGroup(Group group)

Adds specified group to the list of groups

Parameters:

group -

modifyGroup

public abstract void modifyGroup(Group group)

Modifies group

Parameters:

group -

getGroup

public Group getGroup(java.lang.String name)

Returns specified group

Parameters:

name -

Returns:

group

getDefaultGroup

public Group getDefaultGroup()

Returns the default group

Returns:

default group

addKit

public abstract void addKit(Kit kit)

Adds kit to list of kits

Parameters:

kit -

modifyKit

public abstract void modifyKit(Kit kit)

Modifies kit

Parameters:

kit -

getKit

public Kit getKit(java.lang.String name)

Returns specified kit

Parameters:

name -

Returns:

kit

hasKits

public boolean hasKits()

Returns true if there are any kits

Returns:

true if there are kits

getKitNames

public java.lang.String getKitNames(Player player)

Returns a list of all kits names separated by commas

Parameters:

player -

Returns:

string list of kits

addHome

public abstract void addHome(Warp home)

Adds home to list of homes

Parameters:

home -

changeHome

public abstract void changeHome(Warp home)

Modifies home

Parameters:

home -

getHome

public Warp getHome(java.lang.String name)

Returns specified home

Parameters:

name -

Returns:

home

addWarp

public abstract void addWarp(Warp warp)

Adds warp to list of warps

Parameters:

warp -

changeWarp

public abstract void changeWarp(Warp warp)

Modifies warp

Parameters:

warp -

removeWarp

public abstract void removeWarp(Warp warp)

Removes warp from list of warps

Parameters:

warp -

getWarp

public Warp getWarp(java.lang.String name)

Returns specified warp

Parameters:

name -

Returns:

warp

hasWarps

public boolean hasWarps()

Returns true if there are any warps

Returns:

true if there are warps

getWarpNames

public java.lang.String getWarpNames(Player player)

Returns a string containing all warp names the player has access to

Parameters:

player -

Returns:

string list of warps

getItem

public int getItem(java.lang.String name)

Returns item id corresponding to item name

Parameters:

name -

Returns:

item id

getItem

public java.lang.String getItem(int id)

Returns the name of the item corresponding to the ID

Parameters:

id - id of item

Returns:

name of item

getItems

public java.util.Map<java.lang.String,java.lang.Integer> getItems()

Returns an unmodifiable map of items

Returns:

unmodifiable map of items

addToWhitelist

public abstract void addToWhitelist(java.lang.String name)

Adds player to whitelist

Parameters:

name -

removeFromWhitelist

public abstract void removeFromWhitelist(java.lang.String name)

Removes player from whitelist

Parameters:

name -

hasWhitelist

@Deprecated
public boolean hasWhitelist()

Deprecated. use etc.getInstance().isWhitelistEnabled() instead

Returns true if whitelist is enabled

Returns:

true if whitelist is enabled

isUserOnWhitelist

public abstract boolean isUserOnWhitelist(java.lang.String user)

Returns true if the player is on the whitelist

Parameters:

user -

Returns:

true if player is on whitelist

addToReserveList

public abstract void addToReserveList(java.lang.String name)

Adds player to reservelist

Parameters:

name -

removeFromReserveList

public abstract void removeFromReserveList(java.lang.String name)

Removes player from reservelist

Parameters:

name -

isUserOnReserveList

public abstract boolean isUserOnReserveList(java.lang.String user)

Returns true if player is on reservelist

Parameters:

user -

Returns:

true if player is on reserve list

modifyBan

public abstract void modifyBan(Ban ban)

Adds or modifies specified ban

Parameters:

ban - Ban to add or modify

isOnBanList

public boolean isOnBanList(java.lang.String player,
                           java.lang.String ip)

Checks to see if this player or IP is on the ban list

Parameters:

player - Player name

ip - IP Address

Returns:

true if either name or IP is on the ban list

getBan

public Ban getBan(java.lang.String player,
                  java.lang.String ip)

Retrieves the ban details

Parameters:

player - Player name

ip - IP Address

Returns:

the ban