Object/Class

org.ekrich.config

ConfigValueFactory

Related Docs: class ConfigValueFactory | package config

Permalink

object 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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigValueFactory
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def fromAnyRef(obj: AnyRef): ConfigValue

    Permalink

    See the other overload fromAnyRef(Object,String) for details, this one just uses a default origin description.

    See the other overload fromAnyRef(Object,String) for details, this one just uses a default origin description.

    returns

    a new ConfigValue

  10. def fromAnyRef(obj: AnyRef, originDescription: String): ConfigValue

    Permalink

    Creates a ConfigValue from a plain Java boxed value, which may be a Boolean, Number, String, Map, Iterable, or null.

    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.

    If you pass in a ConfigValue to this function, it will be returned unmodified. (The originDescription will be ignored in this case.)

    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).

    originDescription

    name of origin file or brief description of what the value is

    returns

    a new value

  11. def fromIterable(values: Iterable[_]): ConfigList

    Permalink

    See the other overload of fromIterable(jl.Iterable, String) for details, this one just uses a default origin description.

    See the other overload of fromIterable(jl.Iterable, String) for details, this one just uses a default origin description.

    values

    list of plain Java values

    returns

    a new ConfigList

  12. def fromIterable(values: Iterable[_], originDescription: String): ConfigList

    Permalink

    See the fromAnyRef(Object,String) documentation for details.

    See the fromAnyRef(Object,String) documentation for details. This is a typesafe wrapper that only works on java.lang.Iterable and returns ConfigList rather than ConfigValue.

    values

    list of plain Java values

    originDescription

    description to use in ConfigOrigin of created values

    returns

    a new ConfigList value

  13. def fromMap(values: Map[String, _]): ConfigObject

    Permalink

    See the other overload fromMap(Map,String) for details, this one just uses a default origin description.

    See the other overload fromMap(Map,String) for details, this one just uses a default origin description.

    See also ConfigFactory.parseMap(ju.Map) which interprets the keys in the map as path expressions.

    values

    map from keys to plain Java values

    returns

    a new ConfigObject

  14. def fromMap(values: Map[String, _], originDescription: String): ConfigObject

    Permalink

    See the fromAnyRef(Object,String) documentation for details.

    See the fromAnyRef(Object,String) documentation for details. This is a typesafe wrapper that only works on java.util.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

    map from keys to plain Java values

    originDescription

    description to use in ConfigOrigin of created values

    returns

    a new ConfigObject value

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped