public abstract class ConfigException
@@ -393,6 +393,9 @@ public + @@ -182,6 +182,15 @@ Contains static methods for creating
static voidinvalidateCaches()
+
++ Reloads any cached configs, picking up changes to system properties for + example.
static Configload()
@@ -758,7 +767,9 @@ public static load("application") in most cases. This configuration should be used by
libraries and frameworks unless an application provides a different one.
- This method may return a cached singleton.
+ This method may return a cached singleton so will not see changes to
+ system properties or config files. (Use invalidateCaches() to
+ force it to reload.)
If the system properties config.resource,
config.file, or config.url are set, then the
@@ -954,6 +965,35 @@ public static
+invalidateCaches
++public static void invalidateCaches()+
-
+
- Reloads any cached configs, picking up changes to system properties for
+ example. Because a
Configis immutable, anyone with a reference + to the old configs will still have the same outdated objects. However, + new calls toload()ordefaultOverrides()or +defaultReference()may return a new object. ++ This method is primarily intended for use in unit tests, for example, + that may want to update a system property then confirm that it's used + correctly. In many cases, use of this method may indicate there's a + better way to set up your code. +
+ Caches may be reloaded immediately or lazily; once you call this method, + the reload can occur at any time, even during the invalidation process. + So FIRST make the changes you'd like the caches to notice, then SECOND + call this method to invalidate caches. Don't expect that invalidating, + making changes, then calling
load(), will work. Make changes + before you invalidate. ++
-
+
+
empty
@@ -996,16 +1036,19 @@ public staticSystem.getProperties(), parsed and converted as with -parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions). This method can return a global immutable - singleton, so it's preferred over parsing system properties yourself. - +parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions). ++ This method can return a global immutable singleton, so it's preferred + over parsing system properties yourself.
load(java.lang.String)will include the system properties as overrides already, as willdefaultReference()anddefaultOverrides().Because this returns a singleton, it will not notice changes to system - properties made after the first time this method is called. + properties made after the first time this method is called. Use +
invalidateCaches()to force the singleton to reload if you + modify system properties.
-
diff --git a/latest/api/com/typesafe/config/ConfigIncludeContext.html b/latest/api/com/typesafe/config/ConfigIncludeContext.html
index e8e1177c..fb7c3561 100644
--- a/latest/api/com/typesafe/config/ConfigIncludeContext.html
+++ b/latest/api/com/typesafe/config/ConfigIncludeContext.html
@@ -2,12 +2,12 @@
-
+
- Returns:
- true if comments should be rendered
booleangetJson()
+
++ Returns whether the options enable JSON.
booleangetOriginComments()
@@ -185,11 +193,27 @@ Class ConfigRenderOptions
ConfigRenderOptionssetJson(boolean value)
+
++ Returns options with JSON toggled.
ConfigRenderOptionssetOriginComments(boolean value)
Returns options with origin comments toggled.
StringtoString()
+
++
| Methods inherited from class java.lang.Object | |
|---|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ConfigValue.origin() of that setting's value. For example these
comments might tell you which file a setting comes from.
-
+
setOriginComments() controls only these autogenerated
"origin of this setting" comments, to toggle regular comments use
@@ -341,6 +365,53 @@ public boolean getFormatted()
+ +
+setJson
++public ConfigRenderOptions setJson(boolean value)+
-
+
- Returns options with JSON toggled. JSON means that HOCON extensions
+ (omitting commas, quotes for example) won't be used. However, whether to
+ use comments is controlled by the separate
setComments(boolean)+ andsetOriginComments(boolean)options. So if you enable + comments you will get invalid JSON despite setting this to true. ++
-
+
- Parameters:
value- true to include non-JSON extensions in the render +- Returns:
- options with requested setting for JSON
+ +
+getJson
++public boolean getJson()+
-
+
- Returns whether the options enable JSON. This method is mostly used by
+ the config lib internally, not by applications.
+
+
-
+
+
- Returns:
- true if only JSON should be rendered
+ +
+toString
++public String toString()+
diff --git a/latest/api/com/typesafe/config/ConfigResolveOptions.html b/latest/api/com/typesafe/config/ConfigResolveOptions.html index 54114b47..104f4b06 100644 --- a/latest/api/com/typesafe/config/ConfigResolveOptions.html +++ b/latest/api/com/typesafe/config/ConfigResolveOptions.html @@ -2,12 +2,12 @@ - +
- java.lang.Exception
- java.lang.RuntimeException
-
-
- com.typesafe.config.ConfigException
-
+
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
- com.typesafe.config.ConfigException.BadPath
- com.typesafe.config.ConfigException.BadValue
- com.typesafe.config.ConfigException.BugOrBroken
- com.typesafe.config.ConfigException.NotResolved
- com.typesafe.config.ConfigException.Generic
- com.typesafe.config.ConfigException.IO
- com.typesafe.config.ConfigException.Missing
-
diff --git a/latest/api/constant-values.html b/latest/api/constant-values.html
index 5210e024..4abe9dbc 100644
--- a/latest/api/constant-values.html
+++ b/latest/api/constant-values.html
@@ -2,12 +2,12 @@
-
+
- +
- 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 @@ -482,6 +485,10 @@ Method in interface com.typesafe.config.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.
- isEmpty() - Method in interface com.typesafe.config.Config
- Returns true if the
Config's root object contains no key-value @@ -774,6 +781,9 @@ Method in class com.typesafe.config.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.
@@ -807,6 +817,9 @@ Static method in class com.typesafe.config.ConfigObject
- Converts this object to a
Configinstance, enabling you to use path expressions to find values in the object. + - Converts this object to a
- toString() - +Method in class com.typesafe.config.ConfigRenderOptions +
-
diff --git a/latest/api/index.html b/latest/api/index.html index 88c4112a..0e4ab501 100644 --- a/latest/api/index.html +++ b/latest/api/index.html @@ -2,7 +2,7 @@ - +
Generated Documentation (Untitled) diff --git a/latest/api/overview-tree.html b/latest/api/overview-tree.html index 487a03e2..3dffb071 100644 --- a/latest/api/overview-tree.html +++ b/latest/api/overview-tree.html @@ -2,12 +2,12 @@ - +Class Hierarchy - + @@ -93,7 +93,8 @@ Class Hierarchy- java.lang.Exception
- java.lang.RuntimeException
-
-
- com.typesafe.config.ConfigException
-
+
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
- com.typesafe.config.ConfigException.BadPath
- com.typesafe.config.ConfigException.BadValue
- com.typesafe.config.ConfigException.BugOrBroken
- com.typesafe.config.ConfigException.NotResolved
- com.typesafe.config.ConfigException.Generic
- com.typesafe.config.ConfigException.IO
- com.typesafe.config.ConfigException.Missing
-
diff --git a/latest/api/serialized-form.html b/latest/api/serialized-form.html
index e7c32dde..d8461acb 100644
--- a/latest/api/serialized-form.html
+++ b/latest/api/serialized-form.html
@@ -2,12 +2,12 @@
-
+
Serialized Form - + @@ -103,20 +103,40 @@ Serialized Form serialVersionUID: 1L
--Serialized Fields +Serialization Methods-origin
++readObject
-ConfigOrigin origin
+private void readObject(ObjectInputStream in) + throws IOException, + ClassNotFoundException-
+
-
+
+
- Throws: +
IOException+ClassNotFoundException
++writeObject
++private void writeObject(ObjectOutputStream out) + throws IOException
-
+
-
+
+
- Throws: +
IOException
+All Classes + + + + + + + + + + + +All Classes +
+ ++All Classes + + + + + + + + + + + +All Classes +
+ ++Config + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface Config-
+
- All Superinterfaces:
- ConfigMergeable +
+-
+
public interface Config
- extends ConfigMergeable
+An immutable map from config paths to config values. + +
+ Contrast with
ConfigObjectwhich is a map from config keys, + rather than paths, to config values. AConfigcontains a tree of +ConfigObject, androot()returns the tree's root + object. + ++ Throughout the API, there is a distinction between "keys" and "paths". A key + is a key in a JSON object; it's just a string that's the key in a map. A + "path" is a parseable expression with a syntax and it refers to a series of + keys. Path expressions are described in the spec for + Human-Optimized Config Object Notation. In brief, a path is + period-separated so "a.b.c" looks for key c in object b in object a in the + root object. Sometimes double quotes are needed around special characters in + path expressions. + +
+ The API for a
Configis in terms of path expressions, while the API + for aConfigObjectis in terms of keys. Conceptually,Config+ is a one-level map from paths to values, while a +ConfigObjectis a tree of nested maps from keys to values. + ++ Use
ConfigUtil.joinPath(java.lang.String...)andConfigUtil.splitPath(java.lang.String)to convert + between path expressions and individual path elements (keys). + ++ Another difference between
ConfigandConfigObjectis that + conceptually,ConfigValues with avalueType()ofNULLexist in a +ConfigObject, while aConfigtreats null values as if they + were missing. + ++
Configis an immutable object and thus safe to use from multiple + threads. There's never a need for "defensive copies." + ++ The "getters" on a
Configall work in the same way. They never return + null, nor do they return aConfigValuewith +valueType()ofNULL. Instead, they throwConfigException.Missingif the value is + completely absent or set to null. If the value is set to null, a subtype of +ConfigException.MissingcalledConfigException.Nullwill be + thrown.ConfigException.WrongTypewill be thrown anytime you ask for + a type and the value has an incompatible type. Reasonable type conversions + are performed for you though. + ++ If you want to iterate over the contents of a
Config, you can get its +ConfigObjectwithroot(), and then iterate over the +ConfigObject(which implementsjava.util.Map). Or, you + can useentrySet()which recurses the object tree for you and builds + up aSetof all path-value pairs where the value is not null. + ++ Do not implement
Config; it should only be implemented by + the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigatKey(String key)+ +
+ Places the config inside aConfigat the given key.+ ++ +ConfigatPath(String path)+ +
+ Places the config inside anotherConfigat the given path.+ ++ +voidcheckValid(Config reference, + String... restrictToPaths)+ +
+ Validates this config against a reference config, throwing an exception + if it is invalid.+ ++ +Set<Map.Entry<String,ConfigValue>>entrySet()+ +
+ Returns the set of path-value pairs, excluding any null values, found by + recursingthe root object.+ ++ +ObjectgetAnyRef(String path)+ +
+ Gets the value at the path as an unwrapped Java boxed value ( +Boolean,Integer, and + so on - seeConfigValue.unwrapped()).+ ++ +List<? extends Object>getAnyRefList(String path)+ +
++ ++ +booleangetBoolean(String path)+ +
++ ++ +List<Boolean>getBooleanList(String path)+ +
++ ++ +LonggetBytes(String path)+ +
+ Gets a value as a size in bytes (parses special strings like "128M").+ ++ +List<Long>getBytesList(String path)+ +
++ ++ +ConfiggetConfig(String path)+ +
++ ++ +List<? extends Config>getConfigList(String path)+ +
++ ++ +doublegetDouble(String path)+ +
++ ++ +List<Double>getDoubleList(String path)+ +
++ ++ +intgetInt(String path)+ +
++ ++ +List<Integer>getIntList(String path)+ +
++ ++ +ConfigListgetList(String path)+ +
+ Gets a list value (with any element type) as aConfigList, which + implementsjava.util.List<ConfigValue>.+ ++ +longgetLong(String path)+ +
++ ++ +List<Long>getLongList(String path)+ +
++ ++ +LonggetMilliseconds(String path)+ +
+ Get value as a duration in milliseconds.+ ++ +List<Long>getMillisecondsList(String path)+ +
++ ++ +LonggetNanoseconds(String path)+ +
+ Get value as a duration in nanoseconds.+ ++ +List<Long>getNanosecondsList(String path)+ +
++ ++ +NumbergetNumber(String path)+ +
++ ++ +List<Number>getNumberList(String path)+ +
++ ++ +ConfigObjectgetObject(String path)+ +
++ ++ +List<? extends ConfigObject>getObjectList(String path)+ +
++ ++ +StringgetString(String path)+ +
++ ++ +List<String>getStringList(String path)+ +
++ ++ +ConfigValuegetValue(String path)+ +
+ 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.+ ++ +booleanhasPath(String path)+ +
+ Checks whether a value is present and non-null at the given path.+ ++ +booleanisEmpty()+ +
+ Returns true if theConfig's root object contains no key-value + pairs.+ ++ +ConfigOriginorigin()+ +
+ Gets the origin of theConfig, which may be a file, or a file + with a line number, or just a descriptive phrase.+ ++ +Configresolve()+ +
+ Returns a replacement config with all substitutions (the +${foo.bar}syntax, see the + spec) resolved.+ ++ +Configresolve(ConfigResolveOptions options)+ +
+ Likeresolve()but allows you to specify non-default + options.+ ++ +ConfigObjectroot()+ +
+ Gets theConfigas a tree ofConfigObject.+ ++ +ConfigwithFallback(ConfigMergeable other)+ +
+ Returns a new value computed by merging this value with another, with + keys in this value "winning" over the other one.+ ++ +ConfigwithOnlyPath(String path)+ +
+ Clone the config with only the given path (and its children) retained; + all sibling paths are removed.+ ++ +ConfigwithoutPath(String path)+ +
+ Clone the config with the given path removed.+ ++ +ConfigwithValue(String path, + ConfigValue value)+ +
+ Returns aConfigbased on this one, but with the given path set + to the given value.+
+ ++ ++Method Detail ++root
++ConfigObject root()
+-
+
- Gets the
Configas a tree ofConfigObject. This is a + constant-time operation (it is not proportional to the number of values + in theConfig). ++
-
+
-
+
+
- Returns:
- the root object in the configuration
+ ++origin
++ConfigOrigin origin()
+-
+
- Gets the origin of the
Config, which may be a file, or a file + with a line number, or just a descriptive phrase. ++
-
+
-
+
+
- Returns:
- the origin of the
Configfor use in error messages
+ ++withFallback
++Config withFallback(ConfigMergeable other)
+-
+
- Description copied from interface:
ConfigMergeable
+ - Returns a new value computed by merging this value with another, with
+ keys in this value "winning" over the other one. Only
+
ConfigObjectandConfiginstances do anything in this + method (they need to merge the fallback keys into themselves). All other + values just return the original value, since they automatically override + any fallback. + ++ The semantics of merging are described in the spec + for HOCON. + +
+ Note that objects do not merge "across" non-objects; if you write +
object.withFallback(nonObject).withFallback(otherObject), + thenotherObjectwill simply be ignored. This is an + intentional part of how merging works. Both non-objects, and any object + which has fallen back to a non-object, block subsequent fallbacks. ++
-
+
- Specified by:
withFallbackin interfaceConfigMergeable
-
+
- Parameters:
other- an object whose keys should be used if the keys are not + present in this one +- Returns:
- a new object (or the original one, if the fallback doesn't get + used)
+ ++resolve
++Config resolve()
+-
+
- Returns a replacement config with all substitutions (the
+
${foo.bar}syntax, see the + spec) resolved. Substitutions are looked up using this +Configas the root object, that is, a substitution +${foo.bar}will be replaced with the result of +getValue("foo.bar"). + ++ This method uses
ConfigResolveOptions.defaults(), there is + another variantresolve(ConfigResolveOptions)which lets + you specify non-default options. + ++ A given
Configmust be resolved before using it to retrieve + config values, but ideally should be resolved one time for your entire + stack of fallbacks (seewithFallback(com.typesafe.config.ConfigMergeable)). Otherwise, some + substitutions that could have resolved with all fallbacks available may + not resolve, which will be a user-visible oddity. + ++
resolve()should be invoked on root config objects, rather + than on a subtree (a subtree is the result of something like +config.getConfig("foo")). The problem with +resolve()on a subtree is that substitutions are relative to + the root of the config and the subtree will have no way to get values + from the root. For example, if you did +config.getConfig("foo").resolve()on the below config file, + it would not work: + ++ common-value = 10 + foo { + whatever = ${common-value} + } +++
-
+
-
+
+
- Returns:
- an immutable object with substitutions resolved +
- Throws: +
ConfigException.UnresolvedSubstitution- if any substitutions refer to nonexistent paths +ConfigException- some other config exception if there are other problems
+ ++resolve
++Config resolve(ConfigResolveOptions options)
+-
+
- Like
resolve()but allows you to specify non-default + options. ++
-
+
-
+
- Parameters:
options- resolve options +- Returns:
- the resolved
Config
+ ++checkValid
++void checkValid(Config reference, + String... restrictToPaths)
+-
+
- Validates this config against a reference config, throwing an exception
+ if it is invalid. The purpose of this method is to "fail early" with a
+ comprehensive list of problems; in general, anything this method can find
+ would be detected later when trying to use the config, but it's often
+ more user-friendly to fail right away when loading the config.
+
+
+ Using this method is always optional, since you can "fail late" instead. + +
+ You must restrict validation to paths you "own" (those whose meaning are + defined by your code module). If you validate globally, you may trigger + errors about paths that happen to be in the config but have nothing to do + with your module. It's best to allow the modules owning those paths to + validate them. Also, if every module validates only its own stuff, there + isn't as much redundant work being done. + +
+ If no paths are specified in
checkValid()'s parameter list, + validation is for the entire config. + ++ If you specify paths that are not in the reference config, those paths + are ignored. (There's nothing to validate.) + +
+ Here's what validation involves: + +
-
+
- All paths found in the reference config must be present in this + config or an exception will be thrown. +
-
+ Some changes in type from the reference config to this config will cause
+ an exception to be thrown. Not all potential type problems are detected,
+ in particular it's assumed that strings are compatible with everything
+ except objects and lists. This is because string types are often "really"
+ some other type (system properties always start out as strings, or a
+ string like "5ms" could be used with
getMilliseconds(java.lang.String)). Also, + it's allowed to set any type to null or override null with any type. + - + Any unresolved substitutions in this config will cause a validation + failure; both the reference config and this config should be resolved + before validation. If the reference config is unresolved, it's a bug in + the caller of this method. +
+ If you want to allow a certain setting to have a flexible type (or + otherwise want validation to be looser for some settings), you could + either remove the problematic setting from the reference config provided + to this method, or you could intercept the validation exception and + screen out certain problems. Of course, this will only work if all other + callers of this method are careful to restrict validation to their own + paths, as they should be. + +
+ If validation fails, the thrown exception contains a list of all problems + found. See
ConfigException.ValidationFailed.problems. The + exception'sgetMessage()will have all the problems + concatenated into one huge string, as well. + ++ Again,
checkValid()can't guess every domain-specific way a + setting can be invalid, so some problems may arise later when attempting + to use the config.checkValid()is limited to reporting + generic, but common, problems such as missing settings and blatant type + incompatibilities. ++
-
+
-
+
- Parameters:
reference- a reference configurationrestrictToPaths- only validate values underneath these paths that your code + module owns and understands +- Throws: +
ConfigException.ValidationFailed- if there are any validation issues +ConfigException.NotResolved- if this config is not resolved +ConfigException.BugOrBroken- if the reference config is unresolved or caller otherwise + misuses the API
+ ++hasPath
++boolean hasPath(String path)
+-
+
- Checks whether a value is present and non-null at the given path. This
+ differs in two ways from
Map.containsKey()as implemented by +ConfigObject: it looks for a path expression, not a key; and it + returns false for null values, whilecontainsKey()returns true + indicating that the object contains a null value for the key. + ++ If a path exists according to
hasPath(String), then +getValue(String)will never throw an exception. However, the + typed getters, such asgetInt(String), will still throw if the + value is not convertible to the requested type. ++
-
+
-
+
- Parameters:
path- the path expression +- Returns:
- true if a non-null value is present at the path +
- Throws: +
ConfigException.BadPath- if the path expression is invalid
+ ++isEmpty
++boolean isEmpty()
+-
+
- Returns true if the
Config's root object contains no key-value + pairs. ++
-
+
-
+
+
- Returns:
- true if the configuration is empty
+ ++entrySet
++Set<Map.Entry<String,ConfigValue>> entrySet()
+-
+
- Returns the set of path-value pairs, excluding any null values, found by
+ recursing
the root object. Note that this is very + different fromroot().entrySet()which returns the set of + immediate-child keys in the root object and includes null values. ++
-
+
-
+
+
- Returns:
- set of paths with non-null values, built up by recursing the
+ entire tree of
ConfigObject
+ ++getBoolean
++boolean getBoolean(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the boolean value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to boolean
+
+ ++getNumber
++Number getNumber(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the numeric value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to a number
+
+ ++getInt
++int getInt(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the 32-bit integer value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to an int (for example it is out + of range, or it's a boolean value)
+
+ ++getLong
++long getLong(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the 64-bit long value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to a long
+
+ ++getDouble
++double getDouble(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the floating-point value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to a double
+
+ ++getString
++String getString(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the string value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to a string
+
+ ++getObject
++ConfigObject getObject(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the
ConfigObjectvalue at the requested path + - Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to an object
+
+ ++getConfig
++Config getConfig(String path)
+-
+
-
+
+-
+
- Parameters:
path- path expression +- Returns:
- the nested
Configvalue at the requested path + - Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to a Config
+
+ ++getAnyRef
++Object getAnyRef(String path)
+-
+
- Gets the value at the path as an unwrapped Java boxed value (
+
Boolean,Integer, and + so on - seeConfigValue.unwrapped()). ++
-
+
-
+
- Parameters:
path- path expression +- Returns:
- the unwrapped value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null
+ ++getValue
++ConfigValue getValue(String path)
+-
+
- 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. Use
get()on theroot()object (or other object in the tree) if you + want an unprocessed value. ++
-
+
-
+
- Parameters:
path- path expression +- Returns:
- the value at the requested path +
- Throws: +
ConfigException.Missing- if value is absent or null
+ ++getBytes
++Long getBytes(String path)
+-
+
- Gets a value as a size in bytes (parses special strings like "128M"). If
+ the value is already a number, then it's left alone; if it's a string,
+ it's parsed understanding unit suffixes such as "128K", as documented in
+ the the
+ spec.
+
+
-
+
-
+
- Parameters:
path- path expression +- Returns:
- the value at the requested path, in bytes +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to Long or String +ConfigException.BadValue- if value cannot be parsed as a size in bytes
+ ++getMilliseconds
++Long getMilliseconds(String path)
+-
+
- Get value as a duration in milliseconds. If the value is already a
+ number, then it's left alone; if it's a string, it's parsed understanding
+ units suffixes like "10m" or "5ns" as documented in the the
+ spec.
+
+
-
+
-
+
- Parameters:
path- path expression +- Returns:
- the duration value at the requested path, in milliseconds +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to Long or String +ConfigException.BadValue- if value cannot be parsed as a number of milliseconds
+ ++getNanoseconds
++Long getNanoseconds(String path)
+-
+
- Get value as a duration in nanoseconds. If the value is already a number
+ it's taken as milliseconds and converted to nanoseconds. If it's a
+ string, it's parsed understanding unit suffixes, as for
+
getMilliseconds(String). ++
-
+
-
+
- Parameters:
path- path expression +- Returns:
- the duration value at the requested path, in nanoseconds +
- Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to Long or String +ConfigException.BadValue- if value cannot be parsed as a number of nanoseconds
+ ++getList
++ConfigList getList(String path)
+-
+
- Gets a list value (with any element type) as a
ConfigList, which + implementsjava.util.List<ConfigValue>. Throws if the path is + unset or null. ++
-
+
-
+
- Parameters:
path- the path to the list value. +- Returns:
- the
ConfigListat the path + - Throws: +
ConfigException.Missing- if value is absent or null +ConfigException.WrongType- if value is not convertible to a ConfigList
+ ++getBooleanList
++List<Boolean> getBooleanList(String path)
+-
+
-
+
+-
+
+
+ ++getNumberList
++List<Number> getNumberList(String path)
+-
+
-
+
+-
+
+
+ ++getIntList
++List<Integer> getIntList(String path)
+-
+
-
+
+-
+
+
+ ++getLongList
++List<Long> getLongList(String path)
+-
+
-
+
+-
+
+
+ ++getDoubleList
++List<Double> getDoubleList(String path)
+-
+
-
+
+-
+
+
+ ++getStringList
++List<String> getStringList(String path)
+-
+
-
+
+-
+
+
+ ++getObjectList
++List<? extends ConfigObject> getObjectList(String path)
+-
+
-
+
+-
+
+
+ ++getConfigList
++List<? extends Config> getConfigList(String path)
+-
+
-
+
+-
+
+
+ ++getAnyRefList
++List<? extends Object> getAnyRefList(String path)
+-
+
-
+
+-
+
+
+ ++getBytesList
++List<Long> getBytesList(String path)
+-
+
-
+
+-
+
+
+ ++getMillisecondsList
++List<Long> getMillisecondsList(String path)
+-
+
-
+
+-
+
+
+ ++getNanosecondsList
++List<Long> getNanosecondsList(String path)
+-
+
-
+
+-
+
+
+ ++withOnlyPath
++Config withOnlyPath(String path)
+-
+
- Clone the config with only the given path (and its children) retained;
+ all sibling paths are removed.
+
+
-
+
-
+
- Parameters:
path- path to keep +- Returns:
- a copy of the config minus all paths except the one specified
+ ++withoutPath
++Config withoutPath(String path)
+-
+
- Clone the config with the given path removed.
+
+
-
+
-
+
- Parameters:
path- path to remove +- Returns:
- a copy of the config minus the specified path
+ ++atPath
++Config atPath(String path)
+-
+
- Places the config inside another
Configat the given path. ++
-
+
-
+
- Parameters:
path- path to store this config at. +- Returns:
- a
Configinstance containing this config at the given + path.
+ ++atKey
++Config atKey(String key)
+-
+
- Places the config inside a
Configat the given key. See also + atPath(). ++
-
+
-
+
- Parameters:
key- key to store this config at. +- Returns:
- a
Configinstance containing this config at the given + key.
+ ++withValue
++Config withValue(String path, + ConfigValue value)
+-
+
- Returns a
Configbased on this one, but with the given path set + to the given value. Does not modify this instance (since it's immutable). + If the path already has a value, that value is replaced. To remove a + value, use withoutPath(). ++
-
+
-
+
- Parameters:
path- path to addvalue- value at the new path +- Returns:
- the new instance with the new map entry
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.BadPath.html b/v0.6.0/com/typesafe/config/ConfigException.BadPath.html new file mode 100644 index 00000000..4c7772b4 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.BadPath.html @@ -0,0 +1,348 @@ + + + + + ++ConfigException.BadPath + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.BadPath+java.lang.Object +
+
java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.BadPath
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.BadPath
- extends ConfigException
+Exception indicating that a path expression was invalid. Try putting + double quotes around path elements that contain "special" characters. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.BadPath(ConfigOrigin origin, + String message)+ +
++ +ConfigException.BadPath(ConfigOrigin origin, + String path, + String message)+ +
++ +ConfigException.BadPath(ConfigOrigin origin, + String path, + String message, + Throwable cause)+ +
++ +ConfigException.BadPath(String path, + String message)+ +
++ +ConfigException.BadPath(String path, + String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.BadPath
++public ConfigException.BadPath(ConfigOrigin origin, + String path, + String message, + Throwable cause)
+-
+
+ ++ConfigException.BadPath
++public ConfigException.BadPath(ConfigOrigin origin, + String path, + String message)
+-
+
+ ++ConfigException.BadPath
++public ConfigException.BadPath(String path, + String message, + Throwable cause)
+-
+
+ ++ConfigException.BadPath
++public ConfigException.BadPath(String path, + String message)
+-
+
+ ++ConfigException.BadPath
++public ConfigException.BadPath(ConfigOrigin origin, + String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.BadValue.html b/v0.6.0/com/typesafe/config/ConfigException.BadValue.html new file mode 100644 index 00000000..2623c026 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.BadValue.html @@ -0,0 +1,333 @@ + + + + + ++ConfigException.BadValue + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.BadValue+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.BadValue
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.BadValue
- extends ConfigException
+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. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.BadValue(ConfigOrigin origin, + String path, + String message)+ +
++ +ConfigException.BadValue(ConfigOrigin origin, + String path, + String message, + Throwable cause)+ +
++ +ConfigException.BadValue(String path, + String message)+ +
++ +ConfigException.BadValue(String path, + String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.BadValue
++public ConfigException.BadValue(ConfigOrigin origin, + String path, + String message, + Throwable cause)
+-
+
+ ++ConfigException.BadValue
++public ConfigException.BadValue(ConfigOrigin origin, + String path, + String message)
+-
+
+ ++ConfigException.BadValue
++public ConfigException.BadValue(String path, + String message, + Throwable cause)
+-
+
+ ++ConfigException.BadValue
++public ConfigException.BadValue(String path, + String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.BugOrBroken.html b/v0.6.0/com/typesafe/config/ConfigException.BugOrBroken.html new file mode 100644 index 00000000..9fdf9ed5 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.BugOrBroken.html @@ -0,0 +1,296 @@ + + + + + ++ConfigException.BugOrBroken + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.BugOrBroken+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.BugOrBroken
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Direct Known Subclasses:
- ConfigException.NotResolved +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.BugOrBroken
- extends ConfigException
+Exception indicating that there's a bug in something (possibly the + library itself) or the runtime environment is broken. This exception + should never be handled; instead, something should be fixed to keep the + exception from occurring. This exception can be thrown by any method in + the library. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.BugOrBroken(String message)+ +
++ +ConfigException.BugOrBroken(String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.BugOrBroken
++public ConfigException.BugOrBroken(String message, + Throwable cause)
+-
+
+ ++ConfigException.BugOrBroken
++public ConfigException.BugOrBroken(String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.Generic.html b/v0.6.0/com/typesafe/config/ConfigException.Generic.html new file mode 100644 index 00000000..1f01822a --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.Generic.html @@ -0,0 +1,289 @@ + + + + + ++ConfigException.Generic + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.Generic+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.Generic
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.Generic
- extends ConfigException
+Exception that doesn't fall into any other category. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.Generic(String message)+ +
++ +ConfigException.Generic(String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.Generic
++public ConfigException.Generic(String message, + Throwable cause)
+-
+
+ ++ConfigException.Generic
++public ConfigException.Generic(String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.IO.html b/v0.6.0/com/typesafe/config/ConfigException.IO.html new file mode 100644 index 00000000..b25bb9ad --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.IO.html @@ -0,0 +1,293 @@ + + + + + ++ConfigException.IO + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.IO+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.IO
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.IO
- extends ConfigException
+Exception indicating that there was an IO error. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.IO(ConfigOrigin origin, + String message)+ +
++ +ConfigException.IO(ConfigOrigin origin, + String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.IO
++public ConfigException.IO(ConfigOrigin origin, + String message, + Throwable cause)
+-
+
+ ++ConfigException.IO
++public ConfigException.IO(ConfigOrigin origin, + String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.Missing.html b/v0.6.0/com/typesafe/config/ConfigException.Missing.html new file mode 100644 index 00000000..ea6d8cfa --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.Missing.html @@ -0,0 +1,335 @@ + + + + + ++ConfigException.Missing + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.Missing+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.Missing
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Direct Known Subclasses:
- ConfigException.Null +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.Missing
- extends ConfigException
+Exception indicates that the setting was never set to anything, not even + null. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ ++ +protectedConfigException.Missing(ConfigOrigin origin, + String message)+ +
++ ++ +protectedConfigException.Missing(ConfigOrigin origin, + String message, + Throwable cause)+ +
++ ++ +ConfigException.Missing(String path)+ +
++ ++ +ConfigException.Missing(String path, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.Missing
++public ConfigException.Missing(String path, + Throwable cause)
+-
+
+ ++ConfigException.Missing
++public ConfigException.Missing(String path)
+-
+
+ ++ConfigException.Missing
++protected ConfigException.Missing(ConfigOrigin origin, + String message, + Throwable cause)
+-
+
+ ++ConfigException.Missing
++protected ConfigException.Missing(ConfigOrigin origin, + String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.NotResolved.html b/v0.6.0/com/typesafe/config/ConfigException.NotResolved.html new file mode 100644 index 00000000..eb99c9d0 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.NotResolved.html @@ -0,0 +1,295 @@ + + + + + ++ConfigException.NotResolved + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.NotResolved+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.BugOrBroken
+ com.typesafe.config.ConfigException.NotResolved
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.NotResolved
- extends ConfigException.BugOrBroken
+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). This is always a bug in + either application code or the library; it's wrong to write a handler for + this exception because you should be able to fix the code to avoid it by + adding calls toConfig.resolve(). ++ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.NotResolved(String message)+ +
++ +ConfigException.NotResolved(String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.NotResolved
++public ConfigException.NotResolved(String message, + Throwable cause)
+-
+
+ ++ConfigException.NotResolved
++public ConfigException.NotResolved(String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.Null.html b/v0.6.0/com/typesafe/config/ConfigException.Null.html new file mode 100644 index 00000000..11134239 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.Null.html @@ -0,0 +1,299 @@ + + + + + ++ConfigException.Null + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.Null+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.Missing
+ com.typesafe.config.ConfigException.Null
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.Null
- extends ConfigException.Missing
+Exception indicates that the setting was treated as missing because it + was set to null. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.Null(ConfigOrigin origin, + String path, + String expected)+ +
++ +ConfigException.Null(ConfigOrigin origin, + String path, + String expected, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.Null
++public ConfigException.Null(ConfigOrigin origin, + String path, + String expected, + Throwable cause)
+-
+
+ ++ConfigException.Null
++public ConfigException.Null(ConfigOrigin origin, + String path, + String expected)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.Parse.html b/v0.6.0/com/typesafe/config/ConfigException.Parse.html new file mode 100644 index 00000000..8ceb9ac9 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.Parse.html @@ -0,0 +1,296 @@ + + + + + ++ConfigException.Parse + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.Parse+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.Parse
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Direct Known Subclasses:
- ConfigException.UnresolvedSubstitution +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.Parse
- extends ConfigException
+Exception indicating that there was a parse error. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.Parse(ConfigOrigin origin, + String message)+ +
++ +ConfigException.Parse(ConfigOrigin origin, + String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.Parse
++public ConfigException.Parse(ConfigOrigin origin, + String message, + Throwable cause)
+-
+
+ ++ConfigException.Parse
++public ConfigException.Parse(ConfigOrigin origin, + String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.UnresolvedSubstitution.html b/v0.6.0/com/typesafe/config/ConfigException.UnresolvedSubstitution.html new file mode 100644 index 00000000..98a42493 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.UnresolvedSubstitution.html @@ -0,0 +1,295 @@ + + + + + ++ConfigException.UnresolvedSubstitution + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.UnresolvedSubstitution+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.Parse
+ com.typesafe.config.ConfigException.UnresolvedSubstitution
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.UnresolvedSubstitution
- extends ConfigException.Parse
+Exception indicating that a substitution did not resolve to anything. + Thrown by
Config.resolve(). ++ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.UnresolvedSubstitution(ConfigOrigin origin, + String detail)+ +
++ +ConfigException.UnresolvedSubstitution(ConfigOrigin origin, + String detail, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.UnresolvedSubstitution
++public ConfigException.UnresolvedSubstitution(ConfigOrigin origin, + String detail, + Throwable cause)
+-
+
+ ++ConfigException.UnresolvedSubstitution
++public ConfigException.UnresolvedSubstitution(ConfigOrigin origin, + String detail)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.ValidationFailed.html b/v0.6.0/com/typesafe/config/ConfigException.ValidationFailed.html new file mode 100644 index 00000000..d03429c4 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.ValidationFailed.html @@ -0,0 +1,304 @@ + + + + + ++ConfigException.ValidationFailed + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.ValidationFailed+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.ValidationFailed
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.ValidationFailed
- extends ConfigException
+Exception indicating that
Config.checkValid(com.typesafe.config.Config, java.lang.String...)found validity + problems. The problems are available via theproblems()method. + ThegetMessage()of this exception is a potentially very + long string listing all the problems found. ++ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.ValidationFailed(Iterable<ConfigException.ValidationProblem> problems)+ +
++
+ ++ ++Method Summary ++ ++ +Iterable<ConfigException.ValidationProblem>problems()+ +
++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.ValidationFailed
++public ConfigException.ValidationFailed(Iterable<ConfigException.ValidationProblem> problems)
+-
+
+
+ ++ ++Method Detail ++problems
++public Iterable<ConfigException.ValidationProblem> problems()
+-
+
-
+
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.ValidationProblem.html b/v0.6.0/com/typesafe/config/ConfigException.ValidationProblem.html new file mode 100644 index 00000000..a568f32d --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.ValidationProblem.html @@ -0,0 +1,307 @@ + + + + + ++ConfigException.ValidationProblem + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.ValidationProblem+java.lang.Object +
+com.typesafe.config.ConfigException.ValidationProblem
+-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.ValidationProblem
- extends Object
+Information about a problem that occurred in
Config.checkValid(com.typesafe.config.Config, java.lang.String...). A +ConfigException.ValidationFailedexception thrown from +checkValid()includes a list of problems encountered. ++ +
+
+ ++
+ + + + ++ ++Constructor Summary ++ +ConfigException.ValidationProblem(String path, + ConfigOrigin origin, + String problem)+ +
++
+ ++ ++Method Summary ++ ++ +ConfigOriginorigin()+ +
+ Returns where the problem occurred (origin may include info on the + file, line number, etc.).+ ++ +Stringpath()+ +
+ Returns the config setting causing the problem.+ ++ +Stringproblem()+ +
+ Returns a description of the problem.+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.ValidationProblem
++public ConfigException.ValidationProblem(String path, + ConfigOrigin origin, + String problem)
+-
+
+
+ ++ ++Method Detail ++path
++public String path()
+-
+
- Returns the config setting causing the problem.
+
+
-
+
+ ++origin
++public ConfigOrigin origin()
+-
+
- Returns where the problem occurred (origin may include info on the
+ file, line number, etc.).
+
+
-
+
+ ++problem
++public String problem()
+-
+
- Returns a description of the problem.
+
+
-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.WrongType.html b/v0.6.0/com/typesafe/config/ConfigException.WrongType.html new file mode 100644 index 00000000..db7b80d9 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.WrongType.html @@ -0,0 +1,336 @@ + + + + + ++ConfigException.WrongType + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException.WrongType+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+ com.typesafe.config.ConfigException.WrongType
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Enclosing class:
- ConfigException +
+-
+
public static class ConfigException.WrongType
- extends ConfigException
+Exception indicating that the type of a value does not match the type you + requested. +
+ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from class com.typesafe.config.ConfigException ++ +ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.NotResolved, ConfigException.Null, ConfigException.Parse, ConfigException.UnresolvedSubstitution, ConfigException.ValidationFailed, ConfigException.ValidationProblem, ConfigException.WrongType+
+ + + + ++ ++Constructor Summary ++ +ConfigException.WrongType(ConfigOrigin origin, + String message)+ +
++ +ConfigException.WrongType(ConfigOrigin origin, + String path, + String expected, + String actual)+ +
++ +ConfigException.WrongType(ConfigOrigin origin, + String path, + String expected, + String actual, + Throwable cause)+ +
++ +ConfigException.WrongType(ConfigOrigin origin, + String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++
+ ++ +Methods inherited from class com.typesafe.config.ConfigException ++ +origin+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException.WrongType
++public ConfigException.WrongType(ConfigOrigin origin, + String path, + String expected, + String actual, + Throwable cause)
+-
+
+ ++ConfigException.WrongType
++public ConfigException.WrongType(ConfigOrigin origin, + String path, + String expected, + String actual)
+-
+
+ ++ConfigException.WrongType
++public ConfigException.WrongType(ConfigOrigin origin, + String message, + Throwable cause)
+-
+
+ ++ConfigException.WrongType
++public ConfigException.WrongType(ConfigOrigin origin, + String message)
+-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigException.html b/v0.6.0/com/typesafe/config/ConfigException.html new file mode 100644 index 00000000..c25c8494 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigException.html @@ -0,0 +1,464 @@ + + + + + ++ConfigException + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigException+java.lang.Object +
+java.lang.Throwable
+ java.lang.Exception
+ java.lang.RuntimeException
+ com.typesafe.config.ConfigException
+-
+
- All Implemented Interfaces:
- Serializable +
-
+
- Direct Known Subclasses:
- ConfigException.BadPath, ConfigException.BadValue, ConfigException.BugOrBroken, ConfigException.Generic, ConfigException.IO, ConfigException.Missing, ConfigException.Parse, ConfigException.ValidationFailed, ConfigException.WrongType +
+-
+
public abstract class ConfigException
- extends RuntimeException
- implements Serializable
- extends RuntimeException
+All exceptions thrown by the library are subclasses of +
ConfigException. ++ +
+
-
+
- See Also:
- Serialized Form
+ ++
+ + + + ++ ++Nested Class Summary ++ ++ +static classConfigException.BadPath+ +
+ Exception indicating that a path expression was invalid.+ ++ +static classConfigException.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.+ ++ +static classConfigException.BugOrBroken+ +
+ Exception indicating that there's a bug in something (possibly the + library itself) or the runtime environment is broken.+ ++ +static classConfigException.Generic+ +
+ Exception that doesn't fall into any other category.+ ++ +static classConfigException.IO+ +
+ Exception indicating that there was an IO error.+ ++ +static classConfigException.Missing+ +
+ Exception indicates that the setting was never set to anything, not even + null.+ ++ +static classConfigException.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).+ ++ +static classConfigException.Null+ +
+ Exception indicates that the setting was treated as missing because it + was set to null.+ ++ +static classConfigException.Parse+ +
+ Exception indicating that there was a parse error.+ ++ +static classConfigException.UnresolvedSubstitution+ +
+ Exception indicating that a substitution did not resolve to anything.+ ++ +static classConfigException.ValidationFailed+ +
+ Exception indicating thatConfig.checkValid(com.typesafe.config.Config, java.lang.String...)found validity + problems.+ ++ +static classConfigException.ValidationProblem+ +
+ Information about a problem that occurred inConfig.checkValid(com.typesafe.config.Config, java.lang.String...).+ ++ +static classConfigException.WrongType+ +
+ Exception indicating that the type of a value does not match the type you + requested.+
+ + + + ++ ++Constructor Summary ++ ++ +protectedConfigException(ConfigOrigin origin, + String message)+ +
++ ++ +protectedConfigException(ConfigOrigin origin, + String message, + Throwable cause)+ +
++ ++ +protectedConfigException(String message)+ +
++ ++ +protectedConfigException(String message, + Throwable cause)+ +
++
+ ++ ++Method Summary ++ ++ +ConfigOriginorigin()+ +
+ Returns an "origin" (such as a filename and line number) for the + exception, or null if none is available.+
+ ++ +Methods inherited from class java.lang.Throwable ++ +fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Constructor Detail ++ConfigException
++protected ConfigException(ConfigOrigin origin, + String message, + Throwable cause)
+-
+
+ ++ConfigException
++protected ConfigException(ConfigOrigin origin, + String message)
+-
+
+ ++ConfigException
++protected ConfigException(String message, + Throwable cause)
+-
+
+ ++ConfigException
++protected ConfigException(String message)
+-
+
+
+ ++ ++Method Detail ++origin
++public ConfigOrigin origin()
+-
+
- Returns an "origin" (such as a filename and line number) for the
+ exception, or null if none is available. If there's no sensible origin
+ for a given exception, or the kind of exception doesn't meaningfully
+ relate to a particular origin file, this returns null. Never assume this
+ will return non-null, it can always return null.
+
+
-
+
-
+
+
- Returns:
- origin of the problem, or null if unknown/inapplicable
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigFactory.html b/v0.6.0/com/typesafe/config/ConfigFactory.html new file mode 100644 index 00000000..42a0904a --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigFactory.html @@ -0,0 +1,1598 @@ + + + + + ++ConfigFactory + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigFactory+java.lang.Object +
+com.typesafe.config.ConfigFactory
+
+-
+
public final class ConfigFactory
- extends Object
+Contains static methods for creating
Configinstances. + ++ See also
ConfigValueFactorywhich contains static methods for + converting Java values into aConfigObject. You can then convert a +ConfigObjectinto aConfigwithConfigObject.toConfig(). + ++ The static methods with "load" in the name do some sort of higher-level + operation potentially parsing multiple resources and resolving substitutions, + while the ones with "parse" in the name just create a
ConfigValue+ from a resource and nothing else. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +static ConfigdefaultOverrides()+ +
+ Obtains the default override configuration, which currently consists of + system properties.+ ++ +static ConfigdefaultOverrides(ClassLoader loader)+ +
+ LikedefaultOverrides()but allows you to specify a class loader + to use rather than the current context class loader.+ ++ +static ConfigdefaultReference()+ +
+ 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.+ ++ +static ConfigdefaultReference(ClassLoader loader)+ +
+ LikedefaultReference()but allows you to specify a class loader + to use rather than the current context class loader.+ ++ +static Configempty()+ +
+ Gets an empty configuration.+ ++ +static Configempty(String originDescription)+ +
+ Gets an empty configuration with a description to be used to create a +ConfigOriginfor thisConfig.+ ++ +static voidinvalidateCaches()+ +
+ Reloads any cached configs, picking up changes to system properties for + example.+ ++ +static Configload()+ +
+ Loads a default configuration, equivalent toload("application")in most cases.+ ++ +static Configload(ClassLoader loader)+ +
+ Likeload()but allows specifying a class loader other than the + thread's current context class loader.+ ++ +static Configload(ClassLoader loader, + Config config)+ +
++ ++ +static Configload(ClassLoader loader, + Config config, + ConfigResolveOptions resolveOptions)+ +
+ Likeload(Config,ConfigResolveOptions)but allows you to specify + a class loader other than the context class loader.+ ++ +static Configload(ClassLoader loader, + ConfigParseOptions parseOptions)+ +
+ Likeload()but allows specifying a class loader other than the + thread's current context class loader, and parse options+ ++ +static Configload(ClassLoader loader, + ConfigParseOptions parseOptions, + ConfigResolveOptions resolveOptions)+ +
+ Likeload()but allows specifying a class loader other than the + thread's current context class loader, parse options, and resolve options+ ++ +static Configload(ClassLoader loader, + ConfigResolveOptions resolveOptions)+ +
+ Likeload()but allows specifying a class loader other than the + thread's current context class loader, and resolve options+ ++ +static Configload(ClassLoader loader, + String resourceBasename)+ +
+ Likeload(String)but uses the supplied class loader instead of + the current thread's context class loader.+ ++ +static Configload(ClassLoader loader, + String resourceBasename, + ConfigParseOptions parseOptions, + ConfigResolveOptions resolveOptions)+ +
+ Likeload(String,ConfigParseOptions,ConfigResolveOptions)but + has a class loader parameter that overrides any from the +ConfigParseOptions.+ ++ +static Configload(Config config)+ +
+ Assembles a standard configuration using a customConfig+ object rather than loading "application.conf".+ ++ +static Configload(Config config, + ConfigResolveOptions resolveOptions)+ +
+ Likeload(Config)but allows you to specify +ConfigResolveOptions.+ ++ +static Configload(ConfigParseOptions parseOptions)+ +
+ Likeload()but allows specifying parse options+ ++ +static Configload(String resourceBasename)+ +
+ 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.+ ++ +static Configload(String resourceBasename, + ConfigParseOptions parseOptions, + ConfigResolveOptions resolveOptions)+ +
+ Likeload(String)but allows you to specify parse and resolve + options.+ ++ +static ConfigparseFile(File file)+ +
++ ++ +static ConfigparseFile(File file, + ConfigParseOptions options)+ +
++ ++ +static ConfigparseFileAnySyntax(File fileBasename)+ +
++ ++ +static ConfigparseFileAnySyntax(File fileBasename, + ConfigParseOptions options)+ +
+ Parses a file with a flexible extension.+ ++ +static ConfigparseMap(Map<String,? extends Object> values)+ +
+ See the other overload ofparseMap(Map, String)for details, + this one just uses a default origin description.+ ++ +static ConfigparseMap(Map<String,? extends Object> values, + String originDescription)+ +
+ Creates aConfigbased on aMapfrom paths to + plain Java values.+ ++ +static ConfigparseProperties(Properties properties)+ +
++ ++ +static ConfigparseProperties(Properties properties, + ConfigParseOptions options)+ +
+ Converts a JavaPropertiesobject to a +ConfigObjectusing the rules documented in the HOCON + spec.+ ++ +static ConfigparseReader(Reader reader)+ +
++ ++ +static ConfigparseReader(Reader reader, + ConfigParseOptions options)+ +
++ ++ +static ConfigparseResources(Class<?> klass, + String resource)+ +
++ ++ +static ConfigparseResources(Class<?> klass, + String resource, + ConfigParseOptions options)+ +
+ Parses all resources on the classpath with the given name and merges them + into a singleConfig.+ ++ +static ConfigparseResources(ClassLoader loader, + String resource)+ +
++ ++ +static ConfigparseResources(ClassLoader loader, + String resource, + ConfigParseOptions options)+ +
+ Parses all resources on the classpath with the given name and merges them + into a singleConfig.+ ++ +static ConfigparseResources(String resource)+ +
+ LikeparseResources(ClassLoader,String)but uses thread's + current context class loader.+ ++ +static ConfigparseResources(String resource, + ConfigParseOptions options)+ +
+ LikeparseResources(ClassLoader,String,ConfigParseOptions)but + uses thread's current context class loader.+ ++ +static ConfigparseResourcesAnySyntax(Class<?> klass, + String resourceBasename)+ +
++ ++ +static ConfigparseResourcesAnySyntax(Class<?> klass, + String resourceBasename, + ConfigParseOptions options)+ +
+ Parses classpath resources with a flexible extension.+ ++ +static ConfigparseResourcesAnySyntax(ClassLoader loader, + String resourceBasename)+ +
++ ++ +static ConfigparseResourcesAnySyntax(ClassLoader loader, + String resourceBasename, + ConfigParseOptions options)+ +
+ Parses classpath resources with a flexible extension.+ ++ +static ConfigparseResourcesAnySyntax(String resourceBasename)+ +
+ LikeparseResourcesAnySyntax(ClassLoader,String)but uses + thread's current context class loader.+ ++ +static ConfigparseResourcesAnySyntax(String resourceBasename, + ConfigParseOptions options)+ +
+ Like +parseResourcesAnySyntax(ClassLoader,String,ConfigParseOptions)+ but uses thread's current context class loader.+ ++ +static ConfigparseString(String s)+ +
++ ++ +static ConfigparseString(String s, + ConfigParseOptions options)+ +
++ ++ +static ConfigparseURL(URL url)+ +
++ ++ +static ConfigparseURL(URL url, + ConfigParseOptions options)+ +
++ ++ +static ConfigsystemEnvironment()+ +
+ Gets aConfigcontaining the system's environment variables.+ ++ +static ConfigsystemProperties()+ +
+ Gets aConfigcontaining the system properties from +System.getProperties(), parsed and converted as with +parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions).+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait+
+ ++ ++Method Detail ++load
++public static Config load(String resourceBasename)
+-
+
- 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. The classpath
+ resource is "raw" (it should have no "/" prefix, and is not made relative
+ to any package, so it's like
ClassLoader.getResource(java.lang.String)not +Class.getResource(java.lang.String)). + ++ Resources are loaded from the current thread's +
Thread.getContextClassLoader(). In general, a library needs its + configuration to come from the class loader used to load that library, so + the proper "reference.conf" are present. + ++ The loaded object will already be resolved (substitutions have already + been processed). As a result, if you add more fallbacks then they won't + be seen by substitutions. Substitutions are the "${foo.bar}" syntax. If + you want to parse additional files or something then you need to use +
load(Config). ++
-
+
- Parameters:
resourceBasename- name (optionally without extension) of a resource on classpath +- Returns:
- configuration for an application relative to context class loader
+ ++load
++public static Config load(ClassLoader loader, + String resourceBasename)
+-
+
- Like
load(String)but uses the supplied class loader instead of + the current thread's context class loader. ++
-
+
- Parameters:
loader-resourceBasename- +- Returns:
- configuration for an application relative to given class loader
+ ++load
++public static Config load(String resourceBasename, + ConfigParseOptions parseOptions, + ConfigResolveOptions resolveOptions)
+-
+
- Like
load(String)but allows you to specify parse and resolve + options. ++
-
+
- Parameters:
resourceBasename- the classpath resource name with optional extensionparseOptions- options to use when parsing the resourceresolveOptions- options to use when resolving the stack +- Returns:
- configuration for an application
+ ++load
++public static Config load(ClassLoader loader, + String resourceBasename, + ConfigParseOptions parseOptions, + ConfigResolveOptions resolveOptions)
+-
+
- Like
load(String,ConfigParseOptions,ConfigResolveOptions)but + has a class loader parameter that overrides any from the +ConfigParseOptions. ++
-
+
- Parameters:
loader- class loader in which to find resources (overrides loader in + parse options)resourceBasename- the classpath resource name with optional extensionparseOptions- options to use when parsing the resource (class loader + overridden)resolveOptions- options to use when resolving the stack +- Returns:
- configuration for an application
+ ++load
++public static Config load(Config config)
+-
+
- Assembles a standard configuration using a custom
Config+ object rather than loading "application.conf". TheConfig+ object will be sandwiched between the default reference config and + default overrides and then resolved. ++
-
+
- Parameters:
config- the application's portion of the configuration +- Returns:
- resolved configuration with overrides and fallbacks added
+ ++load
++public static Config load(ClassLoader loader, + Config config)
+-
+
-
+
+
+ ++load
++public static Config load(Config config, + ConfigResolveOptions resolveOptions)
+-
+
- Like
load(Config)but allows you to specify +ConfigResolveOptions. ++
-
+
- Parameters:
config- the application's portion of the configurationresolveOptions- options for resolving the assembled config stack +- Returns:
- resolved configuration with overrides and fallbacks added
+ ++load
++public static Config load(ClassLoader loader, + Config config, + ConfigResolveOptions resolveOptions)
+-
+
- Like
load(Config,ConfigResolveOptions)but allows you to specify + a class loader other than the context class loader. ++
-
+
- Parameters:
loader- class loader to use when looking up override and reference + configsconfig- the application's portion of the configurationresolveOptions- options for resolving the assembled config stack +- Returns:
- resolved configuration with overrides and fallbacks added
+ ++load
++public static Config load()
+-
+
- Loads a default configuration, equivalent to
load("application")in most cases. This configuration should be used by + libraries and frameworks unless an application provides a different one. ++ This method may return a cached singleton so will not see changes to + system properties or config files. (Use
invalidateCaches()to + force it to reload.) ++ If the system properties
config.resource, +config.file, orconfig.urlare set, then the + classpath resource, file, or URL specified in those properties will be + used rather than the default +application.{conf,json,properties}classpath resources. + These system properties should not be set in code (after all, you can + just parse whatever you want manually and then useload(Config)+ if you don't want to useapplication.conf). The properties + are intended for use by the person or script launching the application. + For example someone might have aproduction.confthat + includeapplication.confbut then change a couple of values. + When launching the app they could specify +-Dconfig.resource=production.confto get production mode. ++ If no system properties are set to change the location of the default + configuration,
ConfigFactory.load()is equivalent to +ConfigFactory.load("application"). ++
-
+
+
- Returns:
- configuration for an application
+ ++load
++public static Config load(ConfigParseOptions parseOptions)
+-
+
- Like
load()but allows specifying parse options ++
-
+
- Parameters:
parseOptions- Options for parsing resources +- Returns:
- configuration for an application
+ ++load
++public static Config load(ClassLoader loader)
+-
+
- Like
load()but allows specifying a class loader other than the + thread's current context class loader. ++
-
+
- Parameters:
loader- class loader for finding resources +- Returns:
- configuration for an application
+ ++load
++public static Config load(ClassLoader loader, + ConfigParseOptions parseOptions)
+-
+
- Like
load()but allows specifying a class loader other than the + thread's current context class loader, and parse options ++
-
+
- Parameters:
loader- class loader for finding resourcesparseOptions- Options for parsing resources +- Returns:
- configuration for an application
+ ++load
++public static Config load(ClassLoader loader, + ConfigResolveOptions resolveOptions)
+-
+
- Like
load()but allows specifying a class loader other than the + thread's current context class loader, and resolve options ++
-
+
- Parameters:
loader- class loader for finding resourcesresolveOptions- options for resolving the assembled config stack +- Returns:
- configuration for an application
+ ++load
++public static Config load(ClassLoader loader, + ConfigParseOptions parseOptions, + ConfigResolveOptions resolveOptions)
+-
+
- Like
load()but allows specifying a class loader other than the + thread's current context class loader, parse options, and resolve options ++
-
+
- Parameters:
loader- class loader for finding resourcesparseOptions- Options for parsing resourcesresolveOptions- options for resolving the assembled config stack +- Returns:
- configuration for an application
+ ++defaultReference
++public static Config defaultReference()
+-
+
- 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. The returned reference
+ configuration will already have substitutions resolved.
+
+
+ Libraries and frameworks should ship with a "reference.conf" in their + jar. + +
+ The reference config must be looked up in the class loader that contains + the libraries that you want to use with this config, so the + "reference.conf" for each library can be found. Use +
defaultReference(ClassLoader)if the context class loader is not + suitable. + ++ The
load()methods merge this configuration for you + automatically. + ++ Future versions may look for reference configuration in more places. It + is not guaranteed that this method only looks at + "reference.conf". +
+
-
+
+
- Returns:
- the default reference config for context class loader
+ ++defaultReference
++public static Config defaultReference(ClassLoader loader)
+-
+
- Like
defaultReference()but allows you to specify a class loader + to use rather than the current context class loader. ++
-
+
- Parameters:
loader- +- Returns:
- the default reference config for this class loader
+ ++defaultOverrides
++public static Config defaultOverrides()
+-
+
- Obtains the default override configuration, which currently consists of
+ system properties. The returned override configuration will already have
+ substitutions resolved.
+
+
+ The
load()methods merge this configuration for you + automatically. + ++ Future versions may get overrides in more places. It is not guaranteed + that this method only uses system properties. +
+
-
+
+
- Returns:
- the default override configuration
+ ++defaultOverrides
++public static Config defaultOverrides(ClassLoader loader)
+-
+
- Like
defaultOverrides()but allows you to specify a class loader + to use rather than the current context class loader. ++
-
+
- Parameters:
loader- +- Returns:
- the default override configuration
+ ++invalidateCaches
++public static void invalidateCaches()
+-
+
- Reloads any cached configs, picking up changes to system properties for
+ example. Because a
Configis immutable, anyone with a reference + to the old configs will still have the same outdated objects. However, + new calls toload()ordefaultOverrides()or +defaultReference()may return a new object. ++ This method is primarily intended for use in unit tests, for example, + that may want to update a system property then confirm that it's used + correctly. In many cases, use of this method may indicate there's a + better way to set up your code. +
+ Caches may be reloaded immediately or lazily; once you call this method, + the reload can occur at any time, even during the invalidation process. + So FIRST make the changes you'd like the caches to notice, then SECOND + call this method to invalidate caches. Don't expect that invalidating, + making changes, then calling
load(), will work. Make changes + before you invalidate. ++
-
+
+ ++empty
++public static Config empty()
+-
+
- Gets an empty configuration. See also
empty(String)to create an + empty configuration with a description, which may improve user-visible + error messages. ++
-
+
+
- Returns:
- an empty configuration
+ ++empty
++public static Config empty(String originDescription)
+-
+
- Gets an empty configuration with a description to be used to create a
+
ConfigOriginfor thisConfig. The description should + be very short and say what the configuration is, like "default settings" + or "foo settings" or something. (Presumably you will merge some actual + settings into this empty config usingConfig.withFallback(com.typesafe.config.ConfigMergeable), making + the description more useful.) ++
-
+
- Parameters:
originDescription- description of the config +- Returns:
- an empty configuration
+ ++systemProperties
++public static Config systemProperties()
+-
+
- Gets a
Configcontaining the system properties from +System.getProperties(), parsed and converted as with +parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions). ++ This method can return a global immutable singleton, so it's preferred + over parsing system properties yourself. +
+
load(java.lang.String)will include the system properties as overrides already, as + willdefaultReference()anddefaultOverrides(). + ++ Because this returns a singleton, it will not notice changes to system + properties made after the first time this method is called. Use +
invalidateCaches()to force the singleton to reload if you + modify system properties. ++
-
+
+
- Returns:
- system properties parsed into a
Config
+ ++systemEnvironment
++public static Config systemEnvironment()
+-
+
- Gets a
Configcontaining the system's environment variables. + This method can return a global immutable singleton. + ++ Environment variables are used as fallbacks when resolving substitutions + whether or not this object is included in the config being resolved, so + you probably don't need to use this method for most purposes. It can be a + nicer API for accessing environment variables than raw +
System.getenv(String)though, since you can use methods + such asConfig.getInt(java.lang.String). ++
-
+
+
- Returns:
- system environment variables parsed into a
Config
+ ++parseProperties
++public static Config parseProperties(Properties properties, + ConfigParseOptions options)
+-
+
- Converts a Java
Propertiesobject to a +ConfigObjectusing the rules documented in the HOCON + spec. The keys in thePropertiesobject are split on the + period character '.' and treated as paths. The values will all end up as + string values. If you have both "a=foo" and "a.b=bar" in your properties + file, so "a" is both the object containing "b" and the string "foo", then + the string value is dropped. + ++ If you want to have
System.getProperties()as a + ConfigObject, it's better to use thesystemProperties()method + which returns a cached global singleton. ++
-
+
- Parameters:
properties- a Java Properties objectoptions- +- Returns:
- the parsed configuration
+ ++parseProperties
++public static Config parseProperties(Properties properties)
+-
+
-
+
+
+ ++parseReader
++public static Config parseReader(Reader reader, + ConfigParseOptions options)
+-
+
-
+
+
+ ++parseReader
++public static Config parseReader(Reader reader)
+-
+
-
+
+
+ ++parseURL
++public static Config parseURL(URL url, + ConfigParseOptions options)
+-
+
-
+
+
+ ++parseURL
++public static Config parseURL(URL url)
+-
+
-
+
+
+ ++parseFile
++public static Config parseFile(File file, + ConfigParseOptions options)
+-
+
-
+
+
+ ++parseFile
++public static Config parseFile(File file)
+-
+
-
+
+
+ ++parseFileAnySyntax
++public static Config parseFileAnySyntax(File fileBasename, + ConfigParseOptions options)
+-
+
- Parses a file with a flexible extension. If the
fileBasename+ already ends in a known extension, this method parses it according to + that extension (the file's syntax must match its extension). If the +fileBasenamedoes not end in an extension, it parses files + with all known extensions and merges whatever is found. + ++ In the current implementation, the extension ".conf" forces +
ConfigSyntax.CONF, ".json" forcesConfigSyntax.JSON, and + ".properties" forcesConfigSyntax.PROPERTIES. When merging files, + ".conf" falls back to ".json" falls back to ".properties". + ++ Future versions of the implementation may add additional syntaxes or + additional extensions. However, the ordering (fallback priority) of the + three current extensions will remain the same. + +
+ If
optionsforces a specific syntax, this method only parses + files with an extension matching that syntax. + ++ If
options.getAllowMissing()+ is true, then no files have to exist; if false, then at least one file + has to exist. ++
-
+
- Parameters:
fileBasename- a filename with or without extensionoptions- parse options +- Returns:
- the parsed configuration
+ ++parseFileAnySyntax
++public static Config parseFileAnySyntax(File fileBasename)
+-
+
-
+
+
+ ++parseResources
++public static Config parseResources(Class<?> klass, + String resource, + ConfigParseOptions options)
+-
+
- Parses all resources on the classpath with the given name and merges them
+ into a single
Config. + ++ If the resource name does not begin with a "/", it will have the supplied + class's package added to it, in the same way as +
Class.getResource(java.lang.String). + ++ Duplicate resources with the same name are merged such that ones returned + earlier from
ClassLoader.getResources(java.lang.String)fall back to (have higher + priority than) the ones returned later. This implies that resources + earlier in the classpath override those later in the classpath when they + configure the same setting. However, in practice real applications may + not be consistent about classpath ordering, so be careful. It may be best + to avoid assuming too much. ++
-
+
- Parameters:
klass-klass.getClassLoader()will be used to load + resources, and non-absolute resource names will have this + class's package addedresource- resource to look up, relative toklass's package + or absolute starting with a "/"options- parse options +- Returns:
- the parsed configuration
+ ++parseResources
++public static Config parseResources(Class<?> klass, + String resource)
+-
+
-
+
+
+ ++parseResourcesAnySyntax
++public static Config parseResourcesAnySyntax(Class<?> klass, + String resourceBasename, + ConfigParseOptions options)
+-
+
- Parses classpath resources with a flexible extension. In general, this
+ method has the same behavior as
+
parseFileAnySyntax(File,ConfigParseOptions)but for classpath + resources instead, as inparseResources(java.lang.Class, java.lang.String, com.typesafe.config.ConfigParseOptions). + ++ There is a thorny problem with this method, which is that +
ClassLoader.getResources(java.lang.String)must be called separately for + each possible extension. The implementation ends up with separate lists + of resources called "basename.conf" and "basename.json" for example. As a + result, the ideal ordering between two files with different extensions is + unknown; there is no way to figure out how to merge the two lists in + classpath order. To keep it simple, the lists are simply concatenated, + with the same syntax priorities as +parseFileAnySyntax()+ - all ".conf" resources are ahead of all ".json" resources which are + ahead of all ".properties" resources. ++
-
+
- Parameters:
klass- class which determines theClassLoaderand the + package for relative resource namesresourceBasename- a resource name as inClass.getResource(java.lang.String), + with or without extensionoptions- parse options (class loader is ignored in favor of the one + from klass) +- Returns:
- the parsed configuration
+ ++parseResourcesAnySyntax
++public static Config parseResourcesAnySyntax(Class<?> klass, + String resourceBasename)
+-
+
-
+
+
+ ++parseResources
++public static Config parseResources(ClassLoader loader, + String resource, + ConfigParseOptions options)
+-
+
- Parses all resources on the classpath with the given name and merges them
+ into a single
Config. + ++ This works like
ClassLoader.getResource(java.lang.String), not like +Class.getResource(java.lang.String), so the name never begins with a + slash. + ++ See
parseResources(Class,String,ConfigParseOptions)for full + details. ++
-
+
- Parameters:
loader- will be used to load resources by setting this loader on the + provided optionsresource- resource to look upoptions- parse options (class loader is ignored) +- Returns:
- the parsed configuration
+ ++parseResources
++public static Config parseResources(ClassLoader loader, + String resource)
+-
+
-
+
+
+ ++parseResourcesAnySyntax
++public static Config parseResourcesAnySyntax(ClassLoader loader, + String resourceBasename, + ConfigParseOptions options)
+-
+
- Parses classpath resources with a flexible extension. In general, this
+ method has the same behavior as
+
parseFileAnySyntax(File,ConfigParseOptions)but for classpath + resources instead, as in +parseResources(ClassLoader,String,ConfigParseOptions). + ++
parseResourcesAnySyntax(Class,String,ConfigParseOptions)differs + in the syntax for the resource name, but otherwise see +parseResourcesAnySyntax(Class,String,ConfigParseOptions)for + some details and caveats on this method. ++
-
+
- Parameters:
loader- class loader to look up resources in, will be set on optionsresourceBasename- a resource name as in +ClassLoader.getResource(java.lang.String), with or without + extensionoptions- parse options (class loader ignored) +- Returns:
- the parsed configuration
+ ++parseResourcesAnySyntax
++public static Config parseResourcesAnySyntax(ClassLoader loader, + String resourceBasename)
+-
+
-
+
+
+ ++parseResources
++public static Config parseResources(String resource, + ConfigParseOptions options)
+-
+
- Like
parseResources(ClassLoader,String,ConfigParseOptions)but + uses thread's current context class loader. ++
-
+
+ ++parseResources
++public static Config parseResources(String resource)
+-
+
- Like
parseResources(ClassLoader,String)but uses thread's + current context class loader. ++
-
+
+ ++parseResourcesAnySyntax
++public static Config parseResourcesAnySyntax(String resourceBasename, + ConfigParseOptions options)
+-
+
- Like
+
parseResourcesAnySyntax(ClassLoader,String,ConfigParseOptions)+ but uses thread's current context class loader. ++
-
+
+ ++parseResourcesAnySyntax
++public static Config parseResourcesAnySyntax(String resourceBasename)
+-
+
- Like
parseResourcesAnySyntax(ClassLoader,String)but uses + thread's current context class loader. ++
-
+
+ ++parseString
++public static Config parseString(String s, + ConfigParseOptions options)
+-
+
-
+
+
+ ++parseString
++public static Config parseString(String s)
+-
+
-
+
+
+ ++parseMap
++public static Config parseMap(Map<String,? extends Object> values, + String originDescription)
+-
+
- Creates a
Configbased on aMapfrom paths to + plain Java values. Similar to +ConfigValueFactory.fromMap(Map,String), except the keys in the + map are path expressions, rather than keys; and correspondingly it + returns aConfiginstead of aConfigObject. This is more + convenient if you are writing literal maps in code, and less convenient + if you are getting your maps from some data source such as a parser. + ++ An exception will be thrown (and it is a bug in the caller of the method) + if a path is both an object and a value, for example if you had both + "a=foo" and "a.b=bar", then "a" is both the string "foo" and the parent + object of "b". The caller of this method should ensure that doesn't + happen. +
+
-
+
- Parameters:
values-originDescription- description of what this map represents, like a filename, or + "default settings" (origin description is used in error + messages) +- Returns:
- the map converted to a
Config
+ ++parseMap
++public static Config parseMap(Map<String,? extends Object> values)
+-
+
- See the other overload of
parseMap(Map, String)for details, + this one just uses a default origin description. ++
-
+
- Parameters:
values- +- Returns:
- the map converted to a
Config
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigIncludeContext.html b/v0.6.0/com/typesafe/config/ConfigIncludeContext.html new file mode 100644 index 00000000..fb7c3561 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigIncludeContext.html @@ -0,0 +1,254 @@ + + + + + ++ConfigIncludeContext + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigIncludeContext
+-
+
public interface ConfigIncludeContext
+Context provided to a
ConfigIncluder; this interface is only useful + inside aConfigIncluderimplementation, and is not intended for apps + to implement. + ++ Do not implement this interface; it should only be implemented by + the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. +
+ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigParseOptionsparseOptions()+ +
+ Parse options to use (if you use another method to get a +ConfigParseablethen useConfigParseable.options()+ instead though).+ ++ +ConfigParseablerelativeTo(String filename)+ +
+ Tries to find a name relative to whatever is doing the including, for + example in the same directory as the file doing the including.+
+ ++ ++Method Detail ++relativeTo
++ConfigParseable relativeTo(String filename)
+-
+
- Tries to find a name relative to whatever is doing the including, for
+ example in the same directory as the file doing the including. Returns
+ null if it can't meaningfully create a relative name. The returned
+ parseable may not exist; this function is not required to do any IO, just
+ compute what the name would be.
+
+ The passed-in filename has to be a complete name (with extension), not
+ just a basename. (Include statements in config files are allowed to give
+ just a basename.)
+
+
-
+
- Parameters:
filename- the name to make relative to the resource doing the including +- Returns:
- parseable item relative to the resource doing the including, or + null
+ ++parseOptions
++ConfigParseOptions parseOptions()
+-
+
- Parse options to use (if you use another method to get a
+
ConfigParseablethen useConfigParseable.options()+ instead though). ++
-
+
+
- Returns:
- the parse options
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigIncluder.html b/v0.6.0/com/typesafe/config/ConfigIncluder.html new file mode 100644 index 00000000..a97528a8 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigIncluder.html @@ -0,0 +1,255 @@ + + + + + ++ConfigIncluder + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigIncluder
+-
+
public interface ConfigIncluder
+Implement this interface and provide an instance to +
ConfigParseOptions.setIncluder()to + customize handling ofincludestatements in config files. You may + also want to implementConfigIncluderClasspath, +ConfigIncluderFile, andConfigIncluderURL, or not. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigObjectinclude(ConfigIncludeContext context, + String what)+ +
+ Parses another item to be included.+ ++ +ConfigIncluderwithFallback(ConfigIncluder fallback)+ +
+ Returns a new includer that falls back to the given includer.+
+ ++ ++Method Detail ++withFallback
++ConfigIncluder withFallback(ConfigIncluder fallback)
+-
+
- Returns a new includer that falls back to the given includer. This is how
+ you can obtain the default includer; it will be provided as a fallback.
+ It's up to your includer to chain to it if you want to. You might want to
+ merge any files found by the fallback includer with any objects you load
+ yourself.
+
+ It's important to handle the case where you already have the fallback
+ with a "return this", i.e. this method should not create a new object if
+ the fallback is the same one you already have. The same fallback may be
+ added repeatedly.
+
+
-
+
- Parameters:
fallback- +- Returns:
- a new includer
+ ++include
++ConfigObject include(ConfigIncludeContext context, + String what)
+-
+
- Parses another item to be included. The returned object typically would
+ not have substitutions resolved. You can throw a ConfigException here to
+ abort parsing, or return an empty object, but may not return null.
+
+ This method is used for a "heuristic" include statement that does not
+ specify file, URL, or classpath resource. If the include statement does
+ specify, then the same class implementing
ConfigIncludermust + also implementConfigIncluderClasspath, +ConfigIncluderFile, orConfigIncluderURLas needed, or a + default includer will be used. ++
-
+
- Parameters:
context- some info about the include contextwhat- the include statement's argument +- Returns:
- a non-null ConfigObject
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigIncluderClasspath.html b/v0.6.0/com/typesafe/config/ConfigIncluderClasspath.html new file mode 100644 index 00000000..c17a4a31 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigIncluderClasspath.html @@ -0,0 +1,216 @@ + + + + + ++ConfigIncluderClasspath + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigIncluderClasspath
+-
+
public interface ConfigIncluderClasspath
+Implement this in addition to
ConfigIncluderif you want to + support inclusion of files with theinclude classpath("resource")+ syntax. If you do not implement this but do implementConfigIncluder, + attempts to load classpath resources will use the default includer. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigObjectincludeResources(ConfigIncludeContext context, + String what)+ +
+ Parses another item to be included.+
+ ++ ++Method Detail ++includeResources
++ConfigObject includeResources(ConfigIncludeContext context, + String what)
+-
+
- Parses another item to be included. The returned object typically would
+ not have substitutions resolved. You can throw a ConfigException here to
+ abort parsing, or return an empty object, but may not return null.
+
+
-
+
- Parameters:
context- some info about the include contextwhat- the include statement's argument +- Returns:
- a non-null ConfigObject
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigIncluderFile.html b/v0.6.0/com/typesafe/config/ConfigIncluderFile.html new file mode 100644 index 00000000..58063b43 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigIncluderFile.html @@ -0,0 +1,216 @@ + + + + + ++ConfigIncluderFile + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigIncluderFile
+-
+
public interface ConfigIncluderFile
+Implement this in addition to
ConfigIncluderif you want to + support inclusion of files with theinclude file("filename")syntax. + If you do not implement this but do implementConfigIncluder, + attempts to load files will use the default includer. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigObjectincludeFile(ConfigIncludeContext context, + File what)+ +
+ Parses another item to be included.+
+ ++ ++Method Detail ++includeFile
++ConfigObject includeFile(ConfigIncludeContext context, + File what)
+-
+
- Parses another item to be included. The returned object typically would
+ not have substitutions resolved. You can throw a ConfigException here to
+ abort parsing, or return an empty object, but may not return null.
+
+
-
+
- Parameters:
context- some info about the include contextwhat- the include statement's argument +- Returns:
- a non-null ConfigObject
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigIncluderURL.html b/v0.6.0/com/typesafe/config/ConfigIncluderURL.html new file mode 100644 index 00000000..4c0b56aa --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigIncluderURL.html @@ -0,0 +1,216 @@ + + + + + ++ConfigIncluderURL + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigIncluderURL
+-
+
public interface ConfigIncluderURL
+Implement this in addition to
ConfigIncluderif you want to + support inclusion of files with theinclude url("http://example.com")+ syntax. If you do not implement this but do implementConfigIncluder, + attempts to load URLs will use the default includer. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigObjectincludeURL(ConfigIncludeContext context, + URL what)+ +
+ Parses another item to be included.+
+ ++ ++Method Detail ++includeURL
++ConfigObject includeURL(ConfigIncludeContext context, + URL what)
+-
+
- Parses another item to be included. The returned object typically would
+ not have substitutions resolved. You can throw a ConfigException here to
+ abort parsing, or return an empty object, but may not return null.
+
+
-
+
- Parameters:
context- some info about the include contextwhat- the include statement's argument +- Returns:
- a non-null ConfigObject
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigList.html b/v0.6.0/com/typesafe/config/ConfigList.html new file mode 100644 index 00000000..c6841fe7 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigList.html @@ -0,0 +1,257 @@ + + + + + ++ConfigList + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigList-
+
- All Superinterfaces:
- Collection<ConfigValue>, ConfigMergeable, ConfigValue, Iterable<ConfigValue>, List<ConfigValue> +
+-
+
public interface ConfigList
- extends List<ConfigValue>, ConfigValue
+Subtype of
ConfigValuerepresenting a list value, as in JSON's +[1,2,3]syntax. + ++
ConfigListimplementsjava.util.List<ConfigValue>so you can + use it like a regular Java list. Or callunwrapped()to unwrap the + list elements into plain Java values. + ++ Like all
ConfigValuesubtypes,ConfigListis immutable. This + makes it threadsafe and you never have to create "defensive copies." The + mutator methods fromListall throw +UnsupportedOperationException. + ++ The
ConfigValue.valueType()method on a list returns +ConfigValueType.LIST. + ++ Do not implement
ConfigList; it should only be implemented + by the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +List<Object>unwrapped()+ +
+ Recursively unwraps the list, returning a list of plain Java values such + as Integer or String or whatever is in the list.+
+ ++ +Methods inherited from interface java.util.List ++ +add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray+
+ ++ +Methods inherited from interface com.typesafe.config.ConfigValue ++ +atKey, atPath, origin, render, render, valueType, withFallback+
+ ++ ++Method Detail ++unwrapped
++List<Object> unwrapped()
+-
+
- Recursively unwraps the list, returning a list of plain Java values such
+ as Integer or String or whatever is in the list.
+
+
-
+
- Specified by:
unwrappedin interfaceConfigValue
-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigMergeable.html b/v0.6.0/com/typesafe/config/ConfigMergeable.html new file mode 100644 index 00000000..7cefd65d --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigMergeable.html @@ -0,0 +1,242 @@ + + + + + ++ConfigMergeable + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigMergeable-
+
- All Known Subinterfaces:
- Config, ConfigList, ConfigObject, ConfigValue +
+-
+
public interface ConfigMergeable
+Marker for types whose instances can be merged, that is
Configand +ConfigValue. Instances ofConfigandConfigValuecan + be combined into a single new instance using the +withFallback()method. + ++ Do not implement this interface; it should only be implemented by + the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. +
+ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigMergeablewithFallback(ConfigMergeable other)+ +
+ Returns a new value computed by merging this value with another, with + keys in this value "winning" over the other one.+
+ ++ ++Method Detail ++withFallback
++ConfigMergeable withFallback(ConfigMergeable other)
+-
+
- Returns a new value computed by merging this value with another, with
+ keys in this value "winning" over the other one. Only
+
ConfigObjectandConfiginstances do anything in this + method (they need to merge the fallback keys into themselves). All other + values just return the original value, since they automatically override + any fallback. + ++ The semantics of merging are described in the spec + for HOCON. + +
+ Note that objects do not merge "across" non-objects; if you write +
object.withFallback(nonObject).withFallback(otherObject), + thenotherObjectwill simply be ignored. This is an + intentional part of how merging works. Both non-objects, and any object + which has fallen back to a non-object, block subsequent fallbacks. ++
-
+
- Parameters:
other- an object whose keys should be used if the keys are not + present in this one +- Returns:
- a new object (or the original one, if the fallback doesn't get + used)
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigObject.html b/v0.6.0/com/typesafe/config/ConfigObject.html new file mode 100644 index 00000000..f1f95d58 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigObject.html @@ -0,0 +1,487 @@ + + + + + ++ConfigObject + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigObject-
+
- All Superinterfaces:
- ConfigMergeable, ConfigValue, Map<String,ConfigValue> +
+-
+
public interface ConfigObject
- extends ConfigValue, Map<String,ConfigValue>
+Subtype of
ConfigValuerepresenting an object (dictionary, map) + value, as in JSON's{ "a" : 42 }syntax. + ++
ConfigObjectimplementsjava.util.Map<String, ConfigValue>so + you can use it like a regular Java map. Or callunwrapped()to + unwrap the map to a map with plain Java values rather than +ConfigValue. + ++ Like all
ConfigValuesubtypes,ConfigObjectis immutable. + This makes it threadsafe and you never have to create "defensive copies." The + mutator methods fromMapall throw +UnsupportedOperationException. + ++ The
ConfigValue.valueType()method on an object returns +ConfigValueType.OBJECT. + ++ In most cases you want to use the
Configinterface rather than this + one. CalltoConfig()to convert aConfigObjectto a +Config. + ++ The API for a
ConfigObjectis in terms of keys, while the API for a +Configis in terms of path expressions. Conceptually, +ConfigObjectis a tree of maps from keys to values, while a +Configis a one-level map from paths to values. + ++ Use
ConfigUtil.joinPath(java.lang.String...)andConfigUtil.splitPath(java.lang.String)to convert + between path expressions and individual path elements (keys). + ++ A
ConfigObjectmay contain null values, which will have +ConfigValue.valueType()equal toConfigValueType.NULL. If +get()returns Java's null then the key was not present in the parsed + file (or wherever this value tree came from). Ifget()returns a +ConfigValuewith typeConfigValueType#NULLthen the key was + set to null explicitly in the config file. + ++ Do not implement
ConfigObject; it should only be implemented + by the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. ++ +
+
+ ++
+ ++ ++Nested Class Summary ++
+ + + + + ++ +Nested classes/interfaces inherited from interface java.util.Map ++ +Map.Entry<K,V>+
+ ++ ++Method Summary ++ ++ +ConfigValueget(Object key)+ +
+ Gets aConfigValueat the given key, or returns null if there is + no value.+ ++ +ConfigtoConfig()+ +
+ Converts this object to aConfiginstance, enabling you to use + path expressions to find values in the object.+ ++ +Map<String,Object>unwrapped()+ +
+ Recursively unwraps the object, returning a map from String to whatever + plain Java values are unwrapped from the object's values.+ ++ +ConfigObjectwithFallback(ConfigMergeable other)+ +
+ Returns a new value computed by merging this value with another, with + keys in this value "winning" over the other one.+ ++ +ConfigObjectwithOnlyKey(String key)+ +
+ Clone the object with only the given key (and its children) retained; all + sibling keys are removed.+ ++ +ConfigObjectwithoutKey(String key)+ +
+ Clone the object with the given key removed.+ ++ +ConfigObjectwithValue(String key, + ConfigValue value)+ +
+ Returns aConfigObjectbased on this one, but with the given key + set to the given value.+
+ ++ +Methods inherited from interface com.typesafe.config.ConfigValue ++ +atKey, atPath, origin, render, render, valueType+
+ ++ +Methods inherited from interface java.util.Map ++ +clear, containsKey, containsValue, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values+
+ ++ ++Method Detail ++toConfig
++Config toConfig()
+-
+
- Converts this object to a
Configinstance, enabling you to use + path expressions to find values in the object. This is a constant-time + operation (it is not proportional to the size of the object). ++
-
+
-
+
+
- Returns:
- a
Configwith this object as its root
+ ++unwrapped
++Map<String,Object> unwrapped()
+-
+
- Recursively unwraps the object, returning a map from String to whatever
+ plain Java values are unwrapped from the object's values.
+
+
-
+
- Specified by:
unwrappedin interfaceConfigValue
-
+
+
- Returns:
- a
Mapcontaining plain Java objects
+ ++withFallback
++ConfigObject withFallback(ConfigMergeable other)
+-
+
- Description copied from interface:
ConfigMergeable
+ - Returns a new value computed by merging this value with another, with
+ keys in this value "winning" over the other one. Only
+
ConfigObjectandConfiginstances do anything in this + method (they need to merge the fallback keys into themselves). All other + values just return the original value, since they automatically override + any fallback. + ++ The semantics of merging are described in the spec + for HOCON. + +
+ Note that objects do not merge "across" non-objects; if you write +
object.withFallback(nonObject).withFallback(otherObject), + thenotherObjectwill simply be ignored. This is an + intentional part of how merging works. Both non-objects, and any object + which has fallen back to a non-object, block subsequent fallbacks. ++
-
+
- Specified by:
withFallbackin interfaceConfigMergeable- Specified by:
withFallbackin interfaceConfigValue
-
+
- Parameters:
other- an object whose keys should be used if the keys are not + present in this one +- Returns:
- a new object (or the original one, if the fallback doesn't get + used)
+ ++get
++ConfigValue get(Object key)
+-
+
- Gets a
ConfigValueat the given key, or returns null if there is + no value. The returnedConfigValuemay have +ConfigValueType.NULLor any other type, and the passed-in key + must be a key in this object, rather than a path expression. ++
-
+
- Specified by:
getin interfaceMap<String,ConfigValue>
-
+
- Parameters:
key- key to look up +- Returns:
- the value at the key or null if none
+ ++withOnlyKey
++ConfigObject withOnlyKey(String key)
+-
+
- Clone the object with only the given key (and its children) retained; all
+ sibling keys are removed.
+
+
-
+
-
+
- Parameters:
key- key to keep +- Returns:
- a copy of the object minus all keys except the one specified
+ ++withoutKey
++ConfigObject withoutKey(String key)
+-
+
- Clone the object with the given key removed.
+
+
-
+
-
+
- Parameters:
key- key to remove +- Returns:
- a copy of the object minus the specified key
+ ++withValue
++ConfigObject withValue(String key, + ConfigValue value)
+-
+
- Returns a
ConfigObjectbased on this one, but with the given key + set to the given value. Does not modify this instance (since it's + immutable). If the key already has a value, that value is replaced. To + remove a value, use withoutKey(). ++
-
+
-
+
- Parameters:
key- key to addvalue- value at the new key +- Returns:
- the new instance with the new map entry
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigOrigin.html b/v0.6.0/com/typesafe/config/ConfigOrigin.html new file mode 100644 index 00000000..f8800bd5 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigOrigin.html @@ -0,0 +1,346 @@ + + + + + ++ConfigOrigin + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigOrigin
+-
+
public interface ConfigOrigin
+Represents the origin (such as filename and line number) of a +
ConfigValuefor use in error messages. Obtain the origin of a value + withConfigValue.origin(). Exceptions may have an origin, see +ConfigException.origin, but be careful because +ConfigException.origin()may return null. + ++ It's best to use this interface only for debugging; its accuracy is + "best effort" rather than guaranteed, and a potentially-noticeable amount of + memory could probably be saved if origins were not kept around, so in the + future there might be some option to discard origins. + +
+ Do not implement this interface; it should only be implemented by + the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. +
+ +
+
+ ++
+ ++ ++Method Summary ++ ++ +List<String>comments()+ +
+ Returns any comments that appeared to "go with" this place in the file.+ ++ +Stringdescription()+ +
+ Returns a string describing the origin of a value or exception.+ ++ +Stringfilename()+ +
+ Returns a filename describing the origin.+ ++ +intlineNumber()+ +
+ Returns a line number where the value or exception originated.+ ++ +Stringresource()+ +
+ Returns a classpath resource name describing the origin.+ ++ +URLurl()+ +
+ Returns a URL describing the origin.+
+ ++ ++Method Detail ++description
++String description()
+-
+
- Returns a string describing the origin of a value or exception. This will
+ never return null.
+
+
-
+
+
- Returns:
- string describing the origin
+ ++filename
++String filename()
+-
+
- Returns a filename describing the origin. This will return null if the
+ origin was not a file.
+
+
-
+
+
- Returns:
- filename of the origin or null
+ ++url
++URL url()
+-
+
- Returns a URL describing the origin. This will return null if the origin
+ has no meaningful URL.
+
+
-
+
+
- Returns:
- url of the origin or null
+ ++resource
++String resource()
+-
+
- Returns a classpath resource name describing the origin. This will return
+ null if the origin was not a classpath resource.
+
+
-
+
+
- Returns:
- resource name of the origin or null
+ ++lineNumber
++int lineNumber()
+-
+
- Returns a line number where the value or exception originated. This will
+ return -1 if there's no meaningful line number.
+
+
-
+
+
- Returns:
- line number or -1 if none is available
+ ++comments
++List<String> comments()
+-
+
- Returns any comments that appeared to "go with" this place in the file.
+ Often an empty list, but never null. The details of this are subject to
+ change, but at the moment comments that are immediately before an array
+ element or object field, with no blank line after the comment, "go with"
+ that element or field.
+
+
-
+
+
- Returns:
- any comments that seemed to "go with" this origin, empty list if + none
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigParseOptions.html b/v0.6.0/com/typesafe/config/ConfigParseOptions.html new file mode 100644 index 00000000..3ad21c3b --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigParseOptions.html @@ -0,0 +1,491 @@ + + + + + ++ConfigParseOptions + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigParseOptions+java.lang.Object +
+com.typesafe.config.ConfigParseOptions
+
+-
+
public final class ConfigParseOptions
- extends Object
+A set of options related to parsing. + +
+ This object is immutable, so the "setters" return a new object. + +
+ Here is an example of creating a custom
ConfigParseOptions: + ++ ConfigParseOptions options = ConfigParseOptions.defaults() + .setSyntax(ConfigSyntax.JSON) + .setAllowMissing(false) +
++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigParseOptionsappendIncluder(ConfigIncluder includer)+ +
++ ++ +static ConfigParseOptionsdefaults()+ +
++ ++ +booleangetAllowMissing()+ +
++ ++ +ClassLoadergetClassLoader()+ +
+ Get the class loader; never returnsnull, if the class loader was + unset, returns +Thread.currentThread().getContextClassLoader().+ ++ +ConfigIncludergetIncluder()+ +
++ ++ +StringgetOriginDescription()+ +
++ ++ +ConfigSyntaxgetSyntax()+ +
++ ++ +ConfigParseOptionsprependIncluder(ConfigIncluder includer)+ +
++ ++ +ConfigParseOptionssetAllowMissing(boolean allowMissing)+ +
+ Set to false to throw an exception if the item being parsed (for example + a file) is missing.+ ++ +ConfigParseOptionssetClassLoader(ClassLoader loader)+ +
+ Set the class loader.+ ++ +ConfigParseOptionssetIncluder(ConfigIncluder includer)+ +
+ Set a ConfigIncluder which customizes how includes are handled.+ ++ +ConfigParseOptionssetOriginDescription(String originDescription)+ +
+ Set a description for the thing being parsed.+ ++ +ConfigParseOptionssetSyntax(ConfigSyntax syntax)+ +
+ Set the file format.+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait+
+ ++ ++Method Detail ++defaults
++public static ConfigParseOptions defaults()
+-
+
-
+
+
+ ++setSyntax
++public ConfigParseOptions setSyntax(ConfigSyntax syntax)
+-
+
- Set the file format. If set to null, try to guess from any available
+ filename extension; if guessing fails, assume
ConfigSyntax.CONF. ++
-
+
- Parameters:
syntax- a syntax ornullfor best guess +- Returns:
- options with the syntax set
+ ++getSyntax
++public ConfigSyntax getSyntax()
+-
+
-
+
+
+ ++setOriginDescription
++public ConfigParseOptions setOriginDescription(String originDescription)
+-
+
- Set a description for the thing being parsed. In most cases this will be
+ set up for you to something like the filename, but if you provide just an
+ input stream you might want to improve on it. Set to null to allow the
+ library to come up with something automatically. This description is the
+ basis for the
ConfigOriginof the parsed values. ++
-
+
- Parameters:
originDescription- +- Returns:
- options with the origin description set
+ ++getOriginDescription
++public String getOriginDescription()
+-
+
-
+
+
+ ++setAllowMissing
++public ConfigParseOptions setAllowMissing(boolean allowMissing)
+-
+
- Set to false to throw an exception if the item being parsed (for example
+ a file) is missing. Set to true to just return an empty document in that
+ case.
+
+
-
+
- Parameters:
allowMissing- +- Returns:
- options with the "allow missing" flag set
+ ++getAllowMissing
++public boolean getAllowMissing()
+-
+
-
+
+
+ ++setIncluder
++public ConfigParseOptions setIncluder(ConfigIncluder includer)
+-
+
- Set a ConfigIncluder which customizes how includes are handled.
+
+
-
+
- Parameters:
includer- +- Returns:
- new version of the parse options with different includer
+ ++prependIncluder
++public ConfigParseOptions prependIncluder(ConfigIncluder includer)
+-
+
-
+
+
+ ++appendIncluder
++public ConfigParseOptions appendIncluder(ConfigIncluder includer)
+-
+
-
+
+
+ ++getIncluder
++public ConfigIncluder getIncluder()
+-
+
-
+
+
+ ++setClassLoader
++public ConfigParseOptions setClassLoader(ClassLoader loader)
+-
+
- Set the class loader. If set to null,
+
Thread.currentThread().getContextClassLoader()will be used. ++
-
+
- Parameters:
loader- a class loader ornullto use thread context class + loader +- Returns:
- options with the class loader set
+ ++getClassLoader
++public ClassLoader getClassLoader()
+-
+
- Get the class loader; never returns
null, if the class loader was + unset, returns +Thread.currentThread().getContextClassLoader(). ++
-
+
+
- Returns:
- class loader to use
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigParseable.html b/v0.6.0/com/typesafe/config/ConfigParseable.html new file mode 100644 index 00000000..51ba6d7c --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigParseable.html @@ -0,0 +1,265 @@ + + + + + ++ConfigParseable + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigParseable
+-
+
public interface ConfigParseable
+An opaque handle to something that can be parsed, obtained from +
ConfigIncludeContext. + ++ Do not implement this interface; it should only be implemented by + the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. +
+ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigParseOptionsoptions()+ +
+ Get the initial options, which can be modified then passed to parse().+ ++ +ConfigOriginorigin()+ +
+ Returns aConfigOrigindescribing the origin of the parseable + item.+ ++ +ConfigObjectparse(ConfigParseOptions options)+ +
+ Parse whatever it is.+
+ ++ ++Method Detail ++parse
++ConfigObject parse(ConfigParseOptions options)
+-
+
- Parse whatever it is. The options should come from
+
options()but you could tweak them if you + like. ++
-
+
- Parameters:
options- parse options, should be based on the ones from +options()
+ ++origin
++ConfigOrigin origin()
+-
+
- Returns a
ConfigOrigindescribing the origin of the parseable + item. ++
-
+
+ ++options
++ConfigParseOptions options()
+-
+
- Get the initial options, which can be modified then passed to parse().
+ These options will have the right description, includer, and other
+ parameters already set up.
+
+
-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigRenderOptions.html b/v0.6.0/com/typesafe/config/ConfigRenderOptions.html new file mode 100644 index 00000000..7f7aa4ac --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigRenderOptions.html @@ -0,0 +1,476 @@ + + + + + ++ConfigRenderOptions + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigRenderOptions+java.lang.Object +
+com.typesafe.config.ConfigRenderOptions
+
+-
+
public final class ConfigRenderOptions
- extends Object
+
+ A set of options related to rendering a
ConfigValue. Passed to +ConfigValue.render(ConfigRenderOptions). + ++ Here is an example of creating a
ConfigRenderOptions: + ++ ConfigRenderOptions options = + ConfigRenderOptions.defaults().setComments(false) +
++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +static ConfigRenderOptionsconcise()+ +
+ Returns concise render options (no whitespace or comments).+ ++ +static ConfigRenderOptionsdefaults()+ +
+ Returns the default render options which are verbose (commented and + formatted).+ ++ +booleangetComments()+ +
+ Returns whether the options enable comments.+ ++ +booleangetFormatted()+ +
+ Returns whether the options enable formatting.+ ++ +booleangetJson()+ +
+ Returns whether the options enable JSON.+ ++ +booleangetOriginComments()+ +
+ Returns whether the options enable automated origin comments.+ ++ +ConfigRenderOptionssetComments(boolean value)+ +
+ Returns options with comments toggled.+ ++ +ConfigRenderOptionssetFormatted(boolean value)+ +
+ Returns options with formatting toggled.+ ++ +ConfigRenderOptionssetJson(boolean value)+ +
+ Returns options with JSON toggled.+ ++ +ConfigRenderOptionssetOriginComments(boolean value)+ +
+ Returns options with origin comments toggled.+ ++ +StringtoString()+ +
++
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait+
+ ++ ++Method Detail ++defaults
++public static ConfigRenderOptions defaults()
+-
+
- Returns the default render options which are verbose (commented and
+ formatted). See
concise()for stripped-down + options. This rendering will not be valid JSON since it has comments. ++
-
+
+
- Returns:
- the default render options
+ ++concise
++public static ConfigRenderOptions concise()
+-
+
- Returns concise render options (no whitespace or comments). For a
+ resolved
Config, the concise rendering will be valid JSON. ++
-
+
+
- Returns:
- the concise render options
+ ++setComments
++public ConfigRenderOptions setComments(boolean value)
+-
+
- Returns options with comments toggled. This controls human-written
+ comments but not the autogenerated "origin of this setting" comments,
+ which are controlled by
setOriginComments(boolean). ++
-
+
- Parameters:
value- true to include comments in the render +- Returns:
- options with requested setting for comments
+ ++getComments
++public boolean getComments()
+-
+
- Returns whether the options enable comments. This method is mostly used
+ by the config lib internally, not by applications.
+
+
-
+
+
- Returns:
- true if comments should be rendered
+ ++setOriginComments
++public ConfigRenderOptions setOriginComments(boolean value)
+-
+
- Returns options with origin comments toggled. If this is enabled, the
+ library generates comments for each setting based on the
+
ConfigValue.origin()of that setting's value. For example these + comments might tell you which file a setting comes from. + ++
setOriginComments()controls only these autogenerated + "origin of this setting" comments, to toggle regular comments use +setComments(boolean). ++
-
+
- Parameters:
value- true to include autogenerated setting-origin comments in the + render +- Returns:
- options with origin comments toggled
+ ++getOriginComments
++public boolean getOriginComments()
+-
+
- Returns whether the options enable automated origin comments. This method
+ is mostly used by the config lib internally, not by applications.
+
+
-
+
+
- Returns:
- true if origin comments should be rendered
+ ++setFormatted
++public ConfigRenderOptions setFormatted(boolean value)
+-
+
- Returns options with formatting toggled. Formatting means indentation and
+ whitespace, enabling formatting makes things prettier but larger.
+
+
-
+
- Parameters:
value- true to include comments in the render +- Returns:
- options with requested setting for formatting
+ ++getFormatted
++public boolean getFormatted()
+-
+
- Returns whether the options enable formatting. This method is mostly used
+ by the config lib internally, not by applications.
+
+
-
+
+
- Returns:
- true if comments should be rendered
+ ++setJson
++public ConfigRenderOptions setJson(boolean value)
+-
+
- Returns options with JSON toggled. JSON means that HOCON extensions
+ (omitting commas, quotes for example) won't be used. However, whether to
+ use comments is controlled by the separate
setComments(boolean)+ andsetOriginComments(boolean)options. So if you enable + comments you will get invalid JSON despite setting this to true. ++
-
+
- Parameters:
value- true to include non-JSON extensions in the render +- Returns:
- options with requested setting for JSON
+ ++getJson
++public boolean getJson()
+-
+
- Returns whether the options enable JSON. This method is mostly used by
+ the config lib internally, not by applications.
+
+
-
+
+
- Returns:
- true if only JSON should be rendered
+ ++toString
++public String toString()
+ + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigResolveOptions.html b/v0.6.0/com/typesafe/config/ConfigResolveOptions.html new file mode 100644 index 00000000..104f4b06 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigResolveOptions.html @@ -0,0 +1,310 @@ + + + + + ++ConfigResolveOptions + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigResolveOptions+java.lang.Object +
+com.typesafe.config.ConfigResolveOptions
+
+-
+
public final class ConfigResolveOptions
- extends Object
+A set of options related to resolving substitutions. Substitutions use the +
${foo.bar}syntax and are documented in the HOCON + spec. ++ This object is immutable, so the "setters" return a new object. +
+ Here is an example of creating a custom
ConfigResolveOptions: + ++ ConfigResolveOptions options = ConfigResolveOptions.defaults() + .setUseSystemEnvironment(false) +
++ In addition to
defaults(), there's a prebuilt +noSystem()which avoids looking at any system + environment variables or other external system information. (Right now, + environment variables are the only example.) ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +static ConfigResolveOptionsdefaults()+ +
+ Returns the default resolve options.+ ++ +booleangetUseSystemEnvironment()+ +
+ Returns whether the options enable use of system environment variables.+ ++ +static ConfigResolveOptionsnoSystem()+ +
+ Returns resolve options that disable any reference to "system" data + (currently, this means environment variables).+ ++ +ConfigResolveOptionssetUseSystemEnvironment(boolean value)+ +
+ Returns options with use of environment variables set to the given value.+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait+
+ ++ ++Method Detail ++defaults
++public static ConfigResolveOptions defaults()
+-
+
- Returns the default resolve options.
+
+
-
+
+
- Returns:
- the default resolve options
+ ++noSystem
++public static ConfigResolveOptions noSystem()
+-
+
- Returns resolve options that disable any reference to "system" data
+ (currently, this means environment variables).
+
+
-
+
+
- Returns:
- the resolve options with env variables disabled
+ ++setUseSystemEnvironment
++public ConfigResolveOptions setUseSystemEnvironment(boolean value)
+-
+
- Returns options with use of environment variables set to the given value.
+
+
-
+
- Parameters:
value- true to resolve substitutions falling back to environment + variables. +- Returns:
- options with requested setting for use of environment variables
+ ++getUseSystemEnvironment
++public boolean getUseSystemEnvironment()
+-
+
- Returns whether the options enable use of system environment variables.
+ This method is mostly used by the config lib internally, not by
+ applications.
+
+
-
+
+
- Returns:
- true if environment variables should be used
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigSyntax.html b/v0.6.0/com/typesafe/config/ConfigSyntax.html new file mode 100644 index 00000000..3d183f88 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigSyntax.html @@ -0,0 +1,358 @@ + + + + + ++ConfigSyntax + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD ++DETAIL: ENUM CONSTANTS | FIELD | METHOD +
+ ++ +com.typesafe.config +
+
+Enum ConfigSyntax+java.lang.Object +
+java.lang.Enum<ConfigSyntax>
+ com.typesafe.config.ConfigSyntax
+-
+
- All Implemented Interfaces:
- Serializable, Comparable<ConfigSyntax> +
+-
+
public enum ConfigSyntax
- extends Enum<ConfigSyntax>
+The syntax of a character stream, JSON, HOCON + aka ".conf", or Java properties. +
+ +
+
+ ++
+ + + + ++ ++Enum Constant Summary ++ +CONF+ +
+ The JSON-superset HOCON format.+ +JSON+ +
+ Pedantically strict JSON format; no + comments, no unexpected commas, no duplicate keys in the same object.+ +PROPERTIES+ +
+ Standard Java properties format.+
+ ++ ++Method Summary ++ ++ +static ConfigSyntaxvalueOf(String name)+ +
+ Returns the enum constant of this type with the specified name.+ ++ +static ConfigSyntax[]values()+ +
+ Returns an array containing the constants of this enum type, in +the order they are declared.+
+ ++ +Methods inherited from class java.lang.Enum ++ +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf+
+ ++ +Methods inherited from class java.lang.Object ++ +getClass, notify, notifyAll, wait, wait, wait+
+ ++ ++Enum Constant Detail ++JSON
++public static final ConfigSyntax JSON
+-
+
- Pedantically strict JSON format; no
+ comments, no unexpected commas, no duplicate keys in the same object.
+
+
-
+
+ ++CONF
++public static final ConfigSyntax CONF
+-
+
- The JSON-superset HOCON format.
+
+
-
+
+ ++PROPERTIES
++public static final ConfigSyntax PROPERTIES
+-
+
- Standard Java properties format.
+
+
-
+
+
+ ++ ++Method Detail ++values
++public static ConfigSyntax[] values()
+-
+
- Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+
+for (ConfigSyntax c : ConfigSyntax.values()) + System.out.println(c); +
++
-
+
+
- Returns:
- an array containing the constants of this enum type, in +the order they are declared
+ ++valueOf
++public static ConfigSyntax valueOf(String name)
+-
+
- Returns the enum constant of this type with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)
+
+
-
+
- Parameters:
name- the name of the enum constant to be returned. +- Returns:
- the enum constant with the specified name +
- Throws: +
IllegalArgumentException- if this enum type has no constant +with the specified name +NullPointerException- if the argument is null
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD ++DETAIL: ENUM CONSTANTS | FIELD | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigUtil.html b/v0.6.0/com/typesafe/config/ConfigUtil.html new file mode 100644 index 00000000..7eaf962c --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigUtil.html @@ -0,0 +1,306 @@ + + + + + ++ConfigUtil + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigUtil+java.lang.Object +
+com.typesafe.config.ConfigUtil
+
+-
+
public final class ConfigUtil
- extends Object
+Contains static utility methods. +
+ +
+
+ ++
+ ++ ++Method Summary ++ ++ +static StringjoinPath(List<String> elements)+ +
+ Converts a list of strings to a path expression, by quoting the path + elements as needed and then joining them separated by a period.+ ++ +static StringjoinPath(String... elements)+ +
+ Converts a list of keys to a path expression, by quoting the path + elements as needed and then joining them separated by a period.+ ++ +static StringquoteString(String s)+ +
+ Quotes and escapes a string, as in the JSON specification.+ ++ +static List<String>splitPath(String path)+ +
+ Converts a path expression into a list of keys, by splitting on period + and unquoting the individual path elements.+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait+
+ ++ ++Method Detail ++quoteString
++public static String quoteString(String s)
+-
+
- Quotes and escapes a string, as in the JSON specification.
+
+
-
+
- Parameters:
s- a string +- Returns:
- the string quoted and escaped
+ ++joinPath
++public static String joinPath(String... elements)
+-
+
- Converts a list of keys to a path expression, by quoting the path
+ elements as needed and then joining them separated by a period. A path
+ expression is usable with a
Config, while individual path + elements are usable with aConfigObject. ++
-
+
- Parameters:
elements- the keys in the path +- Returns:
- a path expression +
- Throws: +
ConfigException- if there are no elements
+ ++joinPath
++public static String joinPath(List<String> elements)
+-
+
- Converts a list of strings to a path expression, by quoting the path
+ elements as needed and then joining them separated by a period. A path
+ expression is usable with a
Config, while individual path + elements are usable with aConfigObject. ++
-
+
- Parameters:
elements- the keys in the path +- Returns:
- a path expression +
- Throws: +
ConfigException- if the list is empty
+ ++splitPath
++public static List<String> splitPath(String path)
+-
+
- Converts a path expression into a list of keys, by splitting on period
+ and unquoting the individual path elements. A path expression is usable
+ with a
Config, while individual path elements are usable with a +ConfigObject. ++
-
+
- Parameters:
path- a path expression +- Returns:
- the individual keys in the path +
- Throws: +
ConfigException- if the path expression is invalid
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigValue.html b/v0.6.0/com/typesafe/config/ConfigValue.html new file mode 100644 index 00000000..214e5666 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigValue.html @@ -0,0 +1,461 @@ + + + + + ++ConfigValue + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Interface ConfigValue-
+
- All Superinterfaces:
- ConfigMergeable +
-
+
- All Known Subinterfaces:
- ConfigList, ConfigObject +
+-
+
public interface ConfigValue
- extends ConfigMergeable
+An immutable value, following the JSON type + schema. + +
+ Because this object is immutable, it is safe to use from multiple threads and + there's no need for "defensive copies." + +
+ Do not implement
ConfigValue; it should only be implemented + by the config library. Arbitrary implementations will not work because the + library internals assume a specific concrete implementation. Also, this + interface is likely to grow new methods over time, so third-party + implementations will break. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +ConfigatKey(String key)+ +
+ Places the value inside aConfigat the given key.+ ++ +ConfigatPath(String path)+ +
+ Places the value inside aConfigat the given path.+ ++ +ConfigOriginorigin()+ +
+ The origin of the value (file, line number, etc.), for debugging and + error messages.+ ++ +Stringrender()+ +
+ Renders the config value as a HOCON string.+ ++ +Stringrender(ConfigRenderOptions options)+ +
+ Renders the config value to a string, using the provided options.+ ++ +Objectunwrapped()+ +
+ Returns the value as a plain Java boxed value, that is, aString, +Number,Boolean,Map<String,Object>, +List<Object>, ornull, matching thevalueType()+ of thisConfigValue.+ ++ +ConfigValueTypevalueType()+ +
+ TheConfigValueTypeof the value; matches the JSON type schema.+ ++ +ConfigValuewithFallback(ConfigMergeable other)+ +
+ Returns a new value computed by merging this value with another, with + keys in this value "winning" over the other one.+
+ ++ ++Method Detail ++origin
++ConfigOrigin origin()
+-
+
- The origin of the value (file, line number, etc.), for debugging and
+ error messages.
+
+
-
+
-
+
+
- Returns:
- where the value came from
+ ++valueType
++ConfigValueType valueType()
+-
+
- The
ConfigValueTypeof the value; matches the JSON type schema. ++
-
+
-
+
+
- Returns:
- value's type
+ ++unwrapped
++Object unwrapped()
+-
+
- Returns the value as a plain Java boxed value, that is, a
String, +Number,Boolean,Map<String,Object>, +List<Object>, ornull, matching thevalueType()+ of thisConfigValue. If the value is aConfigObjector +ConfigList, it is recursively unwrapped. ++
-
+
-
+
+ ++render
++String render()
+-
+
- Renders the config value as a HOCON string. This method is primarily
+ intended for debugging, so it tries to add helpful comments and
+ whitespace.
+
+
+ If the config value has not been resolved (see
Config.resolve()), + it's possible that it can't be rendered as valid HOCON. In that case the + rendering should still be useful for debugging but you might not be able + to parse it. + ++ This method is equivalent to +
render(ConfigRenderOptions.defaults()). ++
-
+
-
+
+
- Returns:
- the rendered value
+ ++render
++String render(ConfigRenderOptions options)
+-
+
- Renders the config value to a string, using the provided options.
+
+
+ If the config value has not been resolved (see
Config.resolve()), + it's possible that it can't be rendered as valid HOCON. In that case the + rendering should still be useful for debugging but you might not be able + to parse it. + ++ If the config value has been resolved and the options disable all + HOCON-specific features (such as comments), the rendering will be valid + JSON. If you enable HOCON-only features such as comments, the rendering + will not be valid JSON. +
+
-
+
-
+
- Parameters:
options- the rendering options +- Returns:
- the rendered value
+ ++withFallback
++ConfigValue withFallback(ConfigMergeable other)
+-
+
- Description copied from interface:
ConfigMergeable
+ - Returns a new value computed by merging this value with another, with
+ keys in this value "winning" over the other one. Only
+
ConfigObjectandConfiginstances do anything in this + method (they need to merge the fallback keys into themselves). All other + values just return the original value, since they automatically override + any fallback. + ++ The semantics of merging are described in the spec + for HOCON. + +
+ Note that objects do not merge "across" non-objects; if you write +
object.withFallback(nonObject).withFallback(otherObject), + thenotherObjectwill simply be ignored. This is an + intentional part of how merging works. Both non-objects, and any object + which has fallen back to a non-object, block subsequent fallbacks. ++
-
+
- Specified by:
withFallbackin interfaceConfigMergeable
-
+
- Parameters:
other- an object whose keys should be used if the keys are not + present in this one +- Returns:
- a new object (or the original one, if the fallback doesn't get + used)
+ ++atPath
++Config atPath(String path)
+-
+
- Places the value inside a
Configat the given path. See also + atKey(). ++
-
+
-
+
- Parameters:
path- path to store this value at. +- Returns:
- a
Configinstance containing this value at the given + path.
+ ++atKey
++Config atKey(String key)
+-
+
- Places the value inside a
Configat the given key. See also + atPath(). ++
-
+
-
+
- Parameters:
key- key to store this value at. +- Returns:
- a
Configinstance containing this value at the given key.
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigValueFactory.html b/v0.6.0/com/typesafe/config/ConfigValueFactory.html new file mode 100644 index 00000000..c75e473e --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigValueFactory.html @@ -0,0 +1,400 @@ + + + + + ++ConfigValueFactory + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ ++ +com.typesafe.config +
+
+Class ConfigValueFactory+java.lang.Object +
+com.typesafe.config.ConfigValueFactory
+
+-
+
public final class ConfigValueFactory
- extends Object
+This class holds some static factory methods for building
ConfigValue+ instances. See alsoConfigFactorywhich has methods for parsing files + and certain in-memory data structures. ++ +
+
+ ++
+ ++ ++Method Summary ++ ++ +static ConfigValuefromAnyRef(Object object)+ +
+ See the other overloadfromAnyRef(Object,String)for details, + this one just uses a default origin description.+ ++ +static ConfigValuefromAnyRef(Object object, + String originDescription)+ +
+ Creates a ConfigValue from a plain Java boxed value, which may be a + Boolean, Number, String, Map, Iterable, or null.+ ++ +static ConfigListfromIterable(Iterable<? extends Object> values)+ +
+ See the other overload offromIterable(Iterable, String)for + details, this one just uses a default origin description.+ ++ +static ConfigListfromIterable(Iterable<? extends Object> values, + String originDescription)+ +
+ See the fromAnyRef() documentation for details.+ ++ +static ConfigObjectfromMap(Map<String,? extends Object> values)+ +
+ See the other overloadfromMap(Map,String)for details, this one + just uses a default origin description.+ ++ +static ConfigObjectfromMap(Map<String,? extends Object> values, + String originDescription)+ +
+ See the fromAnyRef() documentation for details.+
+ ++ +Methods inherited from class java.lang.Object ++ +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait+
+ ++ ++Method Detail ++fromAnyRef
++public static ConfigValue fromAnyRef(Object object, + String originDescription)
+-
+
- Creates a ConfigValue from a plain Java boxed value, which may be a
+ Boolean, Number, String, Map, Iterable, or null. A Map must be a Map from
+ String to more values that can be supplied to fromAnyRef(). An Iterable
+ must iterate over more values that can be supplied to fromAnyRef(). A Map
+ will become a ConfigObject and an Iterable will become a ConfigList. If
+ the Iterable is not an ordered collection, results could be strange,
+ since ConfigList is ordered.
+
+
+ In a Map passed to fromAnyRef(), the map's keys are plain keys, not path + expressions. So if your Map has a key "foo.bar" then you will get one + object with a key called "foo.bar", rather than an object with a key + "foo" containing another object with a key "bar". + +
+ The originDescription will be used to set the origin() field on the + ConfigValue. It should normally be the name of the file the values came + from, or something short describing the value such as "default settings". + The originDescription is prefixed to error messages so users can tell + where problematic values are coming from. + +
+ Supplying the result of ConfigValue.unwrapped() to this function is + guaranteed to work and should give you back a ConfigValue that matches + the one you unwrapped. The re-wrapped ConfigValue will lose some + information that was present in the original such as its origin, but it + will have matching values. + +
+ This function throws if you supply a value that cannot be converted to a + ConfigValue, but supplying such a value is a bug in your program, so you + should never handle the exception. Just fix your program (or report a bug + against this library). +
+
-
+
- Parameters:
object- object to convert to ConfigValueoriginDescription- name of origin file or brief description of what the value is +- Returns:
- a new value
+ ++fromMap
++public static ConfigObject fromMap(Map<String,? extends Object> values, + String originDescription)
+-
+
- See the fromAnyRef() documentation for details. This is a typesafe
+ wrapper that only works on
Mapand returns +ConfigObjectrather thanConfigValue. + ++ If your Map has a key "foo.bar" then you will get one object with a key + called "foo.bar", rather than an object with a key "foo" containing + another object with a key "bar". The keys in the map are keys; not path + expressions. That is, the Map corresponds exactly to a single +
ConfigObject. The keys will not be parsed or modified, and the + values are wrapped in ConfigValue. To get nestedConfigObject, + some of the values in the map would have to be more maps. + ++ See also
ConfigFactory.parseMap(Map,String)which interprets the + keys in the map as path expressions. ++
-
+
- Parameters:
values-originDescription- +- Returns:
- a new
ConfigObjectvalue
+ ++fromIterable
++public static ConfigList fromIterable(Iterable<? extends Object> values, + String originDescription)
+-
+
- See the fromAnyRef() documentation for details. This is a typesafe
+ wrapper that only works on
Iterableand returns +ConfigListrather thanConfigValue. ++
-
+
- Parameters:
values-originDescription- +- Returns:
- a new
ConfigListvalue
+ ++fromAnyRef
++public static ConfigValue fromAnyRef(Object object)
+-
+
- See the other overload
fromAnyRef(Object,String)for details, + this one just uses a default origin description. ++
-
+
- Parameters:
object- +- Returns:
- a new
ConfigValue
+ ++fromMap
++public static ConfigObject fromMap(Map<String,? extends Object> values)
+-
+
- See the other overload
fromMap(Map,String)for details, this one + just uses a default origin description. + ++ See also
ConfigFactory.parseMap(Map)which interprets the keys in + the map as path expressions. ++
-
+
- Parameters:
values- +- Returns:
- a new
ConfigObject
+ ++fromIterable
++public static ConfigList fromIterable(Iterable<? extends Object> values)
+-
+
- See the other overload of
fromIterable(Iterable, String)for + details, this one just uses a default origin description. ++
-
+
- Parameters:
values- +- Returns:
- a new
ConfigList
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | FIELD | CONSTR | METHOD ++DETAIL: FIELD | CONSTR | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/ConfigValueType.html b/v0.6.0/com/typesafe/config/ConfigValueType.html new file mode 100644 index 00000000..ef64ec64 --- /dev/null +++ b/v0.6.0/com/typesafe/config/ConfigValueType.html @@ -0,0 +1,387 @@ + + + + + ++ConfigValueType + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD ++DETAIL: ENUM CONSTANTS | FIELD | METHOD +
+ ++ +com.typesafe.config +
+
+Enum ConfigValueType+java.lang.Object +
+java.lang.Enum<ConfigValueType>
+ com.typesafe.config.ConfigValueType
+-
+
- All Implemented Interfaces:
- Serializable, Comparable<ConfigValueType> +
+-
+
public enum ConfigValueType
- extends Enum<ConfigValueType>
+The type of a configuration value (following the JSON type schema). +
+ +
+
+ ++
+ + + + ++ ++Enum Constant Summary ++ +BOOLEAN+ +
++ +LIST+ +
++ +NULL+ +
++ +NUMBER+ +
++ +OBJECT+ +
++ +STRING+ +
++
+ ++ ++Method Summary ++ ++ +static ConfigValueTypevalueOf(String name)+ +
+ Returns the enum constant of this type with the specified name.+ ++ +static ConfigValueType[]values()+ +
+ Returns an array containing the constants of this enum type, in +the order they are declared.+
+ ++ +Methods inherited from class java.lang.Enum ++ +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf+
+ ++ +Methods inherited from class java.lang.Object ++ +getClass, notify, notifyAll, wait, wait, wait+
+ ++ ++Enum Constant Detail ++OBJECT
++public static final ConfigValueType OBJECT
+-
+
-
+
+ ++LIST
++public static final ConfigValueType LIST
+-
+
-
+
+ ++NUMBER
++public static final ConfigValueType NUMBER
+-
+
-
+
+ ++BOOLEAN
++public static final ConfigValueType BOOLEAN
+-
+
-
+
+ ++NULL
++public static final ConfigValueType NULL
+-
+
-
+
+ ++STRING
++public static final ConfigValueType STRING
+-
+
-
+
+
+ ++ ++Method Detail ++values
++public static ConfigValueType[] values()
+-
+
- Returns an array containing the constants of this enum type, in
+the order they are declared. This method may be used to iterate
+over the constants as follows:
+
+for (ConfigValueType c : ConfigValueType.values()) + System.out.println(c); +
++
-
+
+
- Returns:
- an array containing the constants of this enum type, in +the order they are declared
+ ++valueOf
++public static ConfigValueType valueOf(String name)
+-
+
- Returns the enum constant of this type with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this type. (Extraneous whitespace characters are
+not permitted.)
+
+
-
+
- Parameters:
name- the name of the enum constant to be returned. +- Returns:
- the enum constant with the specified name +
- Throws: +
IllegalArgumentException- if this enum type has no constant +with the specified name +NullPointerException- if the argument is null
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV CLASS + NEXT CLASS ++ FRAMES + NO FRAMES + + + + + ++ ++ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD ++DETAIL: ENUM CONSTANTS | FIELD | METHOD +
+ + + diff --git a/v0.6.0/com/typesafe/config/package-frame.html b/v0.6.0/com/typesafe/config/package-frame.html new file mode 100644 index 00000000..f9332159 --- /dev/null +++ b/v0.6.0/com/typesafe/config/package-frame.html @@ -0,0 +1,125 @@ + + + + + ++com.typesafe.config + + + + + + + + + + + +com.typesafe.config ++
+ + ++ ++Interfaces + + +
+Config +
+ConfigIncludeContext +
+ConfigIncluder +
+ConfigIncluderClasspath +
+ConfigIncluderFile +
+ConfigIncluderURL +
+ConfigList +
+ConfigMergeable +
+ConfigObject +
+ConfigOrigin +
+ConfigParseable +
+ConfigValue+
+ + ++ ++Classes + + +
+ConfigException.ValidationProblem +
+ConfigFactory +
+ConfigParseOptions +
+ConfigRenderOptions +
+ConfigResolveOptions +
+ConfigUtil +
+ConfigValueFactory+
+ + ++ ++Enums + + +
+ConfigSyntax +
+ConfigValueType+com.typesafe.config + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV PACKAGE + NEXT PACKAGE ++ FRAMES + NO FRAMES + + + + + +
++Package com.typesafe.config +
+ +An API for loading and using configuration files, see the project site +for more information. ++See: +
+ Description ++ +
+
+ + ++ ++Interface Summary ++ +Config +An immutable map from config paths to config values. ++ +ConfigIncludeContext +Context provided to a +ConfigIncluder; this interface is only useful + inside aConfigIncluderimplementation, and is not intended for apps + to implement.+ +ConfigIncluder +Implement this interface and provide an instance to + +ConfigParseOptions.setIncluder()to + customize handling ofincludestatements in config files.+ +ConfigIncluderClasspath +Implement this in addition to +ConfigIncluderif you want to + support inclusion of files with theinclude classpath("resource")+ syntax.+ +ConfigIncluderFile +Implement this in addition to +ConfigIncluderif you want to + support inclusion of files with theinclude file("filename")syntax.+ +ConfigIncluderURL +Implement this in addition to +ConfigIncluderif you want to + support inclusion of files with theinclude url("http://example.com")+ syntax.+ +ConfigList +Subtype of +ConfigValuerepresenting a list value, as in JSON's +[1,2,3]syntax.+ +ConfigMergeable +Marker for types whose instances can be merged, that is +Configand +ConfigValue.+ +ConfigObject +Subtype of +ConfigValuerepresenting an object (dictionary, map) + value, as in JSON's{ "a" : 42 }syntax.+ +ConfigOrigin +Represents the origin (such as filename and line number) of a + +ConfigValuefor use in error messages.+ +ConfigParseable +An opaque handle to something that can be parsed, obtained from + +ConfigIncludeContext.+ +ConfigValue +An immutable value, following the JSON type + schema. ++ +
+
+ + ++ ++Class Summary ++ +ConfigException.ValidationProblem +Information about a problem that occurred in +Config.checkValid(com.typesafe.config.Config, java.lang.String...).+ +ConfigFactory +Contains static methods for creating +Configinstances.+ +ConfigParseOptions +A set of options related to parsing. ++ +ConfigRenderOptions ++ A set of options related to rendering a +ConfigValue.+ +ConfigResolveOptions +A set of options related to resolving substitutions. ++ +ConfigUtil +Contains static utility methods. ++ +ConfigValueFactory +This class holds some static factory methods for building +ConfigValue+ instances.+ +
+
+ + ++ ++Enum Summary ++ +ConfigSyntax +The syntax of a character stream, JSON, HOCON + aka ".conf", or Java properties. ++ +ConfigValueType +The type of a configuration value (following the JSON type schema). ++ +
+
+ + ++ ++Exception Summary ++ +ConfigException +All exceptions thrown by the library are subclasses of + +ConfigException.+ +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 that +Config.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. ++Package com.typesafe.config Description +
+ ++
+An API for loading and using configuration files, see the project site +for more information. +
+ ++Typically you would load configuration with a static method from
+ +ConfigFactoryand then use +it with methods in theConfiginterface. ++An application can simply call
+ +ConfigFactory.load()and place +its configuration in "application.conf" on the classpath. +If you use the default configuration fromConfigFactory.load()+there's no need to pass a configuration to your libraries +and frameworks, as long as they all default to this same default, which they should. ++A library or framework should ship a file "reference.conf" in its jar, and allow an application to pass in a +
+ +Configto be used for the library. If noConfigis provided, +callConfigFactory.load()+to get the default one. Typically a library might offer two constructors, one with aConfigparameter +and one which usesConfigFactory.load(). ++You can find an example app and library on GitHub. +
++ +
+
-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV PACKAGE + NEXT PACKAGE ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/com/typesafe/config/package-tree.html b/v0.6.0/com/typesafe/config/package-tree.html new file mode 100644 index 00000000..6406d5b1 --- /dev/null +++ b/v0.6.0/com/typesafe/config/package-tree.html @@ -0,0 +1,193 @@ + + + + + ++com.typesafe.config Class Hierarchy + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++ ++Hierarchy For Package com.typesafe.config +
++Class Hierarchy +
+-
+
- java.lang.Object
-
+
- com.typesafe.config.ConfigException.ValidationProblem
- com.typesafe.config.ConfigFactory
- com.typesafe.config.ConfigParseOptions
- com.typesafe.config.ConfigRenderOptions
- com.typesafe.config.ConfigResolveOptions
- com.typesafe.config.ConfigUtil
- com.typesafe.config.ConfigValueFactory
- java.lang.Throwable (implements java.io.Serializable)
+
-
+
- java.lang.Exception
-
+
- java.lang.RuntimeException
-
+
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
-
+
- com.typesafe.config.ConfigException.BadPath
- com.typesafe.config.ConfigException.BadValue
- com.typesafe.config.ConfigException.BugOrBroken
-
+
- com.typesafe.config.ConfigException.NotResolved
- com.typesafe.config.ConfigException.Generic
- com.typesafe.config.ConfigException.IO
- com.typesafe.config.ConfigException.Missing
-
+
- com.typesafe.config.ConfigException.Null
- com.typesafe.config.ConfigException.Parse
-
+
- com.typesafe.config.ConfigException.UnresolvedSubstitution
- com.typesafe.config.ConfigException.ValidationFailed
- com.typesafe.config.ConfigException.WrongType
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
- java.lang.RuntimeException
- java.lang.Exception
+Interface Hierarchy +
+-
+
- com.typesafe.config.ConfigIncludeContext
- com.typesafe.config.ConfigIncluder
- com.typesafe.config.ConfigIncluderClasspath
- com.typesafe.config.ConfigIncluderFile
- com.typesafe.config.ConfigIncluderURL
- com.typesafe.config.ConfigMergeable
-
+
- com.typesafe.config.Config
- com.typesafe.config.ConfigValue
-
+
- com.typesafe.config.ConfigList (also extends java.util.List<E>) +
- com.typesafe.config.ConfigObject (also extends java.util.Map<K,V>) +
- com.typesafe.config.ConfigOrigin
- com.typesafe.config.ConfigParseable
- java.lang.Iterable<T>
-
+
- java.util.Collection<E>
-
+
- java.util.List<E>
-
+
- com.typesafe.config.ConfigList (also extends com.typesafe.config.ConfigValue) +
- java.util.List<E>
- java.util.Collection<E>
- java.util.Map<K,V>
-
+
- com.typesafe.config.ConfigObject (also extends com.typesafe.config.ConfigValue) +
+Enum Hierarchy +
+-
+
- java.lang.Object
-
+
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
+
-
+
- com.typesafe.config.ConfigValueType
- com.typesafe.config.ConfigSyntax
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/constant-values.html b/v0.6.0/constant-values.html new file mode 100644 index 00000000..4abe9dbc --- /dev/null +++ b/v0.6.0/constant-values.html @@ -0,0 +1,142 @@ + + + + + ++Constant Field Values + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++ ++Constant Field Values
+
+Contents-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/deprecated-list.html b/v0.6.0/deprecated-list.html new file mode 100644 index 00000000..d814e0f2 --- /dev/null +++ b/v0.6.0/deprecated-list.html @@ -0,0 +1,142 @@ + + + + + ++Deprecated List + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++ ++Deprecated API
+
+Contents-
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/help-doc.html b/v0.6.0/help-doc.html new file mode 100644 index 00000000..3df610fe --- /dev/null +++ b/v0.6.0/help-doc.html @@ -0,0 +1,209 @@ + + + + + ++API Help + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++ +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.+How This API Document Is Organized
++Package
++ +
++Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
-
+
- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
+Class/Interface
++ +
+ ++Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
-
+
- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description
+
+
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary
+
+
- Field Detail
- Constructor Detail
- Method Detail
+Annotation Type
++ +
+ ++Each annotation type has its own separate page with the following sections:
-
+
- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
+Enum
++ +
++Each enum has its own separate page with the following sections:
-
+
- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
+Tree (Class Hierarchy)
++There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with
+java.lang.Object. The interfaces do not inherit fromjava.lang.Object.-
+
- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+Deprecated API
++The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
++Index
++The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
++Prev/Next
+These links take you to the next or previous class, interface, package, or related page.+Frames/No Frames
+These links show and hide the HTML frames. All pages are available with or without frames. ++
+Serialized Form
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. ++
+Constant Field Values
+The Constant Field Values page lists the static final fields and their values. ++ + +This help file applies to API documentation generated using the standard doclet. + +
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/index-all.html b/v0.6.0/index-all.html new file mode 100644 index 00000000..828774b6 --- /dev/null +++ b/v0.6.0/index-all.html @@ -0,0 +1,965 @@ + + + + + ++Index + + + + + + + + + + + + +
+ + + + + ++
+ + + +A C D E F G H I J L N O P Q R S T U V W+ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++A
+-
+
- appendIncluder(ConfigIncluder) - +Method in class com.typesafe.config.ConfigParseOptions +
- +
- atKey(String) - +Method in interface com.typesafe.config.Config +
- Places the config inside a
Configat the given key. + - atKey(String) - +Method in interface com.typesafe.config.ConfigValue +
- Places the value inside a
Configat the given key. + - atPath(String) - +Method in interface com.typesafe.config.Config +
- Places the config inside another
Configat the given path. + - atPath(String) - +Method in interface com.typesafe.config.ConfigValue +
- Places the value inside a
Configat the given path. +
++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
- +An API for loading and using configuration files, see the project site +for more information.
- comments() - +Method in interface com.typesafe.config.ConfigOrigin +
- Returns any comments that appeared to "go with" this place in the file. +
- 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.
- 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.BadPath - Exception in com.typesafe.config
- Exception indicating that a path expression was invalid.
- ConfigException.BadPath(ConfigOrigin, String, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.BadPath +
- +
- ConfigException.BadPath(ConfigOrigin, String, String) - +Constructor for exception com.typesafe.config.ConfigException.BadPath +
- +
- ConfigException.BadPath(String, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.BadPath +
- +
- ConfigException.BadPath(String, String) - +Constructor for exception com.typesafe.config.ConfigException.BadPath +
- +
- ConfigException.BadPath(ConfigOrigin, String) - +Constructor for exception com.typesafe.config.ConfigException.BadPath +
- +
- 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.BadValue(ConfigOrigin, String, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.BadValue +
- +
- ConfigException.BadValue(ConfigOrigin, String, String) - +Constructor for exception com.typesafe.config.ConfigException.BadValue +
- +
- ConfigException.BadValue(String, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.BadValue +
- +
- ConfigException.BadValue(String, String) - +Constructor for exception com.typesafe.config.ConfigException.BadValue +
- +
- 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.BugOrBroken(String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.BugOrBroken +
- +
- ConfigException.BugOrBroken(String) - +Constructor for exception com.typesafe.config.ConfigException.BugOrBroken +
- +
- ConfigException.Generic - Exception in com.typesafe.config
- Exception that doesn't fall into any other category.
- ConfigException.Generic(String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.Generic +
- +
- ConfigException.Generic(String) - +Constructor for exception com.typesafe.config.ConfigException.Generic +
- +
- ConfigException.IO - Exception in com.typesafe.config
- Exception indicating that there was an IO error.
- ConfigException.IO(ConfigOrigin, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.IO +
- +
- ConfigException.IO(ConfigOrigin, String) - +Constructor for exception com.typesafe.config.ConfigException.IO +
- +
- ConfigException.Missing - Exception in com.typesafe.config
- Exception indicates that the setting was never set to anything, not even + null.
- ConfigException.Missing(String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.Missing +
- +
- ConfigException.Missing(String) - +Constructor for exception com.typesafe.config.ConfigException.Missing +
- +
- ConfigException.Missing(ConfigOrigin, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.Missing +
- +
- ConfigException.Missing(ConfigOrigin, String) - +Constructor for exception com.typesafe.config.ConfigException.Missing +
- +
- 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.NotResolved(String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.NotResolved +
- +
- ConfigException.NotResolved(String) - +Constructor for exception com.typesafe.config.ConfigException.NotResolved +
- +
- ConfigException.Null - Exception in com.typesafe.config
- Exception indicates that the setting was treated as missing because it + was set to null.
- ConfigException.Null(ConfigOrigin, String, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.Null +
- +
- ConfigException.Null(ConfigOrigin, String, String) - +Constructor for exception com.typesafe.config.ConfigException.Null +
- +
- ConfigException.Parse - Exception in com.typesafe.config
- Exception indicating that there was a parse error.
- ConfigException.Parse(ConfigOrigin, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.Parse +
- +
- ConfigException.Parse(ConfigOrigin, String) - +Constructor for exception com.typesafe.config.ConfigException.Parse +
- +
- ConfigException.UnresolvedSubstitution - Exception in com.typesafe.config
- Exception indicating that a substitution did not resolve to anything.
- ConfigException.UnresolvedSubstitution(ConfigOrigin, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.UnresolvedSubstitution +
- +
- ConfigException.UnresolvedSubstitution(ConfigOrigin, String) - +Constructor for exception com.typesafe.config.ConfigException.UnresolvedSubstitution +
- +
- ConfigException.ValidationFailed - Exception in com.typesafe.config
- Exception indicating that
Config.checkValid(com.typesafe.config.Config, java.lang.String...)found validity + problems. - ConfigException.ValidationFailed(Iterable<ConfigException.ValidationProblem>) - +Constructor for exception com.typesafe.config.ConfigException.ValidationFailed +
- +
- ConfigException.ValidationProblem - Class in com.typesafe.config
- Information about a problem that occurred in
Config.checkValid(com.typesafe.config.Config, java.lang.String...). - ConfigException.ValidationProblem(String, ConfigOrigin, String) - +Constructor for class com.typesafe.config.ConfigException.ValidationProblem +
- +
- ConfigException.WrongType - Exception in com.typesafe.config
- Exception indicating that the type of a value does not match the type you + requested.
- ConfigException.WrongType(ConfigOrigin, String, String, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.WrongType +
- +
- ConfigException.WrongType(ConfigOrigin, String, String, String) - +Constructor for exception com.typesafe.config.ConfigException.WrongType +
- +
- ConfigException.WrongType(ConfigOrigin, String, Throwable) - +Constructor for exception com.typesafe.config.ConfigException.WrongType +
- +
- ConfigException.WrongType(ConfigOrigin, String) - +Constructor for exception com.typesafe.config.ConfigException.WrongType +
- +
- ConfigFactory - Class in com.typesafe.config
- Contains static methods for creating
Configinstances. - ConfigIncludeContext - Interface in com.typesafe.config
- Context provided to a
ConfigIncluder; this interface is only useful + inside aConfigIncluderimplementation, 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 ofincludestatements in config files. - ConfigIncluderClasspath - Interface in com.typesafe.config
- Implement this in addition to
ConfigIncluderif you want to + support inclusion of files with theinclude classpath("resource")+ syntax. - ConfigIncluderFile - Interface in com.typesafe.config
- Implement this in addition to
ConfigIncluderif you want to + support inclusion of files with theinclude file("filename")syntax. - ConfigIncluderURL - Interface in com.typesafe.config
- Implement this in addition to
ConfigIncluderif you want to + support inclusion of files with theinclude url("http://example.com")+ syntax. - ConfigList - Interface in com.typesafe.config
- Subtype of
ConfigValuerepresenting a list value, as in JSON's +[1,2,3]syntax. - ConfigMergeable - Interface in com.typesafe.config
- Marker for types whose instances can be merged, that is
Configand +ConfigValue. - ConfigObject - Interface in com.typesafe.config
- Subtype of
ConfigValuerepresenting an object (dictionary, map) + value, as in JSON's{ "a" : 42 }syntax. - ConfigOrigin - Interface in com.typesafe.config
- Represents the origin (such as filename and line number) of a
+
ConfigValuefor use in error messages. - 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
- The syntax of a character stream, JSON, HOCON + aka ".conf", or Java properties.
- 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).
++D
+-
+
- 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. + - defaults() - +Static method in class com.typesafe.config.ConfigParseOptions +
- +
- 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
+
ConfigOriginfor thisConfig. + - 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. +
++F
+-
+
- filename() - +Method in interface com.typesafe.config.ConfigOrigin +
- Returns a filename describing the origin. +
- fromAnyRef(Object, String) - +Static method in class com.typesafe.config.ConfigValueFactory +
- Creates a ConfigValue from a plain Java boxed value, which may be a + Boolean, Number, String, Map, Iterable, or null. +
- 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. + - fromIterable(Iterable<? extends Object>, String) - +Static method in class com.typesafe.config.ConfigValueFactory +
- See the fromAnyRef() documentation for details. +
- 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. + - fromMap(Map<String, ? extends Object>, String) - +Static method in class com.typesafe.config.ConfigValueFactory +
- See the fromAnyRef() 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. +
++G
+-
+
- get(Object) - +Method in interface com.typesafe.config.ConfigObject +
- Gets a
ConfigValueat the given key, or returns null if there is + no value. + - getAllowMissing() - +Method in class com.typesafe.config.ConfigParseOptions +
- +
- 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 +
- +
- getBoolean(String) - +Method in interface com.typesafe.config.Config +
- +
- getBooleanList(String) - +Method in interface com.typesafe.config.Config +
- +
- 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 +
- +
- 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 +
- +
- getDouble(String) - +Method in interface com.typesafe.config.Config +
- +
- getDoubleList(String) - +Method in interface com.typesafe.config.Config +
- +
- getFormatted() - +Method in class com.typesafe.config.ConfigRenderOptions +
- Returns whether the options enable formatting. +
- getIncluder() - +Method in class com.typesafe.config.ConfigParseOptions +
- +
- getInt(String) - +Method in interface com.typesafe.config.Config +
- +
- getIntList(String) - +Method in interface com.typesafe.config.Config +
- +
- 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 +
- +
- getLongList(String) - +Method in interface com.typesafe.config.Config +
- +
- getMilliseconds(String) - +Method in interface com.typesafe.config.Config +
- Get value as a duration in milliseconds. +
- getMillisecondsList(String) - +Method in interface com.typesafe.config.Config +
- +
- getNanoseconds(String) - +Method in interface com.typesafe.config.Config +
- Get value as a duration in nanoseconds. +
- 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 +
- +
- getObject(String) - +Method in interface com.typesafe.config.Config +
- +
- getObjectList(String) - +Method in interface com.typesafe.config.Config +
- +
- getOriginComments() - +Method in class com.typesafe.config.ConfigRenderOptions +
- Returns whether the options enable automated origin comments. +
- getOriginDescription() - +Method in class com.typesafe.config.ConfigParseOptions +
- +
- getString(String) - +Method in interface com.typesafe.config.Config +
- +
- getStringList(String) - +Method in interface com.typesafe.config.Config +
- +
- getSyntax() - +Method in class com.typesafe.config.ConfigParseOptions +
- +
- 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
+-
+
- hasPath(String) - +Method in interface com.typesafe.config.Config +
- Checks whether a value is present and non-null at the given path. +
++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. +
- isEmpty() - +Method in interface com.typesafe.config.Config +
- Returns true if the
Config's root object contains no key-value + pairs. +
++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(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. +
++L
+-
+
- lineNumber() - +Method in interface com.typesafe.config.ConfigOrigin +
- Returns a line number where the value or exception originated. +
- 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(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(String, ConfigParseOptions, ConfigResolveOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- Like
ConfigFactory.load(String)but allows you to specify parse and resolve + options. + - 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 the +ConfigParseOptions. + - 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(ClassLoader, Config) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- load(Config, ConfigResolveOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- Like
ConfigFactory.load(Config)but allows you to specify +ConfigResolveOptions. + - 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() - +Static method in class com.typesafe.config.ConfigFactory +
- Loads a default configuration, equivalent to
load("application")in most cases. + - load(ConfigParseOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- Like
ConfigFactory.load()but allows specifying parse options + - 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, 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 parse options + - 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 resolve 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 +
++N
+-
+
- noSystem() - +Static method in class com.typesafe.config.ConfigResolveOptions +
- Returns resolve options that disable any reference to "system" data + (currently, this means environment variables). +
++O
+-
+
- options() - +Method in interface com.typesafe.config.ConfigParseable +
- Get the initial options, which can be modified then passed to parse(). +
- 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
ConfigOrigindescribing 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. +
++P
+-
+
- parse(ConfigParseOptions) - +Method in interface com.typesafe.config.ConfigParseable +
- Parse whatever it is. +
- parseFile(File, ConfigParseOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- parseFile(File) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- 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 +
- +
- parseMap(Map<String, ? extends Object>, String) - +Static method in class com.typesafe.config.ConfigFactory +
- Creates a
Configbased on aMapfrom paths to + plain Java values. + - 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. + - parseOptions() - +Method in interface com.typesafe.config.ConfigIncludeContext +
- Parse options to use (if you use another method to get a
+
ConfigParseablethen useConfigParseable.options()+ instead though). + - parseProperties(Properties, ConfigParseOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- Converts a Java
Propertiesobject to a +ConfigObjectusing the rules documented in the HOCON + spec. + - parseProperties(Properties) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- parseReader(Reader, ConfigParseOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- parseReader(Reader) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- 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 +
- Like
ConfigFactory.parseResources(ClassLoader,String,ConfigParseOptions)but + uses thread's current context class loader. + - parseResources(String) - +Static method in class com.typesafe.config.ConfigFactory +
- Like
ConfigFactory.parseResources(ClassLoader,String)but uses thread's + current context class loader. + - 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 +
- Like
+
ConfigFactory.parseResourcesAnySyntax(ClassLoader,String,ConfigParseOptions)+ but uses thread's current context class loader. + - parseResourcesAnySyntax(String) - +Static method in class com.typesafe.config.ConfigFactory +
- Like
ConfigFactory.parseResourcesAnySyntax(ClassLoader,String)but uses + thread's current context class loader. + - parseString(String, ConfigParseOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- parseString(String) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- parseURL(URL, ConfigParseOptions) - +Static method in class com.typesafe.config.ConfigFactory +
- +
- 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. +
- 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 +
- +
++Q
+-
+
- quoteString(String) - +Static method in class com.typesafe.config.ConfigUtil +
- Quotes and escapes a string, as in the JSON specification. +
++R
+-
+
- 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. +
- render() - +Method in interface com.typesafe.config.ConfigValue +
- Renders the config value as a HOCON string. +
- render(ConfigRenderOptions) - +Method in interface com.typesafe.config.ConfigValue +
- Renders the config value to a string, using the provided options. +
- 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. + - 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
Configas 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. +
- 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. +
- 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. +
- systemEnvironment() - +Static method in class com.typesafe.config.ConfigFactory +
- Gets a
Configcontaining the system's environment variables. + - systemProperties() - +Static method in class com.typesafe.config.ConfigFactory +
- Gets a
Configcontaining the system properties from +System.getProperties(), parsed and converted as with +ConfigFactory.parseProperties(java.util.Properties, com.typesafe.config.ConfigParseOptions). +
++T
+-
+
- toConfig() - +Method in interface com.typesafe.config.ConfigObject +
- Converts this object to a
Configinstance, enabling you to use + path expressions to find values in the object. + - toString() - +Method in class com.typesafe.config.ConfigRenderOptions +
- +
++U
+-
+
- 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
+-
+
- 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
ConfigValueTypeof the value; matches the JSON type schema. +
++W
+-
+
- 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(ConfigMergeable) - +Method in interface com.typesafe.config.ConfigValue +
- +
- 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. +
- 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. +
- withValue(String, ConfigValue) - +Method in interface com.typesafe.config.Config +
- Returns a
Configbased 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
ConfigObjectbased on this one, but with the given key + set to the given value. +
+A C D E F G H I J L N O P Q R S T U V W + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/index.html b/v0.6.0/index.html new file mode 100644 index 00000000..0e4ab501 --- /dev/null +++ b/v0.6.0/index.html @@ -0,0 +1,36 @@ + + + + + ++Generated Documentation (Untitled) + + + + + + diff --git a/v0.6.0/overview-tree.html b/v0.6.0/overview-tree.html new file mode 100644 index 00000000..3dffb071 --- /dev/null +++ b/v0.6.0/overview-tree.html @@ -0,0 +1,197 @@ + + + + + ++Class Hierarchy + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++ ++Hierarchy For All Packages
+-
+
- Package Hierarchies:
- com.typesafe.config
++Class Hierarchy +
+-
+
- java.lang.Object
-
+
- com.typesafe.config.ConfigException.ValidationProblem
- com.typesafe.config.ConfigFactory
- com.typesafe.config.ConfigParseOptions
- com.typesafe.config.ConfigRenderOptions
- com.typesafe.config.ConfigResolveOptions
- com.typesafe.config.ConfigUtil
- com.typesafe.config.ConfigValueFactory
- java.lang.Throwable (implements java.io.Serializable)
+
-
+
- java.lang.Exception
-
+
- java.lang.RuntimeException
-
+
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
-
+
- com.typesafe.config.ConfigException.BadPath
- com.typesafe.config.ConfigException.BadValue
- com.typesafe.config.ConfigException.BugOrBroken
-
+
- com.typesafe.config.ConfigException.NotResolved
- com.typesafe.config.ConfigException.Generic
- com.typesafe.config.ConfigException.IO
- com.typesafe.config.ConfigException.Missing
-
+
- com.typesafe.config.ConfigException.Null
- com.typesafe.config.ConfigException.Parse
-
+
- com.typesafe.config.ConfigException.UnresolvedSubstitution
- com.typesafe.config.ConfigException.ValidationFailed
- com.typesafe.config.ConfigException.WrongType
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
- java.lang.RuntimeException
- java.lang.Exception
+Interface Hierarchy +
+-
+
- com.typesafe.config.ConfigIncludeContext
- com.typesafe.config.ConfigIncluder
- com.typesafe.config.ConfigIncluderClasspath
- com.typesafe.config.ConfigIncluderFile
- com.typesafe.config.ConfigIncluderURL
- com.typesafe.config.ConfigMergeable
-
+
- com.typesafe.config.Config
- com.typesafe.config.ConfigList (also extends com.typesafe.config.ConfigValue, java.util.List<E>) +
- com.typesafe.config.ConfigObject (also extends com.typesafe.config.ConfigValue, java.util.Map<K,V>) +
- com.typesafe.config.ConfigValue
-
+
- com.typesafe.config.ConfigList (also extends java.util.List<E>) +
- com.typesafe.config.ConfigObject (also extends java.util.Map<K,V>) +
- com.typesafe.config.ConfigOrigin
- com.typesafe.config.ConfigParseable
- java.lang.Iterable<T>
-
+
- java.util.Collection<E>
-
+
- java.util.List<E>
-
+
- com.typesafe.config.ConfigList (also extends com.typesafe.config.ConfigValue) +
- java.util.List<E>
- java.util.Collection<E>
- java.util.Map<K,V>
-
+
- com.typesafe.config.ConfigObject (also extends com.typesafe.config.ConfigValue) +
+Enum Hierarchy +
+-
+
- java.lang.Object
-
+
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
+
-
+
- com.typesafe.config.ConfigValueType
- com.typesafe.config.ConfigSyntax
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/package-list b/v0.6.0/package-list new file mode 100644 index 00000000..5cb8bfdd --- /dev/null +++ b/v0.6.0/package-list @@ -0,0 +1 @@ +com.typesafe.config diff --git a/v0.6.0/resources/inherit.gif b/v0.6.0/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/v0.6.0/resources/inherit.gif differ diff --git a/v0.6.0/serialized-form.html b/v0.6.0/serialized-form.html new file mode 100644 index 00000000..d8461acb --- /dev/null +++ b/v0.6.0/serialized-form.html @@ -0,0 +1,382 @@ + + + + + ++Serialized Form + + + + + + + + + + + + +
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
++ ++Serialized Form
+
+ ++
+ ++ ++Package com.typesafe.config ++
+ ++ ++Class com.typesafe.config.ConfigException extends RuntimeException implements Serializable ++serialVersionUID: 1L + +
+
+ ++ ++Serialization Methods ++readObject
++private void readObject(ObjectInputStream in) + throws IOException, + ClassNotFoundException
+-
+
-
+
+
- Throws: +
IOException+ClassNotFoundException
++writeObject
++private void writeObject(ObjectOutputStream out) + throws IOException
+-
+
-
+
+
- Throws: +
IOException
+
+
+ ++ ++Class com.typesafe.config.ConfigException.BadPath extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.BadValue extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.BugOrBroken extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.Generic extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.IO extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.Missing extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.NotResolved extends ConfigException.BugOrBroken implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.Null extends ConfigException.Missing implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.Parse extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.UnresolvedSubstitution extends ConfigException.Parse implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ ++ ++Class com.typesafe.config.ConfigException.ValidationFailed extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+
+ ++ ++Serialized Fields ++problems
++Iterable<T> problems
+-
+
-
+
+
+ ++ ++Class com.typesafe.config.ConfigException.WrongType extends ConfigException implements Serializable ++serialVersionUID: 1L + +
+ +
+
+ + + + + ++
+ + + ++ + ++ + ++
++ +Package +Class +Tree +Deprecated +Index +Help ++ + ++ ++ PREV + NEXT ++ FRAMES + NO FRAMES + + + + + +
+ + + diff --git a/v0.6.0/stylesheet.css b/v0.6.0/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/v0.6.0/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
- com.typesafe.config.ConfigException
- java.lang.RuntimeException
- java.lang.Exception
Constant Field Values - + diff --git a/latest/api/deprecated-list.html b/latest/api/deprecated-list.html index 058b2971..d814e0f2 100644 --- a/latest/api/deprecated-list.html +++ b/latest/api/deprecated-list.html @@ -2,12 +2,12 @@ - +Deprecated List - + diff --git a/latest/api/help-doc.html b/latest/api/help-doc.html index 13b9d747..3df610fe 100644 --- a/latest/api/help-doc.html +++ b/latest/api/help-doc.html @@ -2,12 +2,12 @@ - +API Help - + diff --git a/latest/api/index-all.html b/latest/api/index-all.html index 678e7503..828774b6 100644 --- a/latest/api/index-all.html +++ b/latest/api/index-all.html @@ -2,12 +2,12 @@ - +Index - + @@ -400,6 +400,9 @@ Method in interface com.typesafe.config.getIntList(String) - Method in interface com.typesafe.config.Config
- com.typesafe.config.ConfigException (implements java.io.Serializable)
+
- com.typesafe.config.ConfigException
- java.lang.RuntimeException