Package de.exlll.configlib

Class FileConfigurationProperties

java.lang.Object
de.exlll.configlib.ConfigurationProperties
de.exlll.configlib.FileConfigurationProperties
public class FileConfigurationProperties extends ConfigurationProperties
An extension of the ConfigurationProperties class that allows configuring properties that are more specific to files.

  • Constructor Details

    • FileConfigurationProperties

      protected FileConfigurationProperties(FileConfigurationProperties.Builder<?> builder)
      Constructs a new instance of this class with values taken from the given builder.
      Parameters:
      builder - the builder used to initialize the fields of this class
      Throws:
      NullPointerException - if the builder or any of its values is null

  • Method Details

    • newBuilder

      public static FileConfigurationProperties.Builder<?> newBuilder()
      Constructs a new Builder with default values.
      Returns:
      newly constructed Builder

    • toBuilder

      public FileConfigurationProperties.Builder<?> toBuilder()
      Description copied from class: ConfigurationProperties
      Creates a new builder and initializes it with values taken from this properties object.
      Overrides:
      toBuilder in class ConfigurationProperties
      Returns:
      new builder

    • getHeader

      public final String getHeader()
      Returns the header.
      Returns:
      the header

    • getFooter

      public final String getFooter()
      Returns the footer.
      Returns:
      the footer

    • createParentDirectories

      public final boolean createParentDirectories()
      Returns whether to create parent directories.
      Returns:
      whether to create parent directories

    • getCharset

      public final Charset getCharset()
      Returns the charset used to read and write configuration files.
      Returns:
      the charset