Package fr.prodrivers.bukkit.commons.configuration

Class AbstractAttributeConfiguration

java.lang.Object
fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration
Direct Known Subclasses:
AbstractFileAttributeConfiguration
public abstract class AbstractAttributeConfiguration extends Object
Field-based configuration framework for Prodrivers plugins.

AbstractAttributeConfiguration lays the framework of configuration classes that uses fields to represent options, loading and saving these fields using Configuration Actions. Provide your own Configuration Actions, override init()/load()/save()/saveDefaults()/reload() as necessary to create a fully-managed field-based configuration class. Call then reload() and save() in your plugin when required. Direct calling of load() and saveDefaults() is strongly discouraged.

If a specific class does not provide a Configuration Action for a field's type, AbstractAttributeConfiguration serialize it if possible, or resorts to toString/valueOf to store it nonetheless. It allows a wide variety of classes to be stored without providing explicit Configuration Actions. As such, each class have to provide at least a String Configuration Action in order for AbstractConfigurationAction to work properly in the majority of cases.

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

  • Constructor Details

    • AbstractAttributeConfiguration

      public AbstractAttributeConfiguration()

  • Method Details

    • registerAction

      protected void registerAction(IConfigurationAction action)
      Register a Configuration Action.
      Parameters:
      action - IConfigurationAction instance to register

    • init

      public void init() throws IllegalStateException
      Init a field-based configuration. Registers all the default values and loads the configuration. have to be called immediately after the object's successful construction.
      Throws:
      IllegalStateException - Thrown when the field is either not accessible, of a not-supported type and neither serializable nor supporting toString/valueOf, or if the associated IConfigurationAction returned a value that cannot be used (invalid cast).

    • save

      public void save() throws IllegalStateException
      Saves a field-based configuration. Uses IConfigurationAction set to store them.
      Throws:
      IllegalStateException - Thrown when the field is either not accessible, of a not-supported type and neither serializable nor supporting toString/valueOf, or if the associated IConfigurationAction returned a value that cannot be used (invalid cast).

    • reload

      public void reload() throws IllegalStateException
      Reloads a field-based configuration using the IConfigurationAction reported values. Erases all pending changes.
      Throws:
      IllegalStateException - Thrown when the field is either not accessible, of a not-supported type and neither serializable nor supporting toString/valueOf, or if the associated IConfigurationAction returned a value that cannot be used (invalid cast).

    • saveDefaults

      protected void saveDefaults() throws IllegalStateException
      Save the default values of a field-based configuration. Uses IConfigurationAction setDefault to store them.
      Throws:
      IllegalStateException - Thrown when the field is either not accessible, of a not-supported type and neither serializable nor supporting toString/valueOf, or if the associated IConfigurationAction returned a value that cannot be used (invalid cast).

    • load

      protected void load() throws IllegalStateException
      Loads (and only loads) a field-based configuration using the IConfigurationAction reported values. Erases all pending changes.
      Throws:
      IllegalStateException - Thrown when the field is either not accessible, of a not-supported type and neither serializable nor supporting toString/valueOf, or if the associated IConfigurationAction returned a value that cannot be used (invalid cast).