com.amihaiemil.eoyaml

Interface YamlSequence

All Superinterfaces:

Comparable<YamlNode>, Iterable<YamlNode>, YamlNode

All Known Implementing Classes:

StrictYamlSequence

public interface YamlSequence
extends YamlNode, Iterable<YamlNode>

A Yaml sequence.

Since:

1.0.0

Version:

$Id: 82885212d6432d295593aede68f07a1099598a5b $

Author:

Mihai Andronache (amihaiemil@gmail.com)

Method Summary

Modifier and Type	Method and Description
default String	indent(int indentation) Indent this YamlSequence.
Iterator<YamlNode>	iterator() Returns this YamlSequence's children Iterator. It is equivalent to YamlSequence.values().iterator().
int	size() The number of Yaml elements (scalars, mappings and sequences) found in this sequence.
String	string(int index) Get the String from the given index.
YamlMapping	yamlMapping(int index) Get the Yaml mapping from the given index.
YamlSequence	yamlSequence(int index) Get the Yaml sequence from the given index.

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode

children, values

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

int size()

The number of Yaml elements (scalars, mappings and sequences) found in this sequence.

Returns:

Integer.

yamlMapping

YamlMapping yamlMapping(int index)

Get the Yaml mapping from the given index.

Parameters:

index - Integer index.

Returns:

Yaml mapping

yamlSequence

YamlSequence yamlSequence(int index)

Get the Yaml sequence from the given index.

Parameters:

index - Integer index.

Returns:

Yaml sequence

string

String string(int index)

Get the String from the given index.

Parameters:

index - Integer index.

Returns:

String

iterator

Iterator<YamlNode> iterator()

Returns this YamlSequence's children Iterator.

It is equivalent to YamlSequence.values().iterator().

Specified by:

iterator in interface Iterable<YamlNode>

Returns:

Iterator of YamlNode.

indent

default String indent(int indentation)

Indent this YamlSequence. This is a default method since indentation logic should be identical for any kind of YamlSequence, 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 YamlSequence, by the specified indentation.