com.amihaiemil.eoyaml

Interface YamlMapping

All Superinterfaces:

Comparable<YamlNode>, YamlNode

All Known Implementing Classes:

StrictYamlMapping

public interface YamlMapping
extends YamlNode

A Yaml mapping.

Since:

1.0.0

Version:

$Id: 6890f5e8cb1b255307b20815c185a0763421260b $

Author:

Mihai Andronache (amihaiemil@gmail.com)

Method Summary

Modifier and Type	Method and Description
default String	indent(int indentation) Indent this YamlMapping.
Set<YamlNode>	keys() Return the keys' set of this mapping. Pay attention: the keys are ordered.
String	string(String key) Get the String associated with the given key.
String	string(YamlNode key) Get the String associated with the given key.
YamlNode	value(YamlNode key) Get the YamlNode mapped to the specified key.
YamlMapping	yamlMapping(String key) Get the Yaml mapping associated with the given key.
YamlMapping	yamlMapping(YamlNode key) Get the Yaml mapping associated with the given key.
YamlSequence	yamlSequence(String key) Get the Yaml sequence associated with the given key.
YamlSequence	yamlSequence(YamlNode key) Get the Yaml sequence associated with the given key.

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode

children, values

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

yamlMapping

YamlMapping yamlMapping(String key)

Get the Yaml mapping associated with the given key.

Parameters:

key - String key

Returns:

Yaml mapping or null if the key is missing, or not pointing to a mapping.

yamlMapping

YamlMapping yamlMapping(YamlNode key)

Get the Yaml mapping associated with the given key.

Parameters:

key - Yaml node (mapping or sequence) key

Returns:

Yaml mapping or null if the key is missing, or not pointing to a mapping.

yamlSequence

YamlSequence yamlSequence(String key)

Get the Yaml sequence associated with the given key.

Parameters:

key - String key

Returns:

Yaml sequence or null if the key is missing, or not pointing to a sequence.

yamlSequence

YamlSequence yamlSequence(YamlNode key)

Get the Yaml sequence associated with the given key.

Parameters:

key - Yaml node (mapping or sequence) key

Returns:

Yaml sequence or null if the key is missing, or not pointing to a sequence

string

String string(String key)

Get the String associated with the given key.

Parameters:

key - String key

Returns:

String or null if the key is missing, or not pointing to a scalar.

string

String string(YamlNode key)

Get the String associated with the given key.

Parameters:

key - Yaml node (mapping or sequence) key

Returns:

String or null if the key is missing, or not pointing to a scalar.

value

YamlNode value(YamlNode key)

Get the YamlNode mapped to the specified key.

Parameters:

key - YamlNode key. Could be a simple scalar, a YamlMapping or a YamlSequence.

Returns:

The found YamlNode or null if nothing is found.

keys

Set<YamlNode> keys()

Return the keys' set of this mapping.

Pay attention: the keys are ordered.

Returns:

Set of YamlNode keys.

indent

default String indent(int indentation)

Indent this YamlMapping. This is a default method since indentation logic should be identical for any kind of YamlMapping, regardless of its implementation.

Specified by:

indent in interface YamlNode

Parameters:

indentation - Indentation to start with. Usually, it's 0, since we don't want to have spaces at the beginning. But in the case of nested YamlNodes, this value may be greater than 0.

Returns:

String indented YamlMapping, by the specified indentation.