Package fr.prodrivers.bukkit.commons.configuration.file

Class AbstractFileAttributeConfiguration

java.lang.Object

fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration

fr.prodrivers.bukkit.commons.configuration.file.AbstractFileAttributeConfiguration

Direct Known Subclasses:

Configuration, FileAttributeConfiguration

public abstract class AbstractFileAttributeConfiguration
extends AbstractAttributeConfiguration

Field-based, Bukkit's FileConfiguration backed configuration framework for Prodrivers plugins.

AbstractFileAttributeConfiguration extends AbstractAttributeConfiguration to uses Bukkit's own FileConfiguration class as a storage. It provides all the required configuration actions, and most logic for loading, saving and saving defaults.

In your constructor, after super(), you have to provide a valid FileConfiguration instance in the configuration field. Override AbstractAttributeConfiguration.save()/AbstractAttributeConfiguration.saveDefaults() to account for your FileConfiguration saving (set is already handled). Override AbstractAttributeConfiguration.reload() to account for your FileConfiguration reload. Keep in mind that, in both cases, the super method have to be called before doing any saving on your own.

ExcludedFromConfiguration annotation allows specific fields not to be used by the field processor. As with every AbstractAttributeConfiguration derivative, AbstractAttributeConfiguration.init() have to be called immediately after constructing the object, either at the end of the constructor or outside of it.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.bukkit.configuration.file.FileConfiguration	configuration	FileConfiguration used by this AbstractFileAttributeConfiguration instance.

Constructor Summary

Constructors

Constructor	Description
AbstractFileAttributeConfiguration()

Method Summary

Modifier and Type	Method	Description
static String	filterFieldName(String fieldName)	Field name filter.
org.bukkit.configuration.file.FileConfiguration	getConfiguration()	Get the underlying FileConfiguration instance.

Methods inherited from class fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration

init, load, registerAction, reload, save, saveDefaults

Methods inherited from class java.lang.Object

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

Field Details

configuration

protected org.bukkit.configuration.file.FileConfiguration configuration

FileConfiguration used by this AbstractFileAttributeConfiguration instance.

Constructor Details

AbstractFileAttributeConfiguration

public AbstractFileAttributeConfiguration()

Method Details

filterFieldName

public static String filterFieldName(String fieldName)

Field name filter. Allows translating from field name to configuration path. Default behavior is to replace every "_" with ".", meaning that every "_" will actually separate into subfields.

Parameters:

fieldName - Field name

Returns:

Filtered field name

getConfiguration

public org.bukkit.configuration.file.FileConfiguration getConfiguration()

Get the underlying FileConfiguration instance.

Returns:

FileConfiguration instance