SnakeYAML Engine 2.10 · org.snakeyaml.engine.v2.util.MergeUtils

Access	Constructor and Description
public	MergeUtils()

Method Summary

Modifier and Type	Method and Description
public abstract MappingNode	Returns: A `MappingNode` representation of the input `node`. asMappingNode(Node The node to be transformed. node) Converts the specified `node` into a `MappingNode`.
private Tuple<List<NodeTuple>, Set<String>>	Returns: A tuple of a list of filtered NodeTuples and a set containing the keys of the NodeTuples in the returned list. filter(List<NodeTuple> The list of NodeTuples to process. mergables, Set<String> A set of string values used as a filter. NodeTuples with keys in this set are omitted. filter) Filters out `NodeTuple`s with `ScalarNode` keys that are present in the provided filter set.
public List<NodeTuple>	Returns: A list of `NodeTuple` containing the merged keys and values. flatten(MappingNode The MappingNode to process for merge keys. node) Processes and resolves merge keys in a `MappingNode`, merging resolved key/values into the node.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

MergeUtils	back to summary
public MergeUtils()

Method Detail

asMappingNode back to summary

asMappingNode	back to summary
public abstract MappingNode asMappingNode(Node node) Converts the specified `node` into a `MappingNode`. This method is designed to transform various types of `Node` into a `MappingNode`, enabling further processing such as merging of keys. Parameters node:Node The node to be transformed. Returns:MappingNode A `MappingNode` representation of the input `node`.

public abstract MappingNode asMappingNode(Node node)

Converts the specified node into a MappingNode.

This method is designed to transform various types of Node into a MappingNode, enabling further processing such as merging of keys.

Parameters

node:Node: The node to be transformed.

Returns:MappingNode

A MappingNode representation of the input node.

filter back to summary

filter	back to summary
private Tuple<List<NodeTuple>, Set<String>> filter(List<NodeTuple> mergables, Set<String> filter) Filters out `NodeTuple`s with `ScalarNode` keys that are present in the provided filter set. This utility method supports the `flatten(MappingNode)` method by filtering out node tuples based on their key's presence in a set of strings. This ensures that the returned list of NodeTuples does not contain any keys that are present in the filter set. The set of strings returned alongside the list represents the keys of the NodeTuples in the returned list, facilitating the identification of newly added keys as part of the merge process. Parameters mergables:List<NodeTuple> The list of NodeTuples to process. filter:Set<String> A set of string values used as a filter. NodeTuples with keys in this set are omitted. Returns:Tuple<List<NodeTuple>, Set<String>> A tuple of a list of filtered NodeTuples and a set containing the keys of the NodeTuples in the returned list.

private Tuple<List<NodeTuple>, Set<String>> filter(List<NodeTuple> mergables, Set<String> filter)

Filters out NodeTuples with ScalarNode keys that are present in the provided filter set.

This utility method supports the flatten(MappingNode) method by filtering out node tuples based on their key's presence in a set of strings. This ensures that the returned list of NodeTuples does not contain any keys that are present in the filter set. The set of strings returned alongside the list represents the keys of the NodeTuples in the returned list, facilitating the identification of newly added keys as part of the merge process.

Parameters

mergables:List<NodeTuple>: The list of NodeTuples to process.
filter:Set<String>: A set of string values used as a filter. NodeTuples with keys in this set are omitted.

Returns:Tuple<List<NodeTuple>, Set<String>>

A tuple of a list of filtered NodeTuples and a set containing the keys of the NodeTuples in the returned list.

flatten back to summary

flatten	back to summary
public List<NodeTuple> flatten(MappingNode node) Processes and resolves merge keys in a `MappingNode`, merging resolved key/values into the node. Implements the YAML merge key feature by examining the nodes within the provided `node` and merging keys from referenced by "merge key" map(s) into the current mapping as per the YAML specification. Handling of duplicate keys is defined by the order of appearance in the mapping node, with priority given to the keys defined in `node` and the the earliest occurrences in the merging ones. Parameters node:MappingNode The MappingNode to process for merge keys. Returns:List<NodeTuple> A list of `NodeTuple` containing the merged keys and values. See Also YAML Merge Key Specification

public List<NodeTuple> flatten(MappingNode node)

Processes and resolves merge keys in a MappingNode, merging resolved key/values into the node.

Implements the YAML merge key feature by examining the nodes within the provided node and merging keys from referenced by "merge key" map(s) into the current mapping as per the YAML specification. Handling of duplicate keys is defined by the order of appearance in the mapping node, with priority given to the keys defined in node and the the earliest occurrences in the merging ones.

Parameters

node:MappingNode: The MappingNode to process for merge keys.

Returns:List<NodeTuple>

A list of NodeTuple containing the merged keys and values.

See Also

YAML Merge Key Specification

public abstract Class MergeUtils

Constructor Summary

Method Summary

Constructor Detail

Method Detail