Configuration
in package
implements
TreeConfiguration
AbstractYes
A TreeConfiguration with utilities methods.
This is the main class of the library. All implementations provided are Configuration instances.
Instanciations can only be made with methods from Configurations.
Tags
Table of Contents
Interfaces
- TreeConfiguration
- A configuration with a tree-shaped structure, that is a sequence of (K => V) where V can recursively contains entries.
Methods
- getBaseValueIterator() : Iterator<K, V>
- Gets a base value iterator.
- getRawValueIterator() : Iterator<K, V|Interpolation<string|int, V>>
- Gets a raw value iterator.
- merge() : static
- Adds iterables entries to the configuration.
- mergeTree() : static
- Merges some trees to the configuration.
- removeNodeFluent() : static
- Removes some nodes (fluent api).
- toArray() : array<string|int, V>
- Gets an array representation of the entries.
- union() : static
- Does the unions with iterables.
- unsetFluent() : static
- Unsets some entries.
Methods
getBaseValueIterator()
Gets a base value iterator.
public
final getBaseValueIterator() : Iterator<K, V>
Return values
Iterator<K, V>getRawValueIterator()
Gets a raw value iterator.
public
final getRawValueIterator() : Iterator<K, V|Interpolation<string|int, V>>
Return values
Iterator<K, V|Interpolation<string|int, V>>merge()
Adds iterables entries to the configuration.
public
final merge(iterable<K, V> ...$configs) : static
Parameters
- $configs : iterable<K, V>
-
Iterables of (K => V) entries.
Tags
Return values
static —This configuration.
mergeTree()
Merges some trees to the configuration.
public
final mergeTree(array<string|int, V> ...$trees) : static
Parameters
- $trees : array<string|int, V>
-
Some trees.
Tags
Return values
static —This configuration.
removeNodeFluent()
Removes some nodes (fluent api).
public
final removeNodeFluent(K ...$offsets) : static
Parameters
- $offsets : K
Tags
Return values
static —This configuration.
toArray()
Gets an array representation of the entries.
public
final toArray([ReadingMode $mode = ReadingMode::Normal ]) : array<string|int, V>
Parameters
- $mode : ReadingMode = ReadingMode::Normal
Return values
array<string|int, V>union()
Does the unions with iterables.
public
final union(iterable<K, V> ...$configs) : static
Parameters
- $configs : iterable<K, V>
-
Iterables of (K => V) entries
Tags
Return values
static —This configuration.
unsetFluent()
Unsets some entries.
public
final unsetFluent(K ...$offsets) : static
Parameters
- $offsets : K
-
Keys to drop.
Tags
Return values
static —This configuration.