SimpleConfigList

final class SimpleConfigList(_origin: ConfigOrigin, val value: List[AbstractConfigValue], status: ResolveStatus) extends AbstractConfigValue with ConfigList with Container with Serializable
Companion:
object
trait Serializable
trait Container
trait List[ConfigValue]
trait Collection[ConfigValue]
trait Iterable[ConfigValue]
class Object
trait Matchable
class Any

Value members

Constructors

def this(_origin: ConfigOrigin, value: List[AbstractConfigValue])

Concrete methods

override def add(e: ConfigValue): Boolean
Definition Classes
List -> Collection
override def add(index: Int, element: ConfigValue): Unit
Definition Classes
List
override def addAll(c: Collection[_ <: ConfigValue]): Boolean
Definition Classes
List -> Collection
override def addAll(index: Int, c: Collection[_ <: ConfigValue]): Boolean
Definition Classes
List
override def canEqual(other: Any): Boolean
Definition Classes
override def clear(): Unit
Definition Classes
List -> Collection
override def contains(o: Any): Boolean
Definition Classes
List -> Collection
override def containsAll(c: Collection[_]): Boolean
Definition Classes
List -> Collection
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
List -> Collection -> AbstractConfigValue -> Any
override def get(index: Int): AbstractConfigValue
Definition Classes
List
override 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
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
List -> Collection -> AbstractConfigValue -> Any
override def indexOf(o: Any): Int
Definition Classes
List
override def isEmpty: Boolean
Definition Classes
List -> Collection
override def iterator: Iterator[ConfigValue]
Definition Classes
List -> Collection -> Iterable
override def lastIndexOf(o: Any): Int
Definition Classes
List
override def listIterator: ListIterator[ConfigValue]
Definition Classes
override def listIterator(index: Int): ListIterator[ConfigValue]
Definition Classes
List
override def newCopy(newOrigin: ConfigOrigin): AbstractConfigValue
Definition Classes
override def relativized(prefix: Path): SimpleConfigList

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.

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
override def remove(o: Any): Boolean
Definition Classes
List -> Collection
override def remove(index: Int): ConfigValue
Definition Classes
List
override def removeAll(c: Collection[_]): Boolean
Definition Classes
List -> Collection
override def render(sb: StringBuilder, indentVal: Int, atRoot: Boolean, options: ConfigRenderOptions): Unit
Definition Classes

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.

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
Definition Classes
override def resolveSubstitutions(context: ResolveContext, source: ResolveSource): ResolveResult[_ <: SimpleConfigList]

Called only by ResolveContext.resolve().

Called only by ResolveContext.resolve().

Value parameters:
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
override def retainAll(c: Collection[_]): Boolean
Definition Classes
List -> Collection
override def set(index: Int, element: ConfigValue): ConfigValue
Definition Classes
List
override def size: Int
Definition Classes
List -> Collection
override def subList(fromIndex: Int, toIndex: Int): List[ConfigValue]
Definition Classes
List
override def toArray: Array[Object]
Definition Classes
override def toArray[T](a: Array[T & Object]): Array[T & Object]
Definition Classes
List -> Collection
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.

Returns:

a java.util.List containing plain Java objects

Definition Classes

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

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

Returns:

the new ConfigValue with the given origin

Since:

1.3.0

Definition Classes

Inherited methods

override def atKey(key: String): SimpleConfig

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.

Returns:

a Config instance containing this value at the given key.

Definition Classes
Inherited from:
AbstractConfigValue
override def atPath(pathExpression: String): SimpleConfig

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.

Returns:

a Config instance containing this value at the given path.

Definition Classes
Inherited from:
AbstractConfigValue
def forEach(x$0: Consumer[_ >: ConfigValue <: <FromJavaObject>]): Unit
Inherited from:
Iterable

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
Inherited from:
AbstractConfigValue
def parallelStream(): Stream[E]
Inherited from:
Collection
def removeIf(x$0: Predicate[_ >: ConfigValue <: <FromJavaObject>]): Boolean
Inherited from:
Collection
final override 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

Returns:

the rendered value

Definition Classes
Inherited from:
AbstractConfigValue
final override 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()).

Returns:

the rendered value

Definition Classes
Inherited from:
AbstractConfigValue
def replaceAll(x$0: UnaryOperator[ConfigValue]): Unit
Inherited from:
List
def sort(x$0: Comparator[_ >: ConfigValue <: <FromJavaObject>]): Unit
Inherited from:
List
def spliterator(): Spliterator[E]
Inherited from:
List
def stream(): Stream[E]
Inherited from:
Collection
def toArray[T <: <FromJavaObject>](x$0: IntFunction[Array[Object & T]]): Array[Object & T]
Inherited from:
Collection
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
Inherited from:
AbstractConfigValue

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

Returns:

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

Definition Classes
Inherited from:
AbstractConfigValue

Concrete fields