- 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
-
An API for loading and using configuration files, see
the project site
for more information.
- com.typesafe.config.impl - package com.typesafe.config.impl
-
Internal implementation details that can change ABI at any time.
- com.typesafe.config.parser - package com.typesafe.config.parser
-
This package supplies a raw parser and syntax tree for individual HOCON and JSON
files.
- 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).
- 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
-
- 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, Throwable) - Constructor for exception com.typesafe.config.ConfigException
-
- ConfigException(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException
-
- ConfigException(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException
-
- ConfigException(String) - 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
-
- ConfigException.ValidationProblem - Class in com.typesafe.config
-
- 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 a
ConfigIncluder implementation, and is not intended for apps
to implement.
- ConfigIncluder - Interface in com.typesafe.config
-
- ConfigIncluderClasspath - Interface in com.typesafe.config
-
Implement this
in addition to ConfigIncluder if you want to
support inclusion of files with the
include classpath("resource")
syntax.
- ConfigIncluderFile - Interface in com.typesafe.config
-
Implement this
in addition to ConfigIncluder if you want to
support inclusion of files with the
include file("filename") syntax.
- ConfigIncluderURL - Interface in com.typesafe.config
-
Implement this
in addition to ConfigIncluder if you want to
support inclusion of files with the
include 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
-
- ConfigMemorySize - Class in com.typesafe.config
-
An immutable class representing an amount of memory.
- ConfigMergeable - Interface in com.typesafe.config
-
- 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
-
- ConfigParseOptions - Class in com.typesafe.config
-
A set of options related to parsing.
- ConfigRenderOptions - Class in com.typesafe.config
-
- ConfigResolveOptions - Class in com.typesafe.config
-
A set of options related to resolving substitutions.
- ConfigResolver - Interface in com.typesafe.config
-
- 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
-
- Generic(String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Generic
-
- Generic(String) - 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 - see
ConfigValue.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, returns
Thread.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, TimeUnit) - Method in interface com.typesafe.config.Config
-
Gets a value as a duration in a specified
TimeUnit.
- getDuration(String) - Method in interface com.typesafe.config.Config
-
Gets a value as a java.time.Duration.
- getDurationList(String, TimeUnit) - Method in interface com.typesafe.config.Config
-
- getDurationList(String) - Method in interface com.typesafe.config.Config
-
- 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
implements
java.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
-
- getMilliseconds(String) - Method in interface com.typesafe.config.Config
-
- getMillisecondsList(String) - Method in interface com.typesafe.config.Config
-
- getNanoseconds(String) - Method in interface com.typesafe.config.Config
-
- getNanosecondsList(String) - Method in interface com.typesafe.config.Config
-
- 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".
- getPeriod(String) - Method in interface com.typesafe.config.Config
-
Gets a value as a java.time.Period.
- getResolver() - Method in class com.typesafe.config.ConfigResolveOptions
-
Returns the resolver to use as a fallback if a substitution cannot be
otherwise resolved.
- 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".
- getTemporal(String) - Method in interface com.typesafe.config.Config
-
Gets a value as a java.time.temporal.TemporalAmount.
- 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.
- Parse(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.Parse
-
- Parse(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.Parse
-
- parse(ConfigParseOptions) - Method in interface com.typesafe.config.ConfigParseable
-
Parse whatever it is.
- parse(ConfigParseOptions) - Method in class com.typesafe.config.impl.Parseable
-
- parse() - Method in class com.typesafe.config.impl.Parseable
-
- 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, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a file into a Config instance.
- parseFile(File) - Static method in class com.typesafe.config.ConfigFactory
-
- parseFile(File, ConfigParseOptions) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a file into a ConfigDocument instance.
- parseFile(File) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
- parseFileAnySyntax(File, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a file with a flexible extension.
- parseFileAnySyntax(File) - Static method in class com.typesafe.config.ConfigFactory
-
- parseFileAnySyntax(File, ConfigParseOptions) - Static method in class com.typesafe.config.impl.ConfigImpl
-
- parseMap(Map<String, ? extends Object>, String) - Static method in class com.typesafe.config.ConfigFactory
-
Creates a Config based on a Map from paths to
plain Java values.
- parseMap(Map<String, ? extends Object>) - Static method in class com.typesafe.config.ConfigFactory
-
- parseOptions() - Method in interface com.typesafe.config.ConfigIncludeContext
-
- parseProperties(Properties, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
- parseProperties(Properties) - Static method in class com.typesafe.config.ConfigFactory
-
- parseReader(Reader, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a Reader into a Config instance.
- parseReader(Reader) - Static method in class com.typesafe.config.ConfigFactory
-
- parseReader(Reader, ConfigParseOptions) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
Parses a Reader into a ConfigDocument instance.
- parseReader(Reader) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
- 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(Class<?>, String) - Static method in class com.typesafe.config.ConfigFactory
-
- 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(ClassLoader, String) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResources(String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResources(String) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResourcesAnySyntax(Class<?>, String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses classpath resources with a flexible extension.
- parseResourcesAnySyntax(Class<?>, String) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResourcesAnySyntax(ClassLoader, String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses classpath resources with a flexible extension.
- parseResourcesAnySyntax(ClassLoader, String) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResourcesAnySyntax(String, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResourcesAnySyntax(String) - Static method in class com.typesafe.config.ConfigFactory
-
- parseResourcesAnySyntax(Class<?>, String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.ConfigImpl
-
- parseResourcesAnySyntax(String, ConfigParseOptions) - Static method in class com.typesafe.config.impl.ConfigImpl
-
- 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) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a string (which should be valid HOCON or JSON).
- parseString(String, ConfigParseOptions) - Static method in class com.typesafe.config.parser.ConfigDocumentFactory
-
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).
- parseURL(URL, ConfigParseOptions) - Static method in class com.typesafe.config.ConfigFactory
-
Parses a URL into a Config instance.
- parseURL(URL) - Static method in class com.typesafe.config.ConfigFactory
-
- 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
-
- problem() - Method in class com.typesafe.config.ConfigException.ValidationProblem
-
Returns a description of the problem.
- problems() - Method in exception com.typesafe.config.ConfigException.ValidationFailed
-
- withComments(List<String>) - Method in interface com.typesafe.config.ConfigOrigin
-
Returns a ConfigOrigin based on this one, but with the given
comments.
- withFallback(ConfigMergeable) - Method in interface com.typesafe.config.Config
-
- 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.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(ConfigResolver) - Method in interface com.typesafe.config.ConfigResolver
-
Returns a new resolver that falls back to the given resolver if this
one doesn't provide a substitution itself.
- 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, String, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.WrongType
-
- WrongType(ConfigOrigin, String, String, String) - Constructor for exception com.typesafe.config.ConfigException.WrongType
-
- WrongType(ConfigOrigin, String, Throwable) - Constructor for exception com.typesafe.config.ConfigException.WrongType
-
- WrongType(ConfigOrigin, String) - Constructor for exception com.typesafe.config.ConfigException.WrongType
-