com.lirtistasya.plugins.regionmanager

Class RegionManagerCommandsManager

java.lang.Object

com.lirtistasya.plugins.regionmanager.RegionManagerCommandsManager

All Implemented Interfaces:

org.bukkit.command.CommandExecutor

public class RegionManagerCommandsManager
extends java.lang.Object
implements org.bukkit.command.CommandExecutor

RegionManagerCommandsManager is a class to manage commands that can be executed by RegionManager.

Since:

1.0.0

Author:

lirtistasya/mezzodrinker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionManagerCommandsManager.ConfigProperties RegionManagerCommandsManager.ConfigProperties contains all paths of RegionManager's configuration and regions file.
static class	RegionManagerCommandsManager.MessageProperties RegionManagerCommandsManager.MessageProperties contains all message-related stuff for RegionManager
static class	RegionManagerCommandsManager.Properties RegionManagerCommandsManager.Properties is a static class containing the main aspects for using RegionManager.
static class	RegionManagerCommandsManager.RegionProperties RegionManagerCommandsManager.RegionProperties contains essential methods for using RegionManager's regions.

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.configuration.file.YamlConfiguration	config The YamlConfiguration instance that is used for storing and reading the basic settings.
private net.milkbowl.vault.economy.Economy	economy The Economy instance that is used.
private RegionManagerPlugin	plugin The RegionManagerPlugin instance that is used.
private org.bukkit.configuration.file.YamlConfiguration	regions The YamlConfiguration instance that is used for storing and reading information about regions.
private RegionManagerGeneralCommands	rmgc The RegionManagerGeneralCommands instance that is used for executing general commands (commands that can be executed by both players and console).
private RegionManagerPlayerCommands	rmpc The RegionManagerPlayerCommands instance that is used for executing player commands (commands that can be executed by players only).

Constructor Summary

Constructors

Constructor and Description
RegionManagerCommandsManager(RegionManagerPlugin plugin) Creates a new instance of RegionManagerCommandsManager with the parent RegionManagerPlugin specified.

Method Summary

Methods

Modifier and Type	Method and Description
org.bukkit.configuration.file.YamlConfiguration	getConfig() Returns the configuration of RegionManager.
net.milkbowl.vault.economy.Economy	getEconomy() Returns the economy plugin RegionManager is using.
RegionManagerPlugin	getPlugin() Returns the plugin this RegionManagerCommandsManager is using.
org.bukkit.configuration.file.YamlConfiguration	getRegions() Returns the regions file of RegionManager as a YamlConfiguration
org.bukkit.World	getWorld(java.lang.String regionname) Determines the world of a given region's name.
private void	initConfig() (Re-)Initializes RegionManagerCommandsManager's config attribute.
private void	initEconomy() (Re-)Initializes RegionManagerCommandsManager's economy attribute.
private void	initRegions() (Re-)Initializes RegionManagerCommandsManager's regions attribute.
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command command, java.lang.String label, java.lang.String[] args)
boolean	regionExists(java.lang.String regionname, org.bukkit.World world) Returns whether a region exists or not.
void	reload() Reloads all RegionManager files and re-initializes the Economy plugin.
void	reloadConfig() Reloads the RegionManager configuration.
void	reloadRegions() Reloads the RegionManager regions file.
void	save() Saves all files of RegionManager.
void	saveConfig() Saves the configuration of RegionManager.
void	saveRegions() Saves the regions file of RegionManager.

Methods inherited from class java.lang.Object

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

Field Detail

plugin

private RegionManagerPlugin plugin

The RegionManagerPlugin instance that is used.

economy

private net.milkbowl.vault.economy.Economy economy

The Economy instance that is used.

See Also:

Economy

config

private org.bukkit.configuration.file.YamlConfiguration config

The YamlConfiguration instance that is used for storing and reading the basic settings.

See Also:

YamlConfiguration

regions

private org.bukkit.configuration.file.YamlConfiguration regions

The YamlConfiguration instance that is used for storing and reading information about regions.

See Also:

YamlConfiguration

rmgc

private RegionManagerGeneralCommands rmgc

The RegionManagerGeneralCommands instance that is used for executing general commands (commands that can be executed by both players and console).

rmpc

private RegionManagerPlayerCommands rmpc

The RegionManagerPlayerCommands instance that is used for executing player commands (commands that can be executed by players only).

Constructor Detail

RegionManagerCommandsManager

public RegionManagerCommandsManager(RegionManagerPlugin plugin)

Creates a new instance of RegionManagerCommandsManager with the parent RegionManagerPlugin specified.

Parameters:

plugin - the RegionManagerPlugin that shall be used

Method Detail

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                org.bukkit.command.Command command,
                java.lang.String label,
                java.lang.String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

getPlugin

public RegionManagerPlugin getPlugin()

Returns the plugin this RegionManagerCommandsManager is using.

Returns:

the plugin this instance is using

getEconomy

public net.milkbowl.vault.economy.Economy getEconomy()

Returns the economy plugin RegionManager is using.

Returns:

null if no economy plugin was found, the Economy instance if found

getConfig

public org.bukkit.configuration.file.YamlConfiguration getConfig()

Returns the configuration of RegionManager.

Returns:

the configuration

getRegions

public org.bukkit.configuration.file.YamlConfiguration getRegions()

Returns the regions file of RegionManager as a YamlConfiguration

Returns:

the regions file

getWorld

public org.bukkit.World getWorld(java.lang.String regionname)
                          throws RegionManagerGeneralCommands.RegionFormatException

Determines the world of a given region's name.
If the name's format does not fit into the region format (<worldname>_<chunk x>_<chunk z>) a RegionFormatException is thrown.

Parameters:

regionname - the name of the region

Returns:

the world of this region

Throws:

RegionManagerGeneralCommands.RegionFormatException - if the region is not fulfilling the region format.

See Also:

RegionProperties

save

public void save()

Saves all files of RegionManager.

See Also:

saveConfig(), saveRegions()

saveConfig

public void saveConfig()

Saves the configuration of RegionManager.

saveRegions

public void saveRegions()

Saves the regions file of RegionManager.

regionExists

public boolean regionExists(java.lang.String regionname,
                   org.bukkit.World world)

Returns whether a region exists or not.

Parameters:

regionname - the region's name

world - the region's world

Returns:

true if the region is found both in RegionManager's regions file and the WorldGuard's one, false if not

reload

public void reload()

Reloads all RegionManager files and re-initializes the Economy plugin.

See Also:

reloadConfig(), reloadRegions(), initEconomy()

reloadConfig

public void reloadConfig()

Reloads the RegionManager configuration.

reloadRegions

public void reloadRegions()

Reloads the RegionManager regions file.

initEconomy

private void initEconomy()

(Re-)Initializes RegionManagerCommandsManager's economy attribute.

initConfig

private void initConfig()

(Re-)Initializes RegionManagerCommandsManager's config attribute.

initRegions

private void initRegions()

(Re-)Initializes RegionManagerCommandsManager's regions attribute.