com.amihaiemil.eoyaml

Class StrictYamlSequence

java.lang.Object

com.amihaiemil.eoyaml.StrictYamlSequence

All Implemented Interfaces:

YamlNode, YamlSequence, Comparable<YamlNode>, Iterable<YamlNode>

public final class StrictYamlSequence
extends Object

Decorator for a YamlSequence which throws YamlNodeNotFoundException if any of the methods of the decorated YamlSequence returns null (if the given index points to a YamlNode that is not a YamlMapping, for instance).

Since:

1.0.0

Version:

$Id: b153bc22b58cafda45dd4ac1fe928af2f961c963 $

Author:

Salavat.Yalalov ([email protected])

Constructor Summary

Constructors

Constructor and Description
StrictYamlSequence(YamlSequence decorated) Ctor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(YamlNode other) Compare this Sequence to another node. A Sequence is always considered greater than a Scalar and less than a Mapping. If other is a Sequence, their integer lengths are compared - the one with the greater length is considered greater.
boolean	equals(Object other) Equals method for YamlSequence.
int	hashCode()
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.
String	toString()
Collection<YamlNode>	values() Fetch the values.
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.amihaiemil.eoyaml.YamlSequence

date, dateTime, doubleNumber, floatNumber, indent, integer, longNumber

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode

children

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

StrictYamlSequence

public StrictYamlSequence(YamlSequence decorated)

Ctor.

Parameters:

decorated - Original YamlSequence

Method Detail

values

public Collection<YamlNode> values()

Description copied from interface: YamlNode

Fetch the values.

Returns:

Collection of YamlNode

yamlMapping

public YamlMapping yamlMapping(int index)

Get the Yaml mapping from the given index.

Parameters:

index - Integer index.

Returns:

Yaml mapping

yamlSequence

public YamlSequence yamlSequence(int index)

Get the Yaml sequence from the given index.

Parameters:

index - Integer index.

Returns:

Yaml sequence

string

public String string(int index)

Get the String from the given index.

Parameters:

index - Integer index.

Returns:

String

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Description copied from interface: YamlSequence

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

Returns:

Integer.

iterator

public Iterator<YamlNode> iterator()

Description copied from interface: YamlSequence

Returns this YamlSequence's children Iterator.

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

Returns:

Iterator of YamlNode.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Equals method for YamlSequence. It returns true if the compareTo(...) method returns 0.

Overrides:

equals in class Object

Parameters:

other - The YamlSequence to which this is compared.

Returns:

True or false

compareTo

public int compareTo(YamlNode other)

Compare this Sequence to another node.

A Sequence is always considered greater than a Scalar and less than a Mapping.
If other is a Sequence, their integer lengths are compared - the one with the greater length is considered greater. If the lengths are equal, then the 2 Sequences are equal if all elements are equal. If the elements are not identical, the comparison of the first unequal elements is returned.

Specified by:

compareTo in interface Comparable<YamlNode>

Parameters:

other - The other YamlNode.

Returns:

a value < 0 if this < other
0 if this == other or
a value > 0 if this > other