com.hazelcast.internal.yaml

Interface YamlMapping

All Superinterfaces:

YamlCollection, YamlNode

All Known Subinterfaces:

MutableYamlMapping

All Known Implementing Classes:

YamlMappingImpl

public interface YamlMapping
extends YamlCollection

Interface for YAML mapping nodes

Field Summary

Fields inherited from interface com.hazelcast.internal.yaml.YamlNode

UNNAMED_NODE

Method Summary

Modifier and Type	Method and Description
YamlNode	child(String name) Gets a child node by its name
YamlMapping	childAsMapping(String name) Gets a child mapping node by its name
YamlScalar	childAsScalar(String name) Gets a child scalar node by its name
<T> T	childAsScalarValue(String name) Gets a child scalar node's value by its name See YamlScalar for the possible types Please note that if the scalar's type is not the expected type T, a ClassCastException is thrown at the call site.
<T> T	childAsScalarValue(String name, Class<T> type) Gets a child scalar node's value by its name with type hinting See YamlScalar for the possible types
YamlSequence	childAsSequence(String name) Gets a child sequence node by its name
Iterable<YamlNameNodePair>	childrenPairs() Returns the children as YamlNameNodePairs This method may have null values as the childNode in the returned pairs if the node's values is explicitly defined as !!null in the YAML document.

Methods inherited from interface com.hazelcast.internal.yaml.YamlCollection

childCount, children

Methods inherited from interface com.hazelcast.internal.yaml.YamlNode

nodeName, parent, path

Method Detail

child

YamlNode child(String name)

Gets a child node by its name

Parameters:

name - the name of the child node

Returns:

the child node with the given name if exists, null otherwise

childrenPairs

Iterable<YamlNameNodePair> childrenPairs()

Returns the children as YamlNameNodePairs

This method may have null values as the childNode in the returned pairs if the node's values is explicitly defined as !!null in the YAML document.

The difference from the YamlCollection.children() children method is that YamlCollection.children() does not return null children nodes, while childrenPairs() does.

Returns:

an Iterable pair of node names and node instances

childAsMapping

YamlMapping childAsMapping(String name)

Gets a child mapping node by its name

Parameters:

name - the name of the child node

Returns:

the child mapping node with the given name if exists, null otherwise

childAsSequence

YamlSequence childAsSequence(String name)

Gets a child sequence node by its name

Parameters:

name - the name of the child node

Returns:

the child sequence node with the given name if exists, null otherwise

childAsScalar

YamlScalar childAsScalar(String name)

Gets a child scalar node by its name

Parameters:

name - the name of the child node

Returns:

the child scalar node with the given name if exists, null otherwise

childAsScalarValue

<T> T childAsScalarValue(String name)

Gets a child scalar node's value by its name

See YamlScalar for the possible types

Please note that if the scalar's type is not the expected type T, a ClassCastException is thrown at the call site.

Parameters:

name - the name of the child node

Returns:

the child scalar node's value with the given name if exists, null otherwise

See Also:

YamlScalar, childAsScalarValue(String, Class)

childAsScalarValue

<T> T childAsScalarValue(String name,
                         Class<T> type)

Gets a child scalar node's value by its name with type hinting

See YamlScalar for the possible types

Parameters:

name - the name of the child node

type - the type that the scalar's value type to be validated against

Returns:

the child scalar node's value with the given name

Throws:

YamlException - if the scalar's value is not a type of T

See Also:

YamlScalar