Package com.typesafe.config
-
Interface Summary Interface Description Config An immutable map from config paths to config values.ConfigIncludeContext Context provided to aConfigIncluder
; this interface is only useful inside aConfigIncluder
implementation, and is not intended for apps to implement.ConfigIncluder Implement this interface and provide an instance toConfigParseOptions.setIncluder()
to customize handling ofinclude
statements in config files.ConfigIncluderClasspath Implement this in addition toConfigIncluder
if you want to support inclusion of files with theinclude classpath("resource")
syntax.ConfigIncluderFile Implement this in addition toConfigIncluder
if you want to support inclusion of files with theinclude file("filename")
syntax.ConfigIncluderURL Implement this in addition toConfigIncluder
if you want to support inclusion of files with theinclude url("http://example.com")
syntax.ConfigList Subtype ofConfigValue
representing a list value, as in JSON's[1,2,3]
syntax.ConfigMergeable Marker for types whose instances can be merged, that isConfig
andConfigValue
.ConfigObject Subtype ofConfigValue
representing an object (AKA dictionary or map) value, as in JSON's curly brace{ "a" : 42 }
syntax.ConfigOrigin Represents the origin (such as filename and line number) of aConfigValue
for use in error messages.ConfigParseable An opaque handle to something that can be parsed, obtained fromConfigIncludeContext
.ConfigValue An immutable value, following the JSON type schema. -
Class Summary Class Description ConfigException.ValidationProblem Information about a problem that occurred inConfig.checkValid(com.typesafe.config.Config, java.lang.String...)
.ConfigFactory Contains static methods for creatingConfig
instances.ConfigParseOptions A set of options related to parsing.ConfigRenderOptions A set of options related to rendering aConfigValue
.ConfigResolveOptions A set of options related to resolving substitutions.ConfigUtil Contains static utility methods.ConfigValueFactory This class holds some static factory methods for buildingConfigValue
instances. -
Enum Summary Enum Description ConfigSyntax ConfigValueType The type of a configuration value (following the JSON type schema). -
Exception Summary Exception Description ConfigException All exceptions thrown by the library are subclasses ofConfigException
.ConfigException.BadPath Exception indicating that a path expression was invalid.ConfigException.BadValue Exception indicating that a value was messed up, for example you may have asked for a duration and the value can't be sensibly parsed as a duration.ConfigException.BugOrBroken Exception indicating that there's a bug in something (possibly the library itself) or the runtime environment is broken.ConfigException.Generic Exception that doesn't fall into any other category.ConfigException.IO Exception indicating that there was an IO error.ConfigException.Missing Exception indicates that the setting was never set to anything, not even null.ConfigException.NotResolved Exception indicating that you tried to use a function that requires substitutions to be resolved, but substitutions have not been resolved (that is,Config.resolve()
was not called).ConfigException.Null Exception indicates that the setting was treated as missing because it was set to null.ConfigException.Parse Exception indicating that there was a parse error.ConfigException.UnresolvedSubstitution Exception indicating that a substitution did not resolve to anything.ConfigException.ValidationFailed Exception indicating thatConfig.checkValid(com.typesafe.config.Config, java.lang.String...)
found validity problems.ConfigException.WrongType Exception indicating that the type of a value does not match the type you requested.