The default behavior of ConfigReaders that are implicitly derived in PureConfig is to raise a KeyNotFoundException when a required key is missing.
Trait containing ConfigReader
instances for primitive types and simple classes in Java and Scala standard
libraries.
Trait containing ConfigWriter
instances for primitive types and simple classes in Java and Scala standard
libraries.
Trait containing ConfigReader
instances for collection, product and coproduct types.
Trait containing ConfigWriter
instances for collection, product and coproduct types.
Trait containing ConfigReader
instances for Duration and FiniteDuration.
Trait containing ConfigWriter
instances for Duration and FiniteDuration.
Trait containing ConfigReader
instances for java.time
classes.
Trait containing ConfigWriter
instances for java.time
classes.
Trait containing ConfigReader
instances for primitive types.
Trait containing ConfigWriter
instances for primitive types.
Trait containing ConfigReader
instances for Typesafe config models.
Trait containing ConfigWriter
instances for Typesafe config models.
Trait containing ConfigReader
instances for classes related to file system paths and URIs.
Trait containing ConfigWriter
instances for classes related to file system paths and URIs.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Trait for objects capable of reading and writing objects of a given type from and to ConfigValues
.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Trait for objects capable of reading objects of a given type from ConfigValues
.
Trait for objects capable of writing objects of a given type to ConfigValues
.
Useful helpers for building ConfigConvert
instances and dealing with results.
A trait that can be implemented to disambiguate between the different options of a coproduct or sealed family.
Hint where the options are disambiguated by a key = "value"
field inside the config.
Hint where all coproduct options are tried in order.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
A trait that can be implemented to customize how case classes are read from and written to a config.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
CamelCase identifiers look like camelCase
and useMorePureconfig
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Provides methods to create ConfigConvert instances.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Provides methods to create ConfigReader instances.
Provides methods to create ConfigWriter instances.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
KebabCase identifiers look like kebab-case
and use-more-pureconfig
PascalCase identifiers look like e.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
SnakeCase identifiers look like snake_case
and use_more_pureconfig
Load a configuration of type Config
from the given Config
Load a configuration of type Config
from the given Config
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
Load a configuration of type Config
from the given Config
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given file.
Load a configuration of type Config
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
the base namespace from which the configuration should be load
A Success
with the configuration if it is possible to create an instance of type
Config
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given file.
Load a configuration of type Config
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
A Success
with the configuration if it is possible to create an instance of type
Config
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the standard configuration files
Load a configuration of type Config
from the standard configuration files
the base namespace from which the configuration should be load
A Success
with the configuration if it is possible to create an instance of type
Config
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the standard configuration files
Load a configuration of type Config
from the standard configuration files
A Success
with the configuration if it is possible to create an instance of type
Config
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Loads files
in order, allowing values in later files to backstop missing values from prior, and converts them into a Config
.
Loads files
in order, allowing values in later files to backstop missing values from prior, and converts them into a Config
.
This is a convenience method which enables having default configuration which backstops local configuration.
Note: If an element of files
references a file which doesn't exist or can't be read, it will silently be ignored.
Files ordered in decreasing priority containing part or all of a Config
. Must not be empty.
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
Load a configuration of type Config
from the given Config
Typesafe configuration to load
the base namespace from which the configuration should be load
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
Load a configuration of type Config
from the given Config
Typesafe configuration to load
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given file.
Load a configuration of type Config
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
the base namespace from which the configuration should be load
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given file.
Load a configuration of type Config
from the given file. Note that standard configuration
files are still loaded but can be overridden from the given configuration file
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the standard configuration files
Load a configuration of type Config
from the standard configuration files
the base namespace from which the configuration should be load
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the standard configuration files
Load a configuration of type Config
from the standard configuration files
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Typesafe configuration to load
the base namespace from which the configuration should be load
A Success
with the configuration if it is possible to create an instance of type
Config
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Typesafe configuration to load
A Success
with the configuration if it is possible to create an instance of type
Config
from the configuration files, else a Failure
with details on why it
isn't possible
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Typesafe configuration to load
the base namespace from which the configuration should be load
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Load a configuration of type Config
from the given Config
, falling back to the default configuration
Typesafe configuration to load
the configuration
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Save the given configuration into a property file
Save the given configuration into a property file
The configuration to save
Where to write the configuration
Override the path if it already exists
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig
Writes the configuration to the output stream and closes the stream
Writes the configuration to the output stream and closes the stream
The configuration to write
The stream in which the configuration should be written
(Since version 0.7.0) The pureconfig artifact with organization com.github.melrief is deprecated and won't be published anymore. Please update your dependency to use the organization com.github.pureconfig