Package com.amihaiemil.eoyaml

Class BaseYamlMapping

java.lang.Object

com.amihaiemil.eoyaml.BaseYamlMapping

All Implemented Interfaces:

YamlMapping, YamlNode, Comparable<YamlNode>

Direct Known Subclasses:

EmptyYamlMapping, MergedYamlMapping, StrictYamlMapping

public abstract class BaseYamlMapping
extends Object
implements YamlMapping

Base YamlMapping which all implementations of YamlMapping should extend. It implementing toString(), equals, hashcode and compareTo methods.

These methods should be default methods on the interface, but we are not allowed to have default implementations of java.lang.Object methods.

Since:

4.0.0

Version:

$Id: 2c8a407b9812bd53a41bc1098af15eccbfedba37 $

Author:

Mihai Andronache (amihaiemil@gmail.com)

Constructor Summary

Constructors

Constructor	Description
BaseYamlMapping()

Method Summary

Modifier and Type	Method	Description
<T extends YamlNode> T	asClass(Class<T> clazz, Node type)	Gives the YamlNode instance from node class and node type.
YamlMapping	asMapping()	Gives a Mapping value of the node.
Scalar	asScalar()	Gives a String value of the node.
YamlSequence	asSequence()	Gives a Sequence value of the node.
YamlStream	asStream()	Gives a Stream value of the node.
int	compareTo(YamlNode other)	Compare this Mapping to another node. A Mapping is always considered greater than a Scalar or a Sequence. If other is a Mapping, their integer lengths are compared - the one with the greater length is considered greater.
boolean	equals(Object other)	Equals method for YamlMapping.
int	hashCode()
boolean	isEmpty()	Is this YamlNode empty?
String	toString()	Print this YamlNode using a StringWriter to create its String representation.
Node	type()	Type of the node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amihaiemil.eoyaml.YamlMapping

date, date, dateTime, dateTime, doubleNumber, doubleNumber, floatNumber, floatNumber, foldedBlockScalar, foldedBlockScalar, integer, integer, keys, literalBlockScalar, literalBlockScalar, longNumber, longNumber, string, string, value, value, values, yamlMapping, yamlMapping, yamlSequence, yamlSequence

Methods inherited from interface com.amihaiemil.eoyaml.YamlNode

asClass, asMapping, asScalar, asSequence, asStream, comment

Constructor Detail

BaseYamlMapping

public BaseYamlMapping()

Method Detail

type

public final Node type()

Description copied from interface: YamlNode

Type of the node.

Specified by:

type in interface YamlNode

Returns:

Node type.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object other)

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

Overrides:

equals in class Object

Parameters:

other - The YamlMapping to which this is compared.

Returns:

True or false.

compareTo

public final int compareTo(YamlNode other)

Compare this Mapping to another node.

A Mapping is always considered greater than a Scalar or a Sequence.
If other is a Mapping, their integer lengths are compared - the one with the greater length is considered greater. If the lengths are equal, then the 2 Mappings are equal if all elements are equal (K==K and V==V). 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 AbstractNode.

Returns:

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

isEmpty

public final boolean isEmpty()

Description copied from interface: YamlNode

Is this YamlNode empty?

Specified by:

isEmpty in interface YamlNode

Returns:

True or false.

asScalar

public final Scalar asScalar()
                      throws YamlReadingException,
                             ClassCastException

Description copied from interface: YamlNode

Gives a String value of the node.

Specified by:

asScalar in interface YamlNode

Returns:

String value of the node.

Throws:

YamlReadingException - If the node type is not Scalar.

ClassCastException - If the node type couldn't defined correctly.

asMapping

public final YamlMapping asMapping()
                            throws YamlReadingException,
                                   ClassCastException

Description copied from interface: YamlNode

Gives a Mapping value of the node.

Specified by:

asMapping in interface YamlNode

Returns:

Mapping value of the node.

Throws:

YamlReadingException - If the node type is not Mapping.

ClassCastException - If the node type couldn't defined correctly.

asSequence

public final YamlSequence asSequence()
                              throws YamlReadingException,
                                     ClassCastException

Description copied from interface: YamlNode

Gives a Sequence value of the node.

Specified by:

asSequence in interface YamlNode

Returns:

Sequence value of the node.

Throws:

YamlReadingException - If the node type is not Sequence.

ClassCastException - If the node type couldn't defined correctly.

asStream

public final YamlStream asStream()
                          throws YamlReadingException,
                                 ClassCastException

Description copied from interface: YamlNode

Gives a Stream value of the node.

Specified by:

asStream in interface YamlNode

Returns:

Stream value of the node.

Throws:

YamlReadingException - If the node type is not Stream.

ClassCastException - If the node type couldn't defined correctly.

asClass

public final <T extends YamlNode> T asClass(Class<T> clazz,
                                            Node type)
                                     throws YamlReadingException,
                                            ClassCastException

Description copied from interface: YamlNode

Gives the YamlNode instance from node class and node type.

Specified by:

asClass in interface YamlNode

Type Parameters:

T - Requested a YamlNode class instance.

Parameters:

clazz - Requested a YamlNode class.

type - Requested a Node.

Returns:

Requested a YamlNode.

Throws:

YamlReadingException - If the type is not a YamlNode.

ClassCastException - If the node type couldn't defined correctly.

toString

public final String toString()

Print this YamlNode using a StringWriter to create its String representation.

Overrides:

toString in class Object

Returns:

String print of this YamlNode.

Throws:

YamlPrintException - If there is any I/O problem when printing the YAML.