t

org.ekrich.config

ConfigList

trait ConfigList extends List[ConfigValue] with ConfigValue

Subtype of ConfigValue representing a list value, as in JSON's [1,2,3] syntax.

ConfigList implements java.util.List[ConfigValue] so you can use it like a regular Java list. Or call #unwrapped to unwrap the list elements into plain Java values.

Like all ConfigValue subtypes, ConfigList is immutable. This makes it threadsafe and you never have to create "defensive copies." The mutator methods from java.util.List all throw java.lang.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.

Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigList
  2. ConfigValue
  3. ConfigMergeable
  4. List
  5. Collection
  6. Iterable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def add(arg0: Int, arg1: ConfigValue): Unit
    Definition Classes
    List
  2. abstract def add(arg0: ConfigValue): Boolean
    Definition Classes
    List → Collection
  3. abstract def addAll(arg0: Int, arg1: Collection[_ <: ConfigValue]): Boolean
    Definition Classes
    List
  4. abstract def addAll(arg0: Collection[_ <: ConfigValue]): Boolean
    Definition Classes
    List → Collection
  5. abstract def atKey(key: String): Config

    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
    ConfigValue
  6. abstract def atPath(path: String): Config

    Places the value inside a Config at the given path.

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

    path

    path to store this value at.

    returns

    a Config instance containing this value at the given path.

    Definition Classes
    ConfigValue
  7. abstract def clear(): Unit
    Definition Classes
    List → Collection
  8. abstract def contains(arg0: AnyRef): Boolean
    Definition Classes
    List → Collection
  9. abstract def containsAll(arg0: Collection[_ <: AnyRef]): Boolean
    Definition Classes
    List → Collection
  10. abstract def get(arg0: Int): ConfigValue
    Definition Classes
    List
  11. abstract def indexOf(arg0: AnyRef): Int
    Definition Classes
    List
  12. abstract def isEmpty(): Boolean
    Definition Classes
    List → Collection
  13. abstract def iterator(): Iterator[ConfigValue]
    Definition Classes
    List → Collection → Iterable
  14. abstract def lastIndexOf(arg0: AnyRef): Int
    Definition Classes
    List
  15. abstract def listIterator(arg0: Int): ListIterator[ConfigValue]
    Definition Classes
    List
  16. abstract def listIterator(): ListIterator[ConfigValue]
    Definition Classes
    List
  17. abstract def origin: ConfigOrigin

    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
    ConfigValue
  18. abstract def remove(arg0: Int): ConfigValue
    Definition Classes
    List
  19. abstract def remove(arg0: AnyRef): Boolean
    Definition Classes
    List → Collection
  20. abstract def removeAll(arg0: Collection[_ <: AnyRef]): Boolean
    Definition Classes
    List → Collection
  21. abstract 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
    ConfigValue
  22. abstract 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
    ConfigValue
  23. abstract def retainAll(arg0: Collection[_ <: AnyRef]): Boolean
    Definition Classes
    List → Collection
  24. abstract def set(arg0: Int, arg1: ConfigValue): ConfigValue
    Definition Classes
    List
  25. abstract def size(): Int
    Definition Classes
    List → Collection
  26. abstract def subList(arg0: Int, arg1: Int): List[ConfigValue]
    Definition Classes
    List
  27. abstract def toArray[T <: AnyRef](arg0: Array[T]): Array[T]
    Definition Classes
    List → Collection
  28. abstract def toArray(): Array[AnyRef]
    Definition Classes
    List → Collection
  29. abstract def unwrapped: List[AnyRef]

    Recursively unwraps the list, returning a list of plain Java values such as Integer or String or whatever is in the list.

    Recursively unwraps the list, returning a list of plain Java values such as Integer or String or whatever is in the list.

    returns

    a java.util.List containing plain Java objects

    Definition Classes
    ConfigList → ConfigValue
  30. abstract 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
    ConfigValue
  31. abstract def withFallback(other: ConfigMergeable): ConfigValue

    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.

    other

    an object whose keys should be used as fallbacks, if the keys are not present in this one

    returns

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

    Definition Classes
    ConfigValue → ConfigMergeable
  32. abstract def withOrigin(origin: ConfigOrigin): ConfigList

    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
    ConfigList → ConfigValue
    Since

    1.3.0

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def forEach(arg0: Consumer[_ >: ConfigValue <: AnyRef]): Unit
    Definition Classes
    Iterable
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. def parallelStream(): Stream[ConfigValue]
    Definition Classes
    Collection
  16. def removeIf(arg0: Predicate[_ >: ConfigValue <: AnyRef]): Boolean
    Definition Classes
    Collection
  17. def replaceAll(arg0: UnaryOperator[ConfigValue]): Unit
    Definition Classes
    List
  18. def sort(arg0: Comparator[_ >: ConfigValue <: AnyRef]): Unit
    Definition Classes
    List
  19. def spliterator(): Spliterator[ConfigValue]
    Definition Classes
    List → Collection → Iterable
  20. def stream(): Stream[ConfigValue]
    Definition Classes
    Collection
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toArray[T <: AnyRef](arg0: IntFunction[Array[T]]): Array[T]
    Definition Classes
    Collection
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 ConfigValue

Inherited from ConfigMergeable

Inherited from List[ConfigValue]

Inherited from Collection[ConfigValue]

Inherited from Iterable[ConfigValue]

Inherited from AnyRef

Inherited from Any

Ungrouped