com.comphenix.xp

Class Presets

java.lang.Object

com.comphenix.xp.Presets

All Implemented Interfaces:

PlayerCleanupListener

public class Presets
extends java.lang.Object
implements PlayerCleanupListener

Contains every loaded configuration preset.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTION_PRESET_SETTING

Constructor Summary

Constructors

Constructor and Description
Presets(org.bukkit.configuration.ConfigurationSection config, ConfigurationLoader loader, int cacheTimeout, Debugger logger, net.milkbowl.vault.chat.Chat chat)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsPreset(java.lang.String preset, java.lang.String world)
Configuration	getConfiguration(org.bukkit.command.CommandSender sender) Retrieves the default configuration for the given player.
Configuration	getConfiguration(java.lang.String presetNames, java.lang.String worldName) Retrieves a stored configuration from a key value.
java.util.Collection<Configuration>	getConfigurations()
boolean	ignorableException(java.lang.Exception e) Determines whether or not the given exception can be ignored if thrown from getGroupInfoString.
void	onTick()
void	removePlayerCache(org.bukkit.entity.Player player) Removes a given player from being referenced by any preset node.
boolean	usesPresetParameters()

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_PRESET_SETTING

public static final java.lang.String OPTION_PRESET_SETTING

See Also:

Constant Field Values

Constructor Detail

Presets

public Presets(org.bukkit.configuration.ConfigurationSection config,
       ConfigurationLoader loader,
       int cacheTimeout,
       Debugger logger,
       net.milkbowl.vault.chat.Chat chat)

Method Detail

getConfiguration

public Configuration getConfiguration(java.lang.String presetNames,
                             java.lang.String worldName)
                               throws ParsingException

Retrieves a stored configuration from a key value. Note that while NULL in rules will match any query, a query with null will NOT match any rule. In that case, it will only match rules with null in the corresponding parameters.

Parameters:

presetNames - - key value(s) of the configuration to retrieve.

worldName - - name of the world the preset is associated with.

Returns:

The stored configuration, or NULL if no configuration exists.

Throws:

ParsingException - If the given list of keys is malformed.

getConfiguration

public Configuration getConfiguration(org.bukkit.command.CommandSender sender)
                               throws ParsingException

Retrieves the default configuration for the given player.

Parameters:

sender - - the sender, or NULL to retrieve the generic/default configuration.

Returns:

Configuration, or NULL if no configuration could be found.

Throws:

ParsingException - - If the sender has a malformed preset list.

usesPresetParameters

public boolean usesPresetParameters()

containsPreset

public boolean containsPreset(java.lang.String preset,
                     java.lang.String world)
                       throws ParsingException

Throws:

ParsingException

getConfigurations

public java.util.Collection<Configuration> getConfigurations()

onTick

public void onTick()

removePlayerCache

public void removePlayerCache(org.bukkit.entity.Player player)

Description copied from interface: PlayerCleanupListener

Removes a given player from being referenced by any preset node. Must be called when a player logs out.

Specified by:

removePlayerCache in interface PlayerCleanupListener

Parameters:

player - - player to remove.

ignorableException

public boolean ignorableException(java.lang.Exception e)

Determines whether or not the given exception can be ignored if thrown from getGroupInfoString.

Parameters:

e - - the exception to test.

Returns:

TRUE if it can be ignored, FALSE otherwise.

See Also:

Chat.getGroupInfoString