Class/Object

org.ekrich.config.impl

AbstractConfigValue

Related Docs: object AbstractConfigValue | package impl

Permalink

abstract class AbstractConfigValue extends ConfigValue with MergeableValue

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractConfigValue
  2. MergeableValue
  3. ConfigValue
  4. ConfigMergeable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def newCopy(origin: ConfigOrigin): AbstractConfigValue

    Permalink
    Attributes
    protected
  2. abstract def unwrapped: AnyRef

    Permalink

    Returns the value as a plain Java boxed value, that is, a String, Number, Boolean, Map, List, or null, matching the #valueType of this ConfigValue.

    Returns the value as a plain Java boxed value, that is, a String, Number, Boolean, Map, List, or null, matching the #valueType of this ConfigValue. If the value is a ConfigObject or ConfigList, it is recursively unwrapped.

    returns

    a plain Java value corresponding to this ConfigValue

    Definition Classes
    ConfigValue
  3. abstract def valueType: ConfigValueType

    Permalink

    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
    ConfigValue
  4. Concrete 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. val _origin: ConfigOrigin

      Permalink
    5. final def asInstanceOf[T0]: T0

      Permalink
      Definition Classes
      Any
    6. def atKey(key: String): SimpleConfig

      Permalink

      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
      AbstractConfigValueConfigValue
    7. def atPath(pathExpression: String): SimpleConfig

      Permalink

      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
      AbstractConfigValueConfigValue
    8. def canEqual(other: Any): Boolean

      Permalink
      Attributes
      protected
    9. def clone(): AnyRef

      Permalink
      Attributes
      protected[java.lang]
      Definition Classes
      AnyRef
      Annotations
      @throws( ... )
    10. def constructDelayedMerge(origin: ConfigOrigin, stack: List[AbstractConfigValue]): AbstractConfigValue

      Permalink
      Attributes
      protected
    11. final def eq(arg0: AnyRef): Boolean

      Permalink
      Definition Classes
      AnyRef
    12. def equals(other: Any): Boolean

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

      Permalink
      Attributes
      protected[java.lang]
      Definition Classes
      AnyRef
      Annotations
      @throws( classOf[java.lang.Throwable] )
    14. final def getClass(): Class[_]

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

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

      Permalink
      Definition Classes
      Any
    17. def mergedWithNonObject(fallback: AbstractConfigValue): AbstractConfigValue

      Permalink
      Attributes
      protected
    18. final def mergedWithNonObject(stack: Collection[AbstractConfigValue], fallback: AbstractConfigValue): AbstractConfigValue

      Permalink
      Attributes
      protected
    19. def mergedWithObject(fallback: AbstractConfigObject): AbstractConfigValue

      Permalink
      Attributes
      protected
    20. final def mergedWithObject(stack: Collection[AbstractConfigValue], fallback: AbstractConfigObject): AbstractConfigValue

      Permalink
      Attributes
      protected
    21. def mergedWithTheUnmergeable(fallback: Unmergeable): AbstractConfigValue

      Permalink
      Attributes
      protected
    22. final def mergedWithTheUnmergeable(stack: Collection[AbstractConfigValue], fallback: Unmergeable): AbstractConfigValue

      Permalink
      Attributes
      protected
    23. final def ne(arg0: AnyRef): Boolean

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

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

      Permalink
      Definition Classes
      AnyRef
    26. def origin: SimpleConfigOrigin

      Permalink

      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
      AbstractConfigValueConfigValue
    27. final def render(options: ConfigRenderOptions): String

      Permalink

      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
      AbstractConfigValueConfigValue
    28. final def render: String

      Permalink

      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
      AbstractConfigValueConfigValue
    29. def render(sb: StringBuilder, indent: Int, atRoot: Boolean, options: ConfigRenderOptions): Unit

      Permalink
    30. final def requireNotIgnoringFallbacks(): Unit

      Permalink
      Attributes
      protected
    31. def resolveSubstitutions(context: ResolveContext, source: ResolveSource): ResolveResult[_ <: AbstractConfigValue]

      Permalink

      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

      Annotations
      @throws( ... )
    32. final def synchronized[T0](arg0: ⇒ T0): T0

      Permalink
      Definition Classes
      AnyRef
    33. def toFallbackValue: AbstractConfigValue

      Permalink
      Definition Classes
      AbstractConfigValueMergeableValue
    34. def toString(): String

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

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

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

      Permalink
      Definition Classes
      AnyRef
      Annotations
      @throws( ... )
    38. def withFallback(mergeable: ConfigMergeable): AbstractConfigValue

      Permalink

      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 otherObjectwill 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
      AbstractConfigValueConfigValueConfigMergeable
    39. def withFallbacksIgnored(): AbstractConfigValue

      Permalink
      Attributes
      protected
    40. def withOrigin(origin: ConfigOrigin): AbstractConfigValue

      Permalink

      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
      AbstractConfigValueConfigValue
      Since

      1.3.0

    Inherited from MergeableValue

    Inherited from ConfigValue

    Inherited from ConfigMergeable

    Inherited from AnyRef

    Inherited from Any

    Ungrouped