Package de.exlll.configlib

Class FileConfigurationProperties.Builder<B extends FileConfigurationProperties.Builder<B>>

java.lang.Object
de.exlll.configlib.ConfigurationProperties.Builder<B>
de.exlll.configlib.FileConfigurationProperties.Builder<B>
Type Parameters:
B - the type of builder
Enclosing class:
FileConfigurationProperties
public abstract static class FileConfigurationProperties.Builder<B extends FileConfigurationProperties.Builder<B>> extends ConfigurationProperties.Builder<B>
A builder class for constructing FileConfigurationProperties.

  • Constructor Details

    • Builder

      protected Builder()
      The default constructor.

    • Builder

      protected Builder(FileConfigurationProperties properties)
      A constructor that initializes this builder with values taken from the properties object.
      Parameters:
      properties - the properties object the values are taken from
      Throws:
      NullPointerException - if properties is null

  • Method Details

    • header

      public final B header(String header)
      Sets the header. The header is written as a comment before the actual configuration. If the header is set to null (the default), nothing is written.
      Parameters:
      header - the header
      Returns:
      this builder

    • footer

      public final B footer(String footer)
      Sets the footer. The footer is written as a comment after the actual configuration. If the footer is set to null (the default), nothing is written.
      Parameters:
      footer - the footer
      Returns:
      this builder

    • createParentDirectories

      public final B createParentDirectories(boolean createParentDirectories)
      Sets whether parent directories of a configuration file should be created.

      The default value is true.

      Parameters:
      createParentDirectories - whether to create parent directories
      Returns:
      this builder

    • charset

      public final B charset(Charset charset)
      Sets the charset used to read and write configuration files.

      Defaults to the system's default charset (Charset.defaultCharset()).

      Parameters:
      charset - the charset
      Returns:
      this builder

    • build

      public abstract FileConfigurationProperties build()
      Builds a ConfigurationProperties instance.
      Specified by:
      build in class ConfigurationProperties.Builder<B extends FileConfigurationProperties.Builder<B>>
      Returns:
      newly constructed ConfigurationProperties

    • getThis

      protected abstract B getThis()
      Returns this builder.
      Specified by:
      getThis in class ConfigurationProperties.Builder<B extends FileConfigurationProperties.Builder<B>>
      Returns:
      this builder