final class SimpleConfigObject extends AbstractConfigObject with Serializable

Annotations
@SerialVersionUID()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SimpleConfigObject
  2. Serializable
  3. AbstractConfigObject
  4. Container
  5. ConfigObject
  6. Map
  7. AbstractConfigValue
  8. MergeableValue
  9. ConfigValue
  10. ConfigMergeable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SimpleConfigObject(_origin: ConfigOrigin, value: Map[String, AbstractConfigValue])
  2. new SimpleConfigObject(_origin: ConfigOrigin, value: Map[String, AbstractConfigValue], status: ResolveStatus, ignoresFallbacks: Boolean)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val _origin: ConfigOrigin
    Definition Classes
    AbstractConfigValue
  5. def appendHiddenEnvVariableValue(sb: StringBuilder): Unit
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def atKey(key: String): SimpleConfig

    Places the value inside a Config at the given key.

    Places the value inside a Config at the given key. See also ConfigValue#atPath.

    key

    key to store this value at.

    returns

    a Config instance containing this value at the given key.

    Definition Classes
    AbstractConfigValue → ConfigValue
  8. def atPath(pathExpression: String): SimpleConfig

    Places the value inside a Config at the given path.

    Places the value inside a Config at the given path. See also ConfigValue#atKey.

    returns

    a Config instance containing this value at the given path.

    Definition Classes
    AbstractConfigValue → ConfigValue
  9. def attemptPeekWithPartialResolve(key: String): AbstractConfigValue

    Look up the key on an only-partially-resolved object, with no transformation or type conversion of any kind; if 'this' is not resolved then try to look up the key anyway if possible.

    Look up the key on an only-partially-resolved object, with no transformation or type conversion of any kind; if 'this' is not resolved then try to look up the key anyway if possible.

    key

    key to look up

    returns

    the value of the key, or null if known not to exist

    Definition Classes
    SimpleConfigObject → AbstractConfigObject
    Exceptions thrown

    ConfigException.NotResolved if can't figure out key's value (or existence) without more resolving

  10. def canEqual(other: Any): Boolean
  11. def clear(): Unit
    Definition Classes
    AbstractConfigObject → Map
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  13. def compute(arg0: String, arg1: BiFunction[_ >: String <: AnyRef, _ >: ConfigValue <: AnyRef, _ <: ConfigValue]): ConfigValue
    Definition Classes
    Map
  14. def computeIfAbsent(arg0: String, arg1: Function[_ >: String <: AnyRef, _ <: ConfigValue]): ConfigValue
    Definition Classes
    Map
  15. def computeIfPresent(arg0: String, arg1: BiFunction[_ >: String <: AnyRef, _ >: ConfigValue <: AnyRef, _ <: ConfigValue]): ConfigValue
    Definition Classes
    Map
  16. def constructDelayedMerge(origin: ConfigOrigin, stack: List[AbstractConfigValue]): AbstractConfigObject
  17. def containsKey(key: Any): Boolean
    Definition Classes
    SimpleConfigObject → Map
  18. def containsValue(v: Any): Boolean
    Definition Classes
    SimpleConfigObject → Map
  19. def entrySet(): Set[Entry[String, ConfigValue]]
    Definition Classes
    SimpleConfigObject → Map
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(other: Any): Boolean
    Definition Classes
    SimpleConfigObject → Map → AbstractConfigValue → AnyRef → Any
  22. def forEach(arg0: BiConsumer[_ >: String <: AnyRef, _ >: ConfigValue <: AnyRef]): Unit
    Definition Classes
    Map
  23. def get(key: Any): AbstractConfigValue

    Gets a ConfigValue at the given key, or returns null if there is no value.

    Gets a ConfigValue at the given key, or returns null if there is no value. The returned ConfigValue may have ConfigValueType#NULL or any other type, and the passed-in key must be a key in this object (rather than a path expression).

    key

    key to look up

    returns

    the value at the key or null if none

    Definition Classes
    SimpleConfigObject → AbstractConfigObject → ConfigObject → Map
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  25. def getOrDefault(arg0: AnyRef, arg1: ConfigValue): ConfigValue
    Definition Classes
    Map
  26. def hasDescendant(descendant: AbstractConfigValue): Boolean

    Super-expensive full traversal to see if descendant is anywhere underneath this container.

    Super-expensive full traversal to see if descendant is anywhere underneath this container.

    Definition Classes
    SimpleConfigObject → Container
  27. def hashCode(): Int
    Definition Classes
    SimpleConfigObject → Map → AbstractConfigValue → AnyRef → Any
  28. def hideEnvVariableValue(options: ConfigRenderOptions): Boolean
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  29. val ignoresFallbacks: Boolean
  30. def isEmpty(): Boolean
    Definition Classes
    SimpleConfigObject → Map
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def keySet(): Set[String]
    Definition Classes
    SimpleConfigObject → Map
  33. def merge(arg0: String, arg1: ConfigValue, arg2: BiFunction[_ >: ConfigValue <: AnyRef, _ >: ConfigValue <: AnyRef, _ <: ConfigValue]): ConfigValue
    Definition Classes
    Map
  34. def mergedWithNonObject(fallback: AbstractConfigValue): AbstractConfigValue
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  35. final def mergedWithNonObject(stack: Collection[AbstractConfigValue], fallback: AbstractConfigValue): AbstractConfigValue
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  36. def mergedWithObject(abstractFallback: AbstractConfigObject): SimpleConfigObject
  37. final def mergedWithObject(stack: Collection[AbstractConfigValue], fallback: AbstractConfigObject): AbstractConfigValue
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  38. def mergedWithTheUnmergeable(fallback: Unmergeable): AbstractConfigValue
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  39. final def mergedWithTheUnmergeable(stack: Collection[AbstractConfigValue], fallback: Unmergeable): AbstractConfigValue
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def newCopy(newStatus: ResolveStatus, newOrigin: ConfigOrigin): SimpleConfigObject
  42. def newCopy(origin: ConfigOrigin): AbstractConfigObject
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  45. def origin: SimpleConfigOrigin

    The origin of the value (file, line number, etc.), for debugging and error messages.

    The origin of the value (file, line number, etc.), for debugging and error messages.

    returns

    where the value came from

    Definition Classes
    AbstractConfigValue → ConfigValue
  46. def put(arg0: String, arg1: ConfigValue): ConfigValue
    Definition Classes
    AbstractConfigObject → Map
  47. def putAll(arg0: Map[_ <: String, _ <: ConfigValue]): Unit
    Definition Classes
    AbstractConfigObject → Map
  48. def putIfAbsent(arg0: String, arg1: ConfigValue): ConfigValue
    Definition Classes
    Map
  49. def relativized(prefix: Path): SimpleConfigObject

    This is used when including one file in another; the included file is relativized to the path it's included into in the parent file.

    This is used when including one file in another; the included file is relativized to the path it's included into in the parent file. The point is that if you include a file at foo.bar in the parent, and the included file as a substitution ${a.b.c}, the included substitution now needs to be ${foo.bar.a.b.c} because we resolve substitutions globally only after parsing everything.

    returns

    value relativized to the given path or the same value if nothing to do

    Definition Classes
    SimpleConfigObject → AbstractConfigObject → AbstractConfigValue
  50. def remove(arg0: Any): ConfigValue
    Definition Classes
    AbstractConfigObject → Map
  51. def remove(arg0: AnyRef, arg1: AnyRef): Boolean
    Definition Classes
    Map
  52. final def render(options: ConfigRenderOptions): String

    Renders the config value to a string, using the provided 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 value has been resolved, it will always be parseable.

    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.

    options

    the rendering options

    returns

    the rendered value

    Definition Classes
    AbstractConfigValue → ConfigValue
  53. final def render: String

    Renders the config value as a HOCON string.

    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. If the value has been resolved, it will always be parseable.

    This method is equivalent to render(ConfigRenderOptions.defaults()).

    returns

    the rendered value

    Definition Classes
    AbstractConfigValue → ConfigValue
  54. def renderValue(sb: StringBuilder, indentVal: Int, atRoot: Boolean, options: ConfigRenderOptions): Unit
  55. def replace(arg0: String, arg1: ConfigValue): ConfigValue
    Definition Classes
    Map
  56. def replace(arg0: String, arg1: ConfigValue, arg2: ConfigValue): Boolean
    Definition Classes
    Map
  57. def replaceAll(arg0: BiFunction[_ >: String <: AnyRef, _ >: ConfigValue <: AnyRef, _ <: ConfigValue]): Unit
    Definition Classes
    Map
  58. def replaceChild(child: AbstractConfigValue, replacement: AbstractConfigValue): SimpleConfigObject

    Replace a child of this value.

    Replace a child of this value. CAUTION if replacement is null, delete the child, which may also delete the parent, or make the parent into a non-container.

    Definition Classes
    SimpleConfigObject → Container
  59. final def requireNotIgnoringFallbacks(): Unit
    Attributes
    protected
    Definition Classes
    AbstractConfigValue
  60. def resolveStatus: ResolveStatus
  61. def resolveSubstitutions(context: ResolveContext, source: ResolveSource): ResolveResult[_ <: AbstractConfigObject]

    Called only by ResolveContext.resolve().

    Called only by ResolveContext.resolve().

    context

    state of the current resolve

    source

    where to look up values

    returns

    a new value if there were changes, or this if no changes

    Definition Classes
    SimpleConfigObject → AbstractConfigObject → AbstractConfigValue
    Annotations
    @throws("")
  62. def size(): Int
    Definition Classes
    SimpleConfigObject → Map
  63. val status: ResolveStatus
  64. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  65. def toConfig: SimpleConfig

    Converts this object to a Config instance, enabling you to use path expressions to find values in the object.

    Converts this object to a Config instance, 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 Config with this object as its root

    Definition Classes
    AbstractConfigObject → ConfigObject
  66. def toFallbackValue: AbstractConfigObject
  67. def toString(): String
    Definition Classes
    AbstractConfigValue → AnyRef → Any
  68. def unwrapped: Map[String, AnyRef]

    Recursively unwraps the object, returning a map from String to whatever plain Java values are unwrapped from the object's values.

    Recursively unwraps the object, returning a map from String to whatever plain Java values are unwrapped from the object's values.

    returns

    a java.util.Map containing plain Java objects

    Definition Classes
    SimpleConfigObject → ConfigObject → ConfigValue
  69. val value: Map[String, AbstractConfigValue]
  70. def valueType: ConfigValueType

    The ConfigValueType of the value; matches the JSON type schema.

    The ConfigValueType of the value; matches the JSON type schema.

    returns

    value's type

    Definition Classes
    AbstractConfigObject → ConfigValue
  71. def values(): Collection[ConfigValue]
    Definition Classes
    SimpleConfigObject → Map
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. def withFallback(mergeable: ConfigMergeable): AbstractConfigObject

    Returns a new value computed by merging this value with another, with keys in this value "winning" over the other one.

    Returns a new value computed by merging this value with another, with keys in this value "winning" over the other one.

    This associative operation may be used to combine configurations from multiple sources (such as multiple configuration files).

    The semantics of merging are described in the spec for HOCON. Merging typically occurs when either the same object is created twice in the same file, or two config files are both loaded. For example:

    foo = { a: 42 }
    foo = { b: 43 }

    Here, the two objects are merged as if you had written:

    foo = { a: 42, b: 43 }

    Only ConfigObject and Config instances 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. This means that objects do not merge "across" non-objects; if you write object.withFallback(nonObject).withFallback(otherObject), then otherObject will simply be ignored. This is an intentional part of how merging works, because non-objects such as strings and integers replace (rather than merging with) any prior value:

    foo = { a: 42 }
    foo = 10

    Here, the number 10 "wins" and the value of foo would be simply 10. Again, for details see the spec.

    returns

    a new object (or the original one, if the fallback doesn't get used)

    Definition Classes
    AbstractConfigObject → ConfigObject → AbstractConfigValue → ConfigValue → ConfigMergeable
  76. def withFallbacksIgnored(): SimpleConfigObject
  77. def withOnlyKey(key: String): SimpleConfigObject

    Clone the object with only the given key (and its children) retained; all sibling keys are removed.

    Clone the object with only the given key (and its children) retained; all sibling keys are removed.

    key

    key to keep

    returns

    a copy of the object minus all keys except the one specified

    Definition Classes
    SimpleConfigObject → AbstractConfigObject → ConfigObject
  78. def withOnlyPath(path: Path): SimpleConfigObject
  79. def withOnlyPathOrNull(path: Path): SimpleConfigObject
  80. def withOrigin(origin: ConfigOrigin): AbstractConfigObject

    Returns a ConfigValue based on this one, but with the given origin.

    Returns a ConfigValue based on this one, but with the given origin. This is useful when you are parsing a new format of file or setting comments for a single ConfigValue.

    origin

    the origin set on the returned value

    returns

    the new ConfigValue with the given origin

    Definition Classes
    AbstractConfigObject → ConfigObject → AbstractConfigValue → ConfigValue
    Since

    1.3.0

  81. def withValue(path: Path, v: ConfigValue): SimpleConfigObject
  82. def withValue(key: String, v: ConfigValue): SimpleConfigObject

    Returns a ConfigObject based on this one, but with the given key set to the given value.

    Returns a ConfigObject based 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 ConfigObject#withoutKey.

    key

    key to add

    returns

    the new instance with the new map entry

    Definition Classes
    SimpleConfigObject → AbstractConfigObject → ConfigObject
  83. def withoutKey(key: String): SimpleConfigObject

    Clone the object with the given key removed.

    Clone the object with the given key removed.

    key

    key to remove

    returns

    a copy of the object minus the specified key

    Definition Classes
    SimpleConfigObject → AbstractConfigObject → ConfigObject
  84. def withoutPath(path: Path): SimpleConfigObject

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AbstractConfigObject

Inherited from Container

Inherited from ConfigObject

Inherited from Map[String, ConfigValue]

Inherited from AbstractConfigValue

Inherited from MergeableValue

Inherited from ConfigValue

Inherited from ConfigMergeable

Inherited from AnyRef

Inherited from Any

Ungrouped