Package de.exlll.configlib

Class YamlConfigurationStore<T>

java.lang.Object
de.exlll.configlib.YamlConfigurationStore<T>
Type Parameters:
T - the configuration type
All Implemented Interfaces:
de.exlll.configlib.FileConfigurationStore<T>, de.exlll.configlib.IOStreamConfigurationStore<T>
public final class YamlConfigurationStore<T> extends Object implements de.exlll.configlib.FileConfigurationStore<T>, de.exlll.configlib.IOStreamConfigurationStore<T>
A configuration store for YAML configurations. This class provides two pairs of methods: One pair for loading configurations from and saving them as YAML text files, and a second pair for reading configurations from input streams and writing them to output streams.

  • Constructor Details

    • YamlConfigurationStore

      public YamlConfigurationStore(Class<T> configurationType, YamlConfigurationProperties properties)
      Constructs a new store.
      Parameters:
      configurationType - the type of configuration
      properties - the properties
      Throws:
      NullPointerException - if any argument is null

  • Method Details

    • write

      public void write(T configuration, OutputStream outputStream)
      Specified by:
      write in interface de.exlll.configlib.IOStreamConfigurationStore<T>

    • save

      public void save(T configuration, Path configurationFile)
      Specified by:
      save in interface de.exlll.configlib.FileConfigurationStore<T>

    • read

      public T read(InputStream inputStream)
      Specified by:
      read in interface de.exlll.configlib.IOStreamConfigurationStore<T>

    • load

      public T load(Path configurationFile)
      Specified by:
      load in interface de.exlll.configlib.FileConfigurationStore<T>

    • update

      public T update(Path configurationFile)
      Specified by:
      update in interface de.exlll.configlib.FileConfigurationStore<T>