Package wtf.choco.veinminer.config

Class BukkitVeinMinerConfiguration

java.lang.Object

wtf.choco.veinminer.config.BukkitVeinMinerConfiguration

All Implemented Interfaces:

VeinMinerConfiguration

public final class BukkitVeinMinerConfiguration
extends Object
implements VeinMinerConfiguration

Bukkit implementation of VeinMinerConfiguration.

Constructor Summary

Constructors

Constructor	Description
BukkitVeinMinerConfiguration(@NotNull VeinMinerPlugin plugin)	Construct a new BukkitVeinMinerConfiguration.

Method Summary

Modifier and Type	Method	Description
@NotNull Set<String>	getAllDefinedCategoryIds()	Get a set of all defined category ids.
@NotNull List<String>	getCategoryBlockList(@NotNull String categoryId)	Get a list of block state strings for the BlockList for VeinMinerToolCategory with the given id.
@NotNull List<String>	getCategoryItemList(@NotNull String categoryId)	Get a list of all item type strings for the VeinMinerToolCategory with the given id.
@NotNull ClientConfig	getClientConfiguration()	Get the default ClientConfig.
double	getCost()	Get the amount of money to be pulled from a player's balance when vein mining.
double	getCost(@NotNull String categoryId)	Get the amount of money to be pulled from a player's balance when vein mining with the VeinMinerToolCategory with the given id.
double	getCost(@NotNull String categoryId, double defaultValue)	Get the amount of money to be pulled from a player's balance when vein mining with the VeinMinerToolCategory with the given id.
@NotNull ActivationStrategy	getDefaultActivationStrategy()	Get the default ActivationStrategy.
@NotNull VeinMiningPattern	getDefaultVeinMiningPattern()	Get the default VeinMiningPattern.
@NotNull List<String>	getDisabledGameModeNames()	Get a list of all disabled game modes.
@NotNull Set<String>	getDisabledWorlds()	Get a list of all disabled worlds.
@NotNull Set<String>	getDisabledWorlds(@NotNull String categoryId)	Get a list of all disabled worlds for the VeinMinerToolCategory with the given id.
@NotNull Set<String>	getDisabledWorlds(@NotNull String categoryId, Supplier<Set<String>> defaultValues)	Get a list of all disabled worlds for the VeinMinerToolCategory with the given id.
@NotNull List<String>	getGlobalBlockList()	Get a list of block state strings for the global BlockList.
float	getHungerModifier()	Get the hunger modifier to be applied when a player vein mines.
@Nullable String	getHungryMessage()	Get the message to be sent to the player if they are too hungry to vein mine.
@Nullable File	getJsonStorageDirectory()	Get the directory in which JSON files should be stored.
int	getMaxVeinSize()	Get the maximum amount of blocks that are allowed to be broken in a single vein mine.
int	getMaxVeinSize(@NotNull String categoryId)	Get the maximum amount of blocks that are allowed to be broken in a single vein mine by the VeinMinerToolCategory with the given id.
int	getMaxVeinSize(@NotNull String categoryId, int defaultValue)	Get the maximum amount of blocks that are allowed to be broken in a single vein mine by the VeinMinerToolCategory with the given id.
int	getMinimumFoodLevel()	Get the minimum food level required to vein mine.
@Nullable String	getMySQLDatabase()	Get the MySQL database name.
@Nullable String	getMySQLHost()	Get the MySQL host address.
@Nullable String	getMySQLPassword()	Get the MySQL password.
int	getMySQLPort()	Get the MySQL port.
@Nullable String	getMySQLTablePrefix()	Get the prefix to use for all MySQL tables.
@Nullable String	getMySQLUsername()	Get the MySQL username.
@Nullable String	getNBTValue(@NotNull String categoryId)	Get the NBT value that must be on an item stack in order to use vein miner with the VeinMinerToolCategory with the given id.
int	getPriority(@NotNull String categoryId)	Get the numeric priority of the VeinMinerToolCategory with the given id.
@NotNull List<String>	getRawAliasStrings()	Get a list of the strings defining block aliases.
@NotNull PersistentDataStorage.Type	getStorageType()	Get the storage type to use.
boolean	isRepairFriendly()	Get whether or not vein miner is repair friendly and will ensure that tools do not break mid-vein mine
boolean	isRepairFriendly(@NotNull String categoryId)	Get whether or not vein miner is repair friendly for the VeinMinerToolCategory with the given id and will ensure that tools do not break mid-vein mine.
boolean	isRepairFriendly(@NotNull String categoryId, boolean defaultValue)	Get whether or not vein miner is repair friendly for the VeinMinerToolCategory with the given id and will ensure that tools do not break mid-vein mine.
void	reload()	Reload all values from disk into memory.
void	saveDefaults()	Save the default values of this configuration to disk.
boolean	shouldCheckForUpdates()	Get whether or not VeinMiner should check for updates using the update checker.
boolean	shouldCollectItemsAtSource()	Get whether or not dropped items should be collected at the block broken by the player that initiated the vein mine.
void	updateBlockList(@NotNull String categoryId, @NotNull BlockList blockList)	Write to the configuration file to update the block list of the given category id with the provided BlockList.
void	updateToolList(@NotNull VeinMinerToolCategory category)	Write to the configuration file to update the item list of the given category.

Methods inherited from class java.lang.Object

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

Constructor Details

BukkitVeinMinerConfiguration

public BukkitVeinMinerConfiguration(@NotNull
 @NotNull VeinMinerPlugin plugin)

Construct a new BukkitVeinMinerConfiguration.

Parameters:

plugin - the plugin instance

Method Details

shouldCheckForUpdates

public boolean shouldCheckForUpdates()

Description copied from interface: VeinMinerConfiguration

Get whether or not VeinMiner should check for updates using the update checker.

Specified by:

shouldCheckForUpdates in interface VeinMinerConfiguration

Returns:

true if should check for updates, false otherwise

getGlobalBlockList

@NotNull
public @NotNull List<String> getGlobalBlockList()

Description copied from interface: VeinMinerConfiguration

Get a list of block state strings for the global BlockList.

Specified by:

getGlobalBlockList in interface VeinMinerConfiguration

Returns:

the global block list

getCategoryBlockList

@NotNull
public @NotNull List<String> getCategoryBlockList(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get a list of block state strings for the BlockList for VeinMinerToolCategory with the given id.

Specified by:

getCategoryBlockList in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

the block list of the given category

getDefaultActivationStrategy

@NotNull
public @NotNull ActivationStrategy getDefaultActivationStrategy()

Description copied from interface: VeinMinerConfiguration

Get the default ActivationStrategy.

Specified by:

getDefaultActivationStrategy in interface VeinMinerConfiguration

Returns:

the default activation strategy

getDefaultVeinMiningPattern

@NotNull
public @NotNull VeinMiningPattern getDefaultVeinMiningPattern()

Description copied from interface: VeinMinerConfiguration

Get the default VeinMiningPattern.

Specified by:

getDefaultVeinMiningPattern in interface VeinMinerConfiguration

Returns:

the default vein mining pattern

shouldCollectItemsAtSource

public boolean shouldCollectItemsAtSource()

Description copied from interface: VeinMinerConfiguration

Get whether or not dropped items should be collected at the block broken by the player that initiated the vein mine.

Specified by:

shouldCollectItemsAtSource in interface VeinMinerConfiguration

Returns:

true if should collect at the source, false if dropped at the original positions

isRepairFriendly

public boolean isRepairFriendly()

Description copied from interface: VeinMinerConfiguration

Get whether or not vein miner is repair friendly and will ensure that tools do not break mid-vein mine

Specified by:

isRepairFriendly in interface VeinMinerConfiguration

Returns:

true if repair friendly, false otherwise

isRepairFriendly

public boolean isRepairFriendly(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get whether or not vein miner is repair friendly for the VeinMinerToolCategory with the given id and will ensure that tools do not break mid-vein mine.

Specified by:

isRepairFriendly in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

true if the category is repair friendly, false otherwise

isRepairFriendly

public boolean isRepairFriendly(@NotNull
 @NotNull String categoryId,
 boolean defaultValue)

Description copied from interface: VeinMinerConfiguration

Get whether or not vein miner is repair friendly for the VeinMinerToolCategory with the given id and will ensure that tools do not break mid-vein mine.

Specified by:

isRepairFriendly in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

defaultValue - the default value to return if not explicitly set

Returns:

true if the category is repair friendly, false otherwise

getMaxVeinSize

public int getMaxVeinSize()

Description copied from interface: VeinMinerConfiguration

Get the maximum amount of blocks that are allowed to be broken in a single vein mine.

Specified by:

getMaxVeinSize in interface VeinMinerConfiguration

Returns:

the maximum vein size

getMaxVeinSize

public int getMaxVeinSize(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get the maximum amount of blocks that are allowed to be broken in a single vein mine by the VeinMinerToolCategory with the given id.

Specified by:

getMaxVeinSize in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

the maximum vein size of the category

getMaxVeinSize

public int getMaxVeinSize(@NotNull
 @NotNull String categoryId,
 int defaultValue)

Description copied from interface: VeinMinerConfiguration

Get the maximum amount of blocks that are allowed to be broken in a single vein mine by the VeinMinerToolCategory with the given id.

Specified by:

getMaxVeinSize in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

defaultValue - the default value to return if not explicitly set

Returns:

the maximum vein size of the category

getCost

public double getCost()

Description copied from interface: VeinMinerConfiguration

Get the amount of money to be pulled from a player's balance when vein mining.

Specified by:

getCost in interface VeinMinerConfiguration

Returns:

the cost of a vein mine

getCost

public double getCost(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get the amount of money to be pulled from a player's balance when vein mining with the VeinMinerToolCategory with the given id.

Specified by:

getCost in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

the cost of a vein mine with the category

getCost

public double getCost(@NotNull
 @NotNull String categoryId,
 double defaultValue)

Description copied from interface: VeinMinerConfiguration

Get the amount of money to be pulled from a player's balance when vein mining with the VeinMinerToolCategory with the given id.

Specified by:

getCost in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

defaultValue - the default value to return if not explicitly set

Returns:

the cost of a vein mine with the category

getPriority

public int getPriority(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get the numeric priority of the VeinMinerToolCategory with the given id.

Specified by:

getPriority in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

the priority

getNBTValue

@Nullable
public @Nullable String getNBTValue(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get the NBT value that must be on an item stack in order to use vein miner with the VeinMinerToolCategory with the given id.

Specified by:

getNBTValue in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

the required NBT value, or null if no value is required

getDisabledGameModeNames

@NotNull
public @NotNull List<String> getDisabledGameModeNames()

Description copied from interface: VeinMinerConfiguration

Get a list of all disabled game modes.

Specified by:

getDisabledGameModeNames in interface VeinMinerConfiguration

Returns:

all disabled game mode names

getDisabledWorlds

@NotNull
public @NotNull Set<String> getDisabledWorlds()

Description copied from interface: VeinMinerConfiguration

Get a list of all disabled worlds.

Specified by:

getDisabledWorlds in interface VeinMinerConfiguration

Returns:

all disabled worlds

getDisabledWorlds

@NotNull
public @NotNull Set<String> getDisabledWorlds(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get a list of all disabled worlds for the VeinMinerToolCategory with the given id.

Specified by:

getDisabledWorlds in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

all disabled worlds

getDisabledWorlds

@NotNull
public @NotNull Set<String> getDisabledWorlds(@NotNull
 @NotNull String categoryId,
 Supplier<Set<String>> defaultValues)

Description copied from interface: VeinMinerConfiguration

Get a list of all disabled worlds for the VeinMinerToolCategory with the given id.

Specified by:

getDisabledWorlds in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

defaultValues - the default values to return if not explicitly set

Returns:

all disabled worlds

getHungerModifier

public float getHungerModifier()

Description copied from interface: VeinMinerConfiguration

Get the hunger modifier to be applied when a player vein mines. Higher values will apply more hunger to the player.

Specified by:

getHungerModifier in interface VeinMinerConfiguration

Returns:

the hunger modifier

getMinimumFoodLevel

public int getMinimumFoodLevel()

Description copied from interface: VeinMinerConfiguration

Get the minimum food level required to vein mine.

Specified by:

getMinimumFoodLevel in interface VeinMinerConfiguration

Returns:

the minimum food level

getHungryMessage

@Nullable
public @Nullable String getHungryMessage()

Description copied from interface: VeinMinerConfiguration

Get the message to be sent to the player if they are too hungry to vein mine.

Specified by:

getHungryMessage in interface VeinMinerConfiguration

Returns:

the message to send, or null if none

getClientConfiguration

@NotNull
public @NotNull ClientConfig getClientConfiguration()

Description copied from interface: VeinMinerConfiguration

Get the default ClientConfig.

Specified by:

getClientConfiguration in interface VeinMinerConfiguration

Returns:

the default client config

getStorageType

@NotNull
public @NotNull PersistentDataStorage.Type getStorageType()

Description copied from interface: VeinMinerConfiguration

Get the storage type to use.

Specified by:

getStorageType in interface VeinMinerConfiguration

Returns:

the storage type

getJsonStorageDirectory

@Nullable
public @Nullable File getJsonStorageDirectory()

Description copied from interface: VeinMinerConfiguration

Get the directory in which JSON files should be stored.

Specified by:

getJsonStorageDirectory in interface VeinMinerConfiguration

Returns:

the json storage directory, or null if not specified

getMySQLHost

@Nullable
public @Nullable String getMySQLHost()

Description copied from interface: VeinMinerConfiguration

Get the MySQL host address.

Specified by:

getMySQLHost in interface VeinMinerConfiguration

Returns:

the host address, or null if not specified

getMySQLPort

public int getMySQLPort()

Description copied from interface: VeinMinerConfiguration

Get the MySQL port.

Specified by:

getMySQLPort in interface VeinMinerConfiguration

Returns:

the port, or 0 if not specified

getMySQLUsername

@Nullable
public @Nullable String getMySQLUsername()

Description copied from interface: VeinMinerConfiguration

Get the MySQL username.

Specified by:

getMySQLUsername in interface VeinMinerConfiguration

Returns:

the username, or null if not specified

getMySQLPassword

@Nullable
public @Nullable String getMySQLPassword()

Description copied from interface: VeinMinerConfiguration

Get the MySQL password.

Specified by:

getMySQLPassword in interface VeinMinerConfiguration

Returns:

the password, or null if not specified

getMySQLDatabase

@Nullable
public @Nullable String getMySQLDatabase()

Description copied from interface: VeinMinerConfiguration

Get the MySQL database name.

Specified by:

getMySQLDatabase in interface VeinMinerConfiguration

Returns:

the database name, or null if not specified

getMySQLTablePrefix

@Nullable
public @Nullable String getMySQLTablePrefix()

Description copied from interface: VeinMinerConfiguration

Get the prefix to use for all MySQL tables.

Specified by:

getMySQLTablePrefix in interface VeinMinerConfiguration

Returns:

the prefix, or null if not specified

getRawAliasStrings

@NotNull
public @NotNull List<String> getRawAliasStrings()

Description copied from interface: VeinMinerConfiguration

Get a list of the strings defining block aliases.

Specified by:

getRawAliasStrings in interface VeinMinerConfiguration

Returns:

the alias strings

getAllDefinedCategoryIds

@NotNull
public @NotNull Set<String> getAllDefinedCategoryIds()

Description copied from interface: VeinMinerConfiguration

Get a set of all defined category ids.

Specified by:

getAllDefinedCategoryIds in interface VeinMinerConfiguration

Returns:

all category ids

getCategoryItemList

@NotNull
public @NotNull List<String> getCategoryItemList(@NotNull
 @NotNull String categoryId)

Description copied from interface: VeinMinerConfiguration

Get a list of all item type strings for the VeinMinerToolCategory with the given id.

Specified by:

getCategoryItemList in interface VeinMinerConfiguration

Parameters:

categoryId - the category id

Returns:

all items in the category

updateBlockList

public void updateBlockList(@NotNull
 @NotNull String categoryId,
 @NotNull
 @NotNull BlockList blockList)

Description copied from interface: VeinMinerConfiguration

Write to the configuration file to update the block list of the given category id with the provided BlockList.

Specified by:

updateBlockList in interface VeinMinerConfiguration

Parameters:

categoryId - the category id to update

blockList - the block list to set

updateToolList

public void updateToolList(@NotNull
 @NotNull VeinMinerToolCategory category)

Description copied from interface: VeinMinerConfiguration

Write to the configuration file to update the item list of the given category.

Specified by:

updateToolList in interface VeinMinerConfiguration

Parameters:

category - the category to update

saveDefaults

public void saveDefaults()

Description copied from interface: VeinMinerConfiguration

Save the default values of this configuration to disk.

Specified by:

saveDefaults in interface VeinMinerConfiguration

reload

public void reload()

Description copied from interface: VeinMinerConfiguration

Reload all values from disk into memory.

Specified by:

reload in interface VeinMinerConfiguration