sconfig
API
Generated with
sconfig/org.ekrich.config/ConfigList

ConfigList

org.ekrich.config.ConfigList
trait ConfigList extends List[ConfigValue], 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.

Attributes

Graph
Supertypes
trait ConfigValue
trait List[ConfigValue]
trait Collection[ConfigValue]
trait Iterable[ConfigValue]
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Abstract methods

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

Attributes

Returns

a java.util.List containing plain Java objects

Definition Classes
override def withOrigin(origin: ConfigOrigin): ConfigList

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.

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.

Value parameters

origin

the origin set on the returned value

Attributes

Returns

the new ConfigValue with the given origin

Since

1.3.0

Definition Classes

Inherited methods

def add(x$0: Int, x$1: ConfigValue): Unit

Attributes

Inherited from:
List
def add(x$0: ConfigValue): Boolean

Attributes

Inherited from:
List
def addAll(x$0: Int, x$1: Collection[_ <: ConfigValue]): Boolean

Attributes

Inherited from:
List
def addAll(x$0: Collection[_ <: ConfigValue]): Boolean

Attributes

Inherited from:
List
def atKey(key: String): Config

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

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

Value parameters

key

key to store this value at.

Attributes

Returns

a Config instance containing this value at the given key.

Inherited from:
ConfigValue
def atPath(path: String): Config

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

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

Value parameters

path

path to store this value at.

Attributes

Returns

a Config instance containing this value at the given path.

Inherited from:
ConfigValue
def clear(): Unit

Attributes

Inherited from:
List
def contains(x$0: <FromJavaObject>): Boolean

Attributes

Inherited from:
List
def containsAll(x$0: Collection[_ <: <FromJavaObject>]): Boolean

Attributes

Inherited from:
List
def forEach(x$0: Consumer[_ >: ConfigValue <: <FromJavaObject>]): Unit

Attributes

Inherited from:
Iterable
def get(x$0: Int): E

Attributes

Inherited from:
List
def indexOf(x$0: <FromJavaObject>): Int

Attributes

Inherited from:
List
def isEmpty(): Boolean

Attributes

Inherited from:
List
def iterator(): Iterator[E]

Attributes

Inherited from:
List
def lastIndexOf(x$0: <FromJavaObject>): Int

Attributes

Inherited from:
List
def listIterator(x$0: Int): ListIterator[E]

Attributes

Inherited from:
List
def listIterator(): ListIterator[E]

Attributes

Inherited from:
List
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.

Attributes

Returns

where the value came from

Inherited from:
ConfigValue
def parallelStream(): Stream[E]

Attributes

Inherited from:
Collection
def remove(x$0: Int): E

Attributes

Inherited from:
List
def remove(x$0: <FromJavaObject>): Boolean

Attributes

Inherited from:
List
def removeAll(x$0: Collection[_ <: <FromJavaObject>]): Boolean

Attributes

Inherited from:
List
def removeIf(x$0: Predicate[_ >: ConfigValue <: <FromJavaObject>]): Boolean

Attributes

Inherited from:
Collection
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.

Value parameters

options

the rendering options

Attributes

Returns

the rendered value

Inherited from:
ConfigValue
def render: 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.

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

Attributes

Returns

the rendered value

Inherited from:
ConfigValue
def replaceAll(x$0: UnaryOperator[ConfigValue]): Unit

Attributes

Inherited from:
List
def retainAll(x$0: Collection[_ <: <FromJavaObject>]): Boolean

Attributes

Inherited from:
List
def set(x$0: Int, x$1: ConfigValue): E

Attributes

Inherited from:
List
def size(): Int

Attributes

Inherited from:
List
def sort(x$0: Comparator[_ >: ConfigValue <: <FromJavaObject>]): Unit

Attributes

Inherited from:
List
def spliterator(): Spliterator[E]

Attributes

Inherited from:
List
def stream(): Stream[E]

Attributes

Inherited from:
Collection
def subList(x$0: Int, x$1: Int): List[E]

Attributes

Inherited from:
List
def toArray[T <: <FromJavaObject>](x$0: Array[Object & T]): Array[Object & T]

Attributes

Inherited from:
List
def toArray(): Array[<FromJavaObject>]

Attributes

Inherited from:
List
def toArray[T <: <FromJavaObject>](x$0: IntFunction[Array[Object & T]]): Array[Object & T]

Attributes

Inherited from:
Collection
def valueType: ConfigValueType

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

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

Attributes

Returns

value's type

Inherited from:
ConfigValue
override 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.

Value parameters

other

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

Attributes

Returns

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

Definition Classes
Inherited from:
ConfigValue
Generated with