Index
All Classes and Interfaces|All Packages|Serialized Form
A
- appendIncluder(ConfigIncluder) - Method in class com.typesafe.config.ConfigParseOptions
-
Appends a
ConfigIncluder
which customizes how includes are handled. - atKey(String) - Method in interface com.typesafe.config.Config
-
Places the config inside a
Config
at the given key. - atKey(String) - Method in interface com.typesafe.config.ConfigValue
-
Places the value inside a
Config
at the given key. - atPath(String) - Method in interface com.typesafe.config.Config
-
Places the config inside another
Config
at the given path. - atPath(String) - Method in interface com.typesafe.config.ConfigValue
-
Places the value inside a
Config
at the given path.
B
- BadBean(String) - Constructor for exception com.typesafe.config.ConfigException.BadBean
- BadBean(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.BadBean
- BadPath(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.BadPath
- BadPath(ConfigOrigin, String, String) - Constructor for exception com.typesafe.config.ConfigException.BadPath
- BadPath(ConfigOrigin, String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.BadPath
- BadPath(String, String) - Constructor for exception com.typesafe.config.ConfigException.BadPath
- BadPath(String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.BadPath
- BadValue(ConfigOrigin, String, String) - Constructor for exception com.typesafe.config.ConfigException.BadValue
- BadValue(ConfigOrigin, String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.BadValue
- BadValue(String, String) - Constructor for exception com.typesafe.config.ConfigException.BadValue
- BadValue(String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.BadValue
- BOOLEAN - Enum constant in enum com.typesafe.config.ConfigValueType
- BugOrBroken(String) - Constructor for exception com.typesafe.config.ConfigException.BugOrBroken
- BugOrBroken(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.BugOrBroken
C
- checkValid(Config, String...) - Method in interface com.typesafe.config.Config
-
Validates this config against a reference config, throwing an exception if it is invalid.
- com.typesafe.config - package com.typesafe.config
- com.typesafe.config.impl - package com.typesafe.config.impl
- com.typesafe.config.parser - package com.typesafe.config.parser
- comments() - Method in interface com.typesafe.config.ConfigOrigin
-
Returns any comments that appeared to "go with" this place in the file.
- computeCachedConfig(ClassLoader, String, Callable<Config>) - Static method in class com.typesafe.config.impl.ConfigImpl
- concise() - Static method in class com.typesafe.config.ConfigRenderOptions
-
Returns concise render options (no whitespace or comments).
- CONF - Enum constant in enum com.typesafe.config.ConfigSyntax
-
The JSON-superset HOCON format.
- Config - Interface in com.typesafe.config
-
An immutable map from config paths to config values.
- ConfigBeanFactory - Class in com.typesafe.config
-
Factory for automatically creating a Java class from a
Config
. - ConfigBeanFactory() - Constructor for class com.typesafe.config.ConfigBeanFactory
- ConfigBeanImpl - Class in com.typesafe.config.impl
-
Internal implementation detail, not ABI stable, do not touch.
- ConfigBeanImpl() - Constructor for class com.typesafe.config.impl.ConfigBeanImpl
- ConfigDocument - Interface in com.typesafe.config.parser
-
Represents an individual HOCON or JSON file, preserving all formatting and syntax details.
- ConfigDocumentFactory - Class in com.typesafe.config.parser
-
Factory for creating
ConfigDocument
instances. - ConfigDocumentFactory() - Constructor for class com.typesafe.config.parser.ConfigDocumentFactory
- ConfigException - Exception in com.typesafe.config
-
All exceptions thrown by the library are subclasses of
ConfigException
. - ConfigException(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException
- ConfigException(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException
- ConfigException(String) - Constructor for exception com.typesafe.config.ConfigException
- ConfigException(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException
- ConfigException.BadBean - Exception in com.typesafe.config
-
Some problem with a JavaBean we are trying to initialize.
- ConfigException.BadPath - Exception in com.typesafe.config
-
Exception indicating that a path expression was invalid.
- ConfigException.BadValue - Exception in com.typesafe.config
-
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 in com.typesafe.config
-
Exception indicating that there's a bug in something (possibly the library itself) or the runtime environment is broken.
- ConfigException.Generic - Exception in com.typesafe.config
-
Exception that doesn't fall into any other category.
- ConfigException.IO - Exception in com.typesafe.config
-
Exception indicating that there was an IO error.
- ConfigException.Missing - Exception in com.typesafe.config
-
Exception indicates that the setting was never set to anything, not even null.
- ConfigException.NotResolved - Exception in com.typesafe.config
-
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 in com.typesafe.config
-
Exception indicates that the setting was treated as missing because it was set to null.
- ConfigException.Parse - Exception in com.typesafe.config
-
Exception indicating that there was a parse error.
- ConfigException.UnresolvedSubstitution - Exception in com.typesafe.config
-
Exception indicating that a substitution did not resolve to anything.
- ConfigException.ValidationFailed - Exception in com.typesafe.config
-
Exception indicating that
Config.checkValid(com.typesafe.config.Config, java.lang.String...)
found validity problems. - ConfigException.ValidationProblem - Class in com.typesafe.config
-
Information about a problem that occurred in
Config.checkValid(com.typesafe.config.Config, java.lang.String...)
. - ConfigException.WrongType - Exception in com.typesafe.config
-
Exception indicating that the type of a value does not match the type you requested.
- ConfigFactory - Class in com.typesafe.config
-
Contains static methods for creating
Config
instances. - ConfigImpl - Class in com.typesafe.config.impl
-
Internal implementation detail, not ABI stable, do not touch.
- ConfigImpl() - Constructor for class com.typesafe.config.impl.ConfigImpl
- ConfigImplUtil - Class in com.typesafe.config.impl
-
Internal implementation detail, not ABI stable, do not touch.
- ConfigImplUtil() - Constructor for class com.typesafe.config.impl.ConfigImplUtil
- ConfigIncludeContext - Interface in com.typesafe.config
-
Context provided to a
ConfigIncluder
; this interface is only useful inside aConfigIncluder
implementation, and is not intended for apps to implement. - ConfigIncluder - Interface in com.typesafe.config
-
Implement this interface and provide an instance to
ConfigParseOptions.setIncluder()
to customize handling ofinclude
statements in config files. - ConfigIncluderClasspath - Interface in com.typesafe.config
-
Implement this in addition to
ConfigIncluder
if you want to support inclusion of files with theinclude classpath("resource")
syntax. - ConfigIncluderFile - Interface in com.typesafe.config
-
Implement this in addition to
ConfigIncluder
if you want to support inclusion of files with theinclude file("filename")
syntax. - ConfigIncluderURL - Interface in com.typesafe.config
-
Implement this in addition to
ConfigIncluder
if you want to support inclusion of files with theinclude url("http://example.com")
syntax. - ConfigList - Interface in com.typesafe.config
-
Subtype of
ConfigValue
representing a list value, as in JSON's[1,2,3]
syntax. - ConfigLoadingStrategy - Interface in com.typesafe.config
-
This method allows you to alter default config loading strategy for all the code which calls
ConfigFactory.load(java.lang.String)
. - ConfigMemorySize - Class in com.typesafe.config
-
An immutable class representing an amount of memory.
- ConfigMergeable - Interface in com.typesafe.config
-
Marker for types whose instances can be merged, that is
Config
andConfigValue
. - ConfigNode - Interface in com.typesafe.config.parser
-
A node in the syntax tree for a HOCON or JSON document.
- ConfigObject - Interface in com.typesafe.config
-
Subtype of
ConfigValue
representing an object (AKA dictionary or map) value, as in JSON's curly brace{ "a" : 42 }
syntax. - ConfigOrigin - Interface in com.typesafe.config
-
Represents the origin (such as filename and line number) of a
ConfigValue
for use in error messages. - ConfigOriginFactory - Class in com.typesafe.config
-
This class contains some static factory methods for building a
ConfigOrigin
. - ConfigParseable - Interface in com.typesafe.config
-
An opaque handle to something that can be parsed, obtained from
ConfigIncludeContext
. - ConfigParseOptions - Class in com.typesafe.config
-
A set of options related to parsing.
- ConfigRenderOptions - Class in com.typesafe.config
-
A set of options related to rendering a
ConfigValue
. - ConfigResolveOptions - Class in com.typesafe.config
-
A set of options related to resolving substitutions.
- ConfigSyntax - Enum in com.typesafe.config
- ConfigUtil - Class in com.typesafe.config
-
Contains static utility methods.
- ConfigValue - Interface in com.typesafe.config
-
An immutable value, following the JSON type schema.
- ConfigValueFactory - Class in com.typesafe.config
-
This class holds some static factory methods for building
ConfigValue
instances. - ConfigValueType - Enum in com.typesafe.config
-
The type of a configuration value (following the JSON type schema).
- create(Config, Class<T>) - Static method in class com.typesafe.config.ConfigBeanFactory
-
Creates an instance of a class, initializing its fields from a
Config
. - createInternal(Config, Class<T>) - Static method in class com.typesafe.config.impl.ConfigBeanImpl
-
This is public ONLY for use by the "config" package, DO NOT USE this ABI may change.
- createOrigin() - Method in class com.typesafe.config.impl.Parseable
D
- defaultApplication() - Static method in class com.typesafe.config.ConfigFactory
-
Obtains the default application-specific configuration, which defaults to parsing
application.conf
,application.json
, andapplication.properties
on the classpath, but can also be rerouted using theconfig.file
,config.resource
, andconfig.url
system properties. - defaultApplication(ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.defaultApplication()
but allows you to specify parse options. - defaultApplication(ClassLoader) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.defaultApplication()
but allows you to specify a class loader to use rather than the current context class loader. - DefaultConfigLoadingStrategy - Class in com.typesafe.config
-
Default config loading strategy.
- DefaultConfigLoadingStrategy() - Constructor for class com.typesafe.config.DefaultConfigLoadingStrategy
- defaultOverrides() - Static method in class com.typesafe.config.ConfigFactory
-
Obtains the default override configuration, which currently consists of system properties.
- defaultOverrides(ClassLoader) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.defaultOverrides()
but allows you to specify a class loader to use rather than the current context class loader. - defaultReference() - Static method in class com.typesafe.config.ConfigFactory
-
Obtains the default reference configuration, which is currently created by merging all resources "reference.conf" found on the classpath and overriding the result with system properties.
- defaultReference(ClassLoader) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.defaultReference()
but allows you to specify a class loader to use rather than the current context class loader. - defaultReference(ClassLoader) - Static method in class com.typesafe.config.impl.ConfigImpl
- defaults() - Static method in class com.typesafe.config.ConfigParseOptions
-
Gets an instance of
ConfigParseOptions
with all fields set to the default values. - defaults() - Static method in class com.typesafe.config.ConfigRenderOptions
-
Returns the default render options which are verbose (commented and formatted).
- defaults() - Static method in class com.typesafe.config.ConfigResolveOptions
-
Returns the default resolve options.
- description() - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a string describing the origin of a value or exception.
E
- empty() - Static method in class com.typesafe.config.ConfigFactory
-
Gets an empty configuration.
- empty(String) - Static method in class com.typesafe.config.ConfigFactory
-
Gets an empty configuration with a description to be used to create a
ConfigOrigin
for thisConfig
. - emptyConfig(String) - Static method in class com.typesafe.config.impl.ConfigImpl
- entrySet() - Method in interface com.typesafe.config.Config
-
Returns the set of path-value pairs, excluding any null values, found by recursing
the root object
. - envVariablesAsConfig() - Static method in class com.typesafe.config.impl.ConfigImpl
- equals(Object) - Method in class com.typesafe.config.ConfigMemorySize
- extractInitializerError(ExceptionInInitializerError) - Static method in class com.typesafe.config.impl.ConfigImplUtil
F
- filename() - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a filename describing the origin.
- fromAnyRef(Object) - Static method in class com.typesafe.config.ConfigValueFactory
-
See the other overload
ConfigValueFactory.fromAnyRef(Object,String)
for details, this one just uses a default origin description. - fromAnyRef(Object, String) - Static method in class com.typesafe.config.ConfigValueFactory
-
Creates a
ConfigValue
from a plain Java boxed value, which may be aBoolean
,Number
,String
,Map
,Iterable
, ornull
. - fromAnyRef(Object, String) - Static method in class com.typesafe.config.impl.ConfigImpl
- fromIterable(Iterable<? extends Object>) - Static method in class com.typesafe.config.ConfigValueFactory
-
See the other overload of
ConfigValueFactory.fromIterable(Iterable, String)
for details, this one just uses a default origin description. - fromIterable(Iterable<? extends Object>, String) - Static method in class com.typesafe.config.ConfigValueFactory
-
See the
ConfigValueFactory.fromAnyRef(Object,String)
documentation for details. - fromMap(Map<String, ? extends Object>) - Static method in class com.typesafe.config.ConfigValueFactory
-
See the other overload
ConfigValueFactory.fromMap(Map,String)
for details, this one just uses a default origin description. - fromMap(Map<String, ? extends Object>, String) - Static method in class com.typesafe.config.ConfigValueFactory
-
See the
ConfigValueFactory.fromAnyRef(Object,String)
documentation for details. - fromPathMap(Map<String, ? extends Object>, String) - Static method in class com.typesafe.config.impl.ConfigImpl
G
- Generic(String) - Constructor for exception com.typesafe.config.ConfigException.Generic
- Generic(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Generic
- get(Object) - Method in interface com.typesafe.config.ConfigObject
-
Gets a
ConfigValue
at the given key, or returns null if there is no value. - getAllowMissing() - Method in class com.typesafe.config.ConfigParseOptions
-
Gets the current "allow missing" flag.
- getAllowUnresolved() - Method in class com.typesafe.config.ConfigResolveOptions
-
Returns whether the options allow unresolved substitutions.
- getAnyRef(String) - Method in interface com.typesafe.config.Config
-
Gets the value at the path as an unwrapped Java boxed value (
Boolean
,Integer
, and so on - seeConfigValue.unwrapped()
). - getAnyRefList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with any kind of elements.
- getBoolean(String) - Method in interface com.typesafe.config.Config
- getBooleanList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with boolean elements.
- getBytes(String) - Method in interface com.typesafe.config.Config
-
Gets a value as a size in bytes (parses special strings like "128M").
- getBytesList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with elements representing a size in bytes.
- getClassLoader() - Method in class com.typesafe.config.ConfigParseOptions
-
Get the class loader; never returns
null
, if the class loader was unset, returnsThread.currentThread().getContextClassLoader()
. - getComments() - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns whether the options enable comments.
- getConfig(String) - Method in interface com.typesafe.config.Config
- getConfigList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with
Config
elements. - getDouble(String) - Method in interface com.typesafe.config.Config
- getDoubleList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with double elements.
- getDuration(String) - Method in interface com.typesafe.config.Config
-
Gets a value as a java.time.Duration.
- getDuration(String, TimeUnit) - Method in interface com.typesafe.config.Config
-
Gets a value as a duration in a specified
TimeUnit
. - getDurationList(String) - Method in interface com.typesafe.config.Config
-
Gets a list, converting each value in the list to a duration, using the same rules as
Config.getDuration(String)
. - getDurationList(String, TimeUnit) - Method in interface com.typesafe.config.Config
-
Gets a list, converting each value in the list to a duration, using the same rules as
Config.getDuration(String, TimeUnit)
. - getEnum(Class<T>, String) - Method in interface com.typesafe.config.Config
- getEnumList(Class<T>, String) - Method in interface com.typesafe.config.Config
-
Gets a list value with
Enum
elements. - getFormatted() - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns whether the options enable formatting.
- getIncluder() - Method in class com.typesafe.config.ConfigParseOptions
-
Gets the current includer (will be null for the default includer).
- getInt(String) - Method in interface com.typesafe.config.Config
-
Gets the integer at the given path.
- getIntList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with int elements.
- getIsNull(String) - Method in interface com.typesafe.config.Config
-
Checks whether a value is set to null at the given path, but throws an exception if the value is entirely unset.
- getJson() - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns whether the options enable JSON.
- getList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value (with any element type) as a
ConfigList
, which implementsjava.util.List<ConfigValue>
. - getLong(String) - Method in interface com.typesafe.config.Config
-
Gets the long integer at the given path.
- getLongList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with long elements.
- getMemorySize(String) - Method in interface com.typesafe.config.Config
-
Gets a value as an amount of memory (parses special strings like "128M").
- getMemorySizeList(String) - Method in interface com.typesafe.config.Config
-
Gets a list, converting each value in the list to a memory size, using the same rules as
Config.getMemorySize(String)
. - getMilliseconds(String) - Method in interface com.typesafe.config.Config
-
Deprecated.
- getMillisecondsList(String) - Method in interface com.typesafe.config.Config
-
Deprecated.As of release 1.1, replaced by
Config.getDurationList(String, TimeUnit)
- getNanoseconds(String) - Method in interface com.typesafe.config.Config
-
Deprecated.As of release 1.1, replaced by
Config.getDuration(String, TimeUnit)
- getNanosecondsList(String) - Method in interface com.typesafe.config.Config
-
Deprecated.As of release 1.1, replaced by
Config.getDurationList(String, TimeUnit)
- getNumber(String) - Method in interface com.typesafe.config.Config
- getNumberList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with number elements.
- getObject(String) - Method in interface com.typesafe.config.Config
- getObjectList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with object elements.
- getOriginComments() - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns whether the options enable automated origin comments.
- getOriginDescription() - Method in class com.typesafe.config.ConfigParseOptions
-
Gets the current origin description, which may be null for "automatic".
- getString(String) - Method in interface com.typesafe.config.Config
- getStringList(String) - Method in interface com.typesafe.config.Config
-
Gets a list value with string elements.
- getSyntax() - Method in class com.typesafe.config.ConfigParseOptions
-
Gets the current syntax option, which may be null for "any".
- getUseSystemEnvironment() - Method in class com.typesafe.config.ConfigResolveOptions
-
Returns whether the options enable use of system environment variables.
- getValue(String) - Method in interface com.typesafe.config.Config
-
Gets the value at the given path, unless the value is a null value or missing, in which case it throws just like the other getters.
H
- hashCode() - Method in class com.typesafe.config.ConfigMemorySize
- hasPath(String) - Method in interface com.typesafe.config.Config
-
Checks whether a value is present and non-null at the given path.
- hasPath(String) - Method in interface com.typesafe.config.parser.ConfigDocument
-
Returns a boolean indicating whether or not a ConfigDocument has a value at the desired path.
- hasPathOrNull(String) - Method in interface com.typesafe.config.Config
-
Checks whether a value is present at the given path, even if the value is null.
I
- include(ConfigIncludeContext, String) - Method in interface com.typesafe.config.ConfigIncluder
-
Parses another item to be included.
- includeFile(ConfigIncludeContext, File) - Method in interface com.typesafe.config.ConfigIncluderFile
-
Parses another item to be included.
- includeResources(ConfigIncludeContext, String) - Method in interface com.typesafe.config.ConfigIncluderClasspath
-
Parses another item to be included.
- includeURL(ConfigIncludeContext, URL) - Method in interface com.typesafe.config.ConfigIncluderURL
-
Parses another item to be included.
- invalidateCaches() - Static method in class com.typesafe.config.ConfigFactory
-
Reloads any cached configs, picking up changes to system properties for example.
- IO(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.IO
- IO(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.IO
- isEmpty() - Method in interface com.typesafe.config.Config
-
Returns true if the
Config
's root object contains no key-value pairs. - isResolved() - Method in interface com.typesafe.config.Config
-
Checks whether the config is completely resolved.
J
- joinPath(String...) - Static method in class com.typesafe.config.ConfigUtil
-
Converts a list of keys to a path expression, by quoting the path elements as needed and then joining them separated by a period.
- joinPath(String...) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- joinPath(List<String>) - Static method in class com.typesafe.config.ConfigUtil
-
Converts a list of strings to a path expression, by quoting the path elements as needed and then joining them separated by a period.
- joinPath(List<String>) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- JSON - Enum constant in enum com.typesafe.config.ConfigSyntax
-
Pedantically strict JSON format; no comments, no unexpected commas, no duplicate keys in the same object.
L
- lineNumber() - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a line number where the value or exception originated.
- LIST - Enum constant in enum com.typesafe.config.ConfigValueType
- load() - Static method in class com.typesafe.config.ConfigFactory
-
Loads a default configuration, equivalent to
load(defaultApplication())
in most cases. - load(Config) - Static method in class com.typesafe.config.ConfigFactory
-
Assembles a standard configuration using a custom
Config
object rather than loading "application.conf". - load(ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load()
but allows specifying parse options. - load(ConfigParseOptions, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load()
but allows specifying parse options and resolve options. - load(Config, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load(Config)
but allows you to specifyConfigResolveOptions
. - load(ClassLoader) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load()
but allows specifying a class loader other than the thread's current context class loader. - load(ClassLoader, Config) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load(Config)
but allows you to specify the class loader for looking up resources. - load(ClassLoader, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load()
but allows specifying a class loader other than the thread's current context class loader and also specify parse options. - load(ClassLoader, ConfigParseOptions, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load()
but allows specifying a class loader other than the thread's current context class loader, parse options, and resolve options. - load(ClassLoader, Config, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load(Config,ConfigResolveOptions)
but allows you to specify a class loader other than the context class loader. - load(ClassLoader, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load()
but allows specifying a class loader other than the thread's current context class loader and also specify resolve options. - load(ClassLoader, String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load(String)
but uses the supplied class loader instead of the current thread's context class loader. - load(ClassLoader, String, ConfigParseOptions, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load(String,ConfigParseOptions,ConfigResolveOptions)
but has a class loader parameter that overrides any from theConfigParseOptions
. - load(String) - Static method in class com.typesafe.config.ConfigFactory
-
Loads an application's configuration from the given classpath resource or classpath resource basename, sandwiches it between default reference config and default overrides, and then resolves it.
- load(String, ConfigParseOptions, ConfigResolveOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.load(String)
but allows you to specify parse and resolve options.
M
- Missing(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.Missing
- Missing(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Missing
- Missing(String) - Constructor for exception com.typesafe.config.ConfigException.Missing
- Missing(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Missing
N
- newFile(File, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newFile(String) - Static method in class com.typesafe.config.ConfigOriginFactory
-
Creates a file origin with the given filename.
- newFileOrigin(String) - Static method in class com.typesafe.config.impl.ConfigImpl
- newNotFound(String, String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newProperties(Properties, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newReader(Reader, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newResources(Class<?>, String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newResources(String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newSimple() - Static method in class com.typesafe.config.ConfigOriginFactory
-
Returns the default origin for values when no other information is provided.
- newSimple(String) - Static method in class com.typesafe.config.ConfigOriginFactory
-
Returns an origin with the given description.
- newSimpleOrigin(String) - Static method in class com.typesafe.config.impl.ConfigImpl
- newString(String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newURL(URL) - Static method in class com.typesafe.config.ConfigOriginFactory
-
Creates a url origin with the given URL object.
- newURL(URL, ConfigParseOptions) - Static method in class com.typesafe.config.impl.Parseable
- newURLOrigin(URL) - Static method in class com.typesafe.config.impl.ConfigImpl
- noSystem() - Static method in class com.typesafe.config.ConfigResolveOptions
-
Returns resolve options that disable any reference to "system" data (currently, this means environment variables).
- NotResolved(String) - Constructor for exception com.typesafe.config.ConfigException.NotResolved
- NotResolved(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.NotResolved
- Null(ConfigOrigin, String, String) - Constructor for exception com.typesafe.config.ConfigException.Null
- Null(ConfigOrigin, String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Null
- NULL - Enum constant in enum com.typesafe.config.ConfigValueType
- NUMBER - Enum constant in enum com.typesafe.config.ConfigValueType
O
- OBJECT - Enum constant in enum com.typesafe.config.ConfigValueType
- ofBytes(long) - Static method in class com.typesafe.config.ConfigMemorySize
-
Constructs a ConfigMemorySize representing the given number of bytes.
- Optional - Annotation Type in com.typesafe.config
-
Allows an config property to be
null
. - options() - Method in interface com.typesafe.config.ConfigParseable
-
Get the initial options, which can be modified then passed to parse().
- options() - Method in class com.typesafe.config.impl.Parseable
- origin() - Method in interface com.typesafe.config.Config
-
Gets the origin of the
Config
, which may be a file, or a file with a line number, or just a descriptive phrase. - origin() - Method in exception com.typesafe.config.ConfigException
-
Returns an "origin" (such as a filename and line number) for the exception, or null if none is available.
- origin() - Method in class com.typesafe.config.ConfigException.ValidationProblem
-
Returns where the problem occurred (origin may include info on the file, line number, etc.).
- origin() - Method in interface com.typesafe.config.ConfigParseable
-
Returns a
ConfigOrigin
describing the origin of the parseable item. - origin() - Method in interface com.typesafe.config.ConfigValue
-
The origin of the value (file, line number, etc.), for debugging and error messages.
- origin() - Method in class com.typesafe.config.impl.Parseable
P
- parse() - Method in class com.typesafe.config.impl.Parseable
- parse(ConfigParseOptions) - Method in interface com.typesafe.config.ConfigParseable
-
Parse whatever it is.
- parse(ConfigParseOptions) - Method in class com.typesafe.config.impl.Parseable
- Parse(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.Parse
- Parse(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Parse
- Parseable - Class in com.typesafe.config.impl
-
Internal implementation detail, not ABI stable, do not touch.
- Parseable() - Constructor for class com.typesafe.config.impl.Parseable
- Parseable.Relativizer - Interface in com.typesafe.config.impl
-
Internal implementation detail, not ABI stable, do not touch.
- parseApplicationConfig(ConfigParseOptions) - Method in interface com.typesafe.config.ConfigLoadingStrategy
-
This method must load and parse application config.
- parseApplicationConfig(ConfigParseOptions) - Method in class com.typesafe.config.DefaultConfigLoadingStrategy
- parseConfigDocument() - Method in class com.typesafe.config.impl.Parseable
- parseFile(File) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a file into a Config instance as with
ConfigFactory.parseFile(File,ConfigParseOptions)
but always uses the default parse options. - parseFile(File) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a file into a ConfigDocument instance as with
ConfigDocumentFactory.parseFile(File,ConfigParseOptions)
but always uses the default parse options. - parseFile(File, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a file into a Config instance.
- parseFile(File, ConfigParseOptions) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a file into a ConfigDocument instance.
- parseFileAnySyntax(File) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseFileAnySyntax(File,ConfigParseOptions)
but always uses default parse options. - parseFileAnySyntax(File, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a file with a flexible extension.
- parseFileAnySyntax(File, ConfigParseOptions) - Static method in class com.typesafe.config.impl.ConfigImpl
- parseMap(Map<String, ? extends Object>) - Static method in class com.typesafe.config.ConfigFactory
-
See the other overload of
ConfigFactory.parseMap(Map, String)
for details, this one just uses a default origin description. - parseMap(Map<String, ? extends Object>, String) - Static method in class com.typesafe.config.ConfigFactory
-
Creates a
Config
based on aMap
from paths to plain Java values. - parseOptions() - Method in interface com.typesafe.config.ConfigIncludeContext
-
Parse options to use (if you use another method to get a
ConfigParseable
then useConfigParseable.options()
instead though). - parseProperties(Properties) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseProperties(Properties, ConfigParseOptions)
but uses default parse options. - parseProperties(Properties, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
- parseReader(Reader) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a reader into a Config instance as with
ConfigFactory.parseReader(Reader,ConfigParseOptions)
but always uses the default parse options. - parseReader(Reader) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a reader into a Config instance as with
ConfigDocumentFactory.parseReader(Reader,ConfigParseOptions)
but always uses the default parse options. - parseReader(Reader, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a Reader into a Config instance.
- parseReader(Reader, ConfigParseOptions) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a Reader into a ConfigDocument instance.
- parseResources(Class<?>, String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResources(Class,String,ConfigParseOptions)
but always uses default parse options. - parseResources(Class<?>, String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses all resources on the classpath with the given name and merges them into a single
Config
. - parseResources(ClassLoader, String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResources(ClassLoader,String,ConfigParseOptions)
but always uses default parse options. - parseResources(ClassLoader, String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses all resources on the classpath with the given name and merges them into a single
Config
. - parseResources(String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResources(ClassLoader,String)
but uses thread's current context class loader. - parseResources(String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResources(ClassLoader,String,ConfigParseOptions)
but uses thread's current context class loader if none is set in the ConfigParseOptions. - parseResourcesAnySyntax(Class<?>, String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResourcesAnySyntax(Class,String,ConfigParseOptions)
but always uses default parse options. - parseResourcesAnySyntax(Class<?>, String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses classpath resources with a flexible extension.
- parseResourcesAnySyntax(Class<?>, String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.ConfigImpl
- parseResourcesAnySyntax(ClassLoader, String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResourcesAnySyntax(ClassLoader,String,ConfigParseOptions)
but always uses default parse options. - parseResourcesAnySyntax(ClassLoader, String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses classpath resources with a flexible extension.
- parseResourcesAnySyntax(String) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResourcesAnySyntax(ClassLoader,String)
but uses thread's current context class loader. - parseResourcesAnySyntax(String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Like
ConfigFactory.parseResourcesAnySyntax(ClassLoader,String,ConfigParseOptions)
but uses thread's current context class loader. - parseResourcesAnySyntax(String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.ConfigImpl
- parseString(String) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a string (which should be valid HOCON or JSON).
- parseString(String) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a string (which should be valid HOCON or JSON).
- parseString(String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a string (which should be valid HOCON or JSON by default, or the syntax specified in the options otherwise).
- parseString(String, ConfigParseOptions) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a string which should be valid HOCON or JSON.
- parseURL(URL) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a url into a Config instance as with
ConfigFactory.parseURL(URL,ConfigParseOptions)
but always uses the default parse options. - parseURL(URL, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a URL into a Config instance.
- path() - Method in class com.typesafe.config.ConfigException.ValidationProblem
-
Returns the config setting causing the problem.
- postConstruct(ConfigParseOptions) - Method in class com.typesafe.config.impl.Parseable
- prependIncluder(ConfigIncluder) - Method in class com.typesafe.config.ConfigParseOptions
-
Prepends a
ConfigIncluder
which customizes how includes are handled. - problem() - Method in class com.typesafe.config.ConfigException.ValidationProblem
-
Returns a description of the problem.
- problems() - Method in exception com.typesafe.config.ConfigException.ValidationFailed
- PROPERTIES - Enum constant in enum com.typesafe.config.ConfigSyntax
-
Standard Java properties format.
Q
- quoteString(String) - Static method in class com.typesafe.config.ConfigUtil
-
Quotes and escapes a string, as in the JSON specification.
R
- rawParseDocument(ConfigOrigin, ConfigParseOptions) - Method in class com.typesafe.config.impl.Parseable
- rawParseValue(ConfigOrigin, ConfigParseOptions) - Method in class com.typesafe.config.impl.Parseable
- reader() - Method in class com.typesafe.config.impl.Parseable
- reader(ConfigParseOptions) - Method in class com.typesafe.config.impl.Parseable
- readOrigin(ObjectInputStream) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- relativeTo(String) - Method in interface com.typesafe.config.ConfigIncludeContext
-
Tries to find a name relative to whatever is doing the including, for example in the same directory as the file doing the including.
- relativeTo(String) - Method in interface com.typesafe.config.impl.Parseable.Relativizer
- reloadSystemPropertiesConfig() - Static method in class com.typesafe.config.impl.ConfigImpl
- render() - Method in interface com.typesafe.config.ConfigValue
-
Renders the config value as a HOCON string.
- render() - Method in interface com.typesafe.config.parser.ConfigDocument
-
The original text of the input, modified if necessary with any replaced or added values.
- render() - Method in interface com.typesafe.config.parser.ConfigNode
-
The original text of the input which was used to form this particular node.
- render(ConfigRenderOptions) - Method in interface com.typesafe.config.ConfigValue
-
Renders the config value to a string, using the provided options.
- renderJsonString(String) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- resolve() - Method in interface com.typesafe.config.Config
-
Returns a replacement config with all substitutions (the
${foo.bar}
syntax, see the spec) resolved. - resolve(ConfigResolveOptions) - Method in interface com.typesafe.config.Config
-
Like
Config.resolve()
but allows you to specify non-default options. - resolveWith(Config) - Method in interface com.typesafe.config.Config
-
Like
Config.resolve()
except that substitution values are looked up in the given source, rather than in this instance. - resolveWith(Config, ConfigResolveOptions) - Method in interface com.typesafe.config.Config
-
Like
Config.resolveWith(Config)
but allows you to specify non-default options. - resource() - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a classpath resource name describing the origin.
- root() - Method in interface com.typesafe.config.Config
-
Gets the
Config
as a tree ofConfigObject
.
S
- setAllowMissing(boolean) - Method in class com.typesafe.config.ConfigParseOptions
-
Set to false to throw an exception if the item being parsed (for example a file) is missing.
- setAllowUnresolved(boolean) - Method in class com.typesafe.config.ConfigResolveOptions
-
Returns options with "allow unresolved" set to the given value.
- setClassLoader(ClassLoader) - Method in class com.typesafe.config.ConfigParseOptions
-
Set the class loader.
- setComments(boolean) - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns options with comments toggled.
- setFormatted(boolean) - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns options with formatting toggled.
- setIncluder(ConfigIncluder) - Method in class com.typesafe.config.ConfigParseOptions
-
Set a
ConfigIncluder
which customizes how includes are handled. - setJson(boolean) - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns options with JSON toggled.
- setOriginComments(boolean) - Method in class com.typesafe.config.ConfigRenderOptions
-
Returns options with origin comments toggled.
- setOriginDescription(String) - Method in class com.typesafe.config.ConfigParseOptions
-
Set a description for the thing being parsed.
- setParseOptions(ConfigParseOptions) - Method in interface com.typesafe.config.ConfigIncludeContext
-
Copy this
ConfigIncludeContext
giving it a new value for its parseOptions. - setSyntax(ConfigSyntax) - Method in class com.typesafe.config.ConfigParseOptions
-
Set the file format.
- setUseSystemEnvironment(boolean) - Method in class com.typesafe.config.ConfigResolveOptions
-
Returns options with use of environment variables set to the given value.
- splitPath(String) - Static method in class com.typesafe.config.ConfigUtil
-
Converts a path expression into a list of keys, by splitting on period and unquoting the individual path elements.
- splitPath(String) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- STRING - Enum constant in enum com.typesafe.config.ConfigValueType
- systemEnvironment() - Static method in class com.typesafe.config.ConfigFactory
-
Gets a
Config
containing the system's environment variables. - systemProperties() - Static method in class com.typesafe.config.ConfigFactory
-
Gets a
Config
containing the system properties fromSystem.getProperties()
, parsed and converted as withConfigFactory.parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions)
. - systemPropertiesAsConfig() - Static method in class com.typesafe.config.impl.ConfigImpl
T
- toBytes() - Method in class com.typesafe.config.ConfigMemorySize
-
Gets the size in bytes.
- toConfig() - Method in interface com.typesafe.config.ConfigObject
-
Converts this object to a
Config
instance, enabling you to use path expressions to find values in the object. - toString() - Method in class com.typesafe.config.ConfigException.ValidationProblem
- toString() - Method in class com.typesafe.config.ConfigMemorySize
- toString() - Method in class com.typesafe.config.ConfigRenderOptions
- toString() - Method in class com.typesafe.config.impl.Parseable
- trace(int, String) - Static method in class com.typesafe.config.impl.ConfigImpl
- trace(String) - Static method in class com.typesafe.config.impl.ConfigImpl
- trace(String) - Static method in class com.typesafe.config.impl.Parseable
- traceLoadsEnabled() - Static method in class com.typesafe.config.impl.ConfigImpl
- traceSubstitutionsEnabled() - Static method in class com.typesafe.config.impl.ConfigImpl
U
- unicodeTrim(String) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- UnresolvedSubstitution(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.UnresolvedSubstitution
- UnresolvedSubstitution(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.UnresolvedSubstitution
- unwrapped() - Method in interface com.typesafe.config.ConfigList
-
Recursively unwraps the list, returning a list of plain Java values such as Integer or String or whatever is in the list.
- unwrapped() - Method in interface com.typesafe.config.ConfigObject
-
Recursively unwraps the object, returning a map from String to whatever plain Java values are unwrapped from the object's values.
- unwrapped() - Method in interface com.typesafe.config.ConfigValue
-
Returns the value as a plain Java boxed value, that is, a
String
,Number
,Boolean
,Map<String,Object>
,List<Object>
, ornull
, matching theConfigValue.valueType()
of thisConfigValue
. - url() - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a URL describing the origin.
V
- ValidationFailed(Iterable<ConfigException.ValidationProblem>) - Constructor for exception com.typesafe.config.ConfigException.ValidationFailed
- ValidationProblem(String, ConfigOrigin, String) - Constructor for class com.typesafe.config.ConfigException.ValidationProblem
- valueOf(String) - Static method in enum com.typesafe.config.ConfigSyntax
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.typesafe.config.ConfigValueType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.typesafe.config.ConfigSyntax
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.typesafe.config.ConfigValueType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- valueType() - Method in interface com.typesafe.config.ConfigValue
-
The
ConfigValueType
of the value; matches the JSON type schema.
W
- withComments(List<String>) - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a
ConfigOrigin
based on this one, but with the given comments. - withFallback(ConfigIncluder) - Method in interface com.typesafe.config.ConfigIncluder
-
Returns a new includer that falls back to the given includer.
- withFallback(ConfigMergeable) - Method in interface com.typesafe.config.Config
- withFallback(ConfigMergeable) - Method in interface com.typesafe.config.ConfigMergeable
-
Returns a new value computed by merging this value with another, with keys in this value "winning" over the other one.
- withFallback(ConfigMergeable) - Method in interface com.typesafe.config.ConfigObject
- withFallback(ConfigMergeable) - Method in interface com.typesafe.config.ConfigValue
- withLineNumber(int) - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a
ConfigOrigin
based on this one, but with the given line number. - withOnlyKey(String) - Method in interface com.typesafe.config.ConfigObject
-
Clone the object with only the given key (and its children) retained; all sibling keys are removed.
- withOnlyPath(String) - Method in interface com.typesafe.config.Config
-
Clone the config with only the given path (and its children) retained; all sibling paths are removed.
- withOrigin(ConfigOrigin) - Method in interface com.typesafe.config.ConfigList
- withOrigin(ConfigOrigin) - Method in interface com.typesafe.config.ConfigObject
- withOrigin(ConfigOrigin) - Method in interface com.typesafe.config.ConfigValue
-
Returns a
ConfigValue
based on this one, but with the given origin. - withoutKey(String) - Method in interface com.typesafe.config.ConfigObject
-
Clone the object with the given key removed.
- withoutPath(String) - Method in interface com.typesafe.config.Config
-
Clone the config with the given path removed.
- withoutPath(String) - Method in interface com.typesafe.config.parser.ConfigDocument
-
Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with all values at the desired path removed.
- withValue(String, ConfigValue) - Method in interface com.typesafe.config.Config
-
Returns a
Config
based on this one, but with the given path set to the given value. - withValue(String, ConfigValue) - Method in interface com.typesafe.config.ConfigObject
-
Returns a
ConfigObject
based on this one, but with the given key set to the given value. - withValue(String, ConfigValue) - Method in interface com.typesafe.config.parser.ConfigDocument
-
Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path.
- withValueText(String, String) - Method in interface com.typesafe.config.parser.ConfigDocument
-
Returns a new ConfigDocument that is a copy of the current ConfigDocument, but with the desired value set at the desired path.
- writeOrigin(ObjectOutputStream, ConfigOrigin) - Static method in class com.typesafe.config.impl.ConfigImplUtil
- WrongType(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.WrongType
- WrongType(ConfigOrigin, String, String, String) - Constructor for exception com.typesafe.config.ConfigException.WrongType
- WrongType(ConfigOrigin, String, String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.WrongType
- WrongType(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.WrongType
All Classes and Interfaces|All Packages|Serialized Form
Config.getDuration(String, TimeUnit)