Class FileBasedConfig


  • public class FileBasedConfig
    extends StoredConfig
    The configuration file that is stored in the file of the file system.
    • Constructor Detail

      • FileBasedConfig

        public FileBasedConfig​(java.io.File cfgLocation,
                               FS fs)
        Create a configuration with no default fallback.
        Parameters:
        cfgLocation - the location of the configuration file on the file system
        fs - the file system abstraction which will be necessary to perform certain file system operations.
      • FileBasedConfig

        public FileBasedConfig​(Config base,
                               java.io.File cfgLocation,
                               FS fs)
        The constructor
        Parameters:
        base - the base configuration file
        cfgLocation - the location of the configuration file on the file system
        fs - the file system abstraction which will be necessary to perform certain file system operations.
    • Method Detail

      • getFile

        public final java.io.File getFile()
        Returns:
        location of the configuration file on disk
      • load

        public void load()
                  throws java.io.IOException,
                         ConfigInvalidException
        Load the configuration as a Git text style configuration file.

        If the file does not exist, this configuration is cleared, and thus behaves the same as though the file exists, but is empty.

        Specified by:
        load in class StoredConfig
        Throws:
        java.io.IOException - the file could not be read (but does exist).
        ConfigInvalidException - the file is not a properly formatted configuration file.
      • save

        public void save()
                  throws java.io.IOException
        Save the configuration as a Git text style configuration file.

        Warning: Although this method uses the traditional Git file locking approach to protect against concurrent writes of the configuration file, it does not ensure that the file has not been modified since the last read, which means updates performed by other objects accessing the same backing file may be lost.

        Specified by:
        save in class StoredConfig
        Throws:
        java.io.IOException - the file could not be written.
      • clear

        public void clear()
        Description copied from class: Config
        Clear the configuration file
        Overrides:
        clear in class StoredConfig
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • isOutdated

        public boolean isOutdated()
        Returns:
        returns true if the currently loaded configuration file is older than the file on disk