|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.typesafe.config.ConfigValueFactory
public final class ConfigValueFactory
This class holds some static factory methods for building ConfigValue
instances. See also ConfigFactory
which has methods for parsing files
and certain in-memory data structures.
Method Summary | |
---|---|
static ConfigValue |
fromAnyRef(java.lang.Object object)
See the other overload fromAnyRef(Object,String) for details,
this one just uses a default origin description. |
static ConfigValue |
fromAnyRef(java.lang.Object object,
java.lang.String originDescription)
Creates a ConfigValue from a plain Java boxed value, which may be a Boolean, Number, String, Map, Iterable, or null. |
static ConfigList |
fromIterable(java.lang.Iterable<? extends java.lang.Object> values)
See the other overload of fromIterable(Iterable, String) for
details, this one just uses a default origin description. |
static ConfigList |
fromIterable(java.lang.Iterable<? extends java.lang.Object> values,
java.lang.String originDescription)
See the fromAnyRef() documentation for details. |
static ConfigObject |
fromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values)
See the other overload fromMap(Map,String) for details, this one
just uses a default origin description. |
static ConfigObject |
fromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values,
java.lang.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 |
---|
public static ConfigValue fromAnyRef(java.lang.Object object, java.lang.String originDescription)
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).
object
- object to convert to ConfigValueoriginDescription
- name of origin file or brief description of what the value is
public static ConfigObject fromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values, java.lang.String originDescription)
Map
and returns
ConfigObject
rather than ConfigValue
.
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 nested ConfigObject
,
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.
values
- originDescription
-
ConfigObject
valuepublic static ConfigList fromIterable(java.lang.Iterable<? extends java.lang.Object> values, java.lang.String originDescription)
Iterable
and returns
ConfigList
rather than ConfigValue
.
values
- originDescription
-
ConfigList
valuepublic static ConfigValue fromAnyRef(java.lang.Object object)
fromAnyRef(Object,String)
for details,
this one just uses a default origin description.
object
-
ConfigValue
public static ConfigObject fromMap(java.util.Map<java.lang.String,? extends java.lang.Object> values)
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.
values
-
ConfigObject
public static ConfigList fromIterable(java.lang.Iterable<? extends java.lang.Object> values)
fromIterable(Iterable, String)
for
details, this one just uses a default origin description.
values
-
ConfigList
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |