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: f55362c00da4dfb781521544e2cc072a5abc01b4 $

Author:

Mihai Andronache ([email protected])

Method Summary

Modifier and Type	Method and Description
default LocalDate	date(int index) Convenience method to directly read a LocalDate value from this sequence.
default LocalDateTime	dateTime(int index) Convenience method to directly read a LocalDateTime value from this sequence.
default double	doubleNumber(int index) Convenience method to directly read a double value from this sequence.
default float	floatNumber(int index) Convenience method to directly read a float value from this sequence.
default String	indent(int indentation) Indent this YamlSequence.
default int	integer(int index) Convenience method to directly read an integer value from this sequence.
Iterator<YamlNode>	iterator() Returns this YamlSequence's children Iterator. It is equivalent to YamlSequence.values().iterator().
default long	longNumber(int index) Convenience method to directly read a long value from this sequence.
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.

integer

default int integer(int index)

Convenience method to directly read an integer value from this sequence. It is equivalent to:

     YamlSequence sequence = ...;
     int value = Integer.parseInt(sequence.string(...));
 

Parameters:

index - The index of the value.

Returns:

Found integer.

Throws:

NumberFormatException - - if the Scalar value is not a parsable integer.

floatNumber

default float floatNumber(int index)

Convenience method to directly read a float value from this sequence. It is equivalent to:

     YamlSequence sequence = ...;
     float value = Float.parseFloat(sequence.string(...));
 

Parameters:

index - The index of the value.

Returns:

Found float.

Throws:

NumberFormatException - - if the Scalar value is not a parsable float.

doubleNumber

default double doubleNumber(int index)

Convenience method to directly read a double value from this sequence. It is equivalent to:

     YamlSequence sequence = ...;
     double value = Double.parseDouble(sequence.string(...));
 

Parameters:

index - The index of the value.

Returns:

Found double.

Throws:

NumberFormatException - - if the Scalar value is not a parsable double.

longNumber

default long longNumber(int index)

Convenience method to directly read a long value from this sequence. It is equivalent to:

     YamlSequence sequence = ...;
     long value = Long.parseLong(sequence.string(...));
 

Parameters:

index - The index of the value.

Returns:

Found long.

Throws:

NumberFormatException - - if the Scalar value is not a parsable long.

date

default LocalDate date(int index)

Convenience method to directly read a LocalDate value from this sequence. It is equivalent to:

     YamlSequence sequence = ...;
     LocalDate dateTime = LocalDate.parse(sequence.string(...));
 

Parameters:

index - The index of the value.

Returns:

Found LocalDate.

Throws:

DateTimeParseException - - if the Scalar value cannot be parsed.

dateTime

default LocalDateTime dateTime(int index)

Convenience method to directly read a LocalDateTime value from this sequence. It is equivalent to:

     YamlSequence sequence = ...;
     LocalDateTime dateTime = LocalDateTime.parse(sequence.string(...));
 

Parameters:

index - The index of the value.

Returns:

Found LocalDateTime.

Throws:

DateTimeParseException - - if the Scalar value cannot be parsed.