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

Class FileAttributeConfiguration

java.lang.Object
fr.prodrivers.bukkit.commons.configuration.AbstractAttributeConfiguration
fr.prodrivers.bukkit.commons.configuration.file.AbstractFileAttributeConfiguration
fr.prodrivers.bukkit.commons.configuration.file.FileAttributeConfiguration
Direct Known Subclasses:
Messages
public class FileAttributeConfiguration extends AbstractFileAttributeConfiguration
Fully managed, field-based, Bukkit's FileConfiguration backed configuration class for Prodrivers plugins.

FileAttributeConfiguration extends AbstractFileAttributeConfiguration to handle all the loading and saving parts left to the programmer. No action is required apart from providing a valid File instance that points to the YAML file to be used, and calling AbstractAttributeConfiguration.init(). You, of course, still need to make call by yourself to AbstractAttributeConfiguration.reload() and AbstractAttributeConfiguration.save() when required.

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.

  • Constructor Details

    • FileAttributeConfiguration

      public FileAttributeConfiguration(File configurationFile)
      Fully managed, field-based, Bukkit's FileConfiguration backed configuration class constructor.
      Parameters:
      configurationFile - YAML file to use for storage