Package org.snakeyaml.engine.v2.nodes

Class Node

java.lang.Object

org.snakeyaml.engine.v2.nodes.Node

Direct Known Subclasses:

AnchorNode, CollectionNode, ScalarNode

public abstract class Node
extends Object

Base class for all nodes.

The nodes form the node-graph described in the YAML Specification.

While loading, the node graph is usually created by the Composer.

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<Mark>	endMark
protected boolean	resolved	true when the tag is assigned by the resolver

Constructor Summary

Constructors

Constructor	Description
Node(Tag tag, Optional<Mark> startMark, Optional<Mark> endMark)	Create Node to be parsed

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Node is only equal to itself
Optional<Anchor>	getAnchor()	Get the anchor if it was defined for this Node
Optional<Mark>	getEndMark()
abstract NodeType	getNodeType()
Object	getProperty(String key)	Get the custom runtime property.
Optional<Mark>	getStartMark()
Tag	getTag()	Tag of this node.
int	hashCode()
boolean	isRecursive()	Indicates if this node must be constructed in two steps.
void	setAnchor(Optional<Anchor> anchor)	Set the anchor for this Node
Object	setProperty(String key, Object value)	Define a custom runtime property.
void	setRecursive(boolean recursive)
void	setTag(Tag tag)

Methods inherited from class java.lang.Object

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

Field Detail

endMark

protected Optional<Mark> endMark

resolved

protected boolean resolved

true when the tag is assigned by the resolver

Constructor Detail

Node

public Node(Tag tag,
            Optional<Mark> startMark,
            Optional<Mark> endMark)

Create Node to be parsed

Parameters:

tag - - the tag

startMark - - start mark when available

endMark - - end mark when available

Method Detail

getTag

public Tag getTag()

Tag of this node.

Every node has a tag assigned. The tag is either local or global.

Returns:

Tag of this node.

getEndMark

public Optional<Mark> getEndMark()

getNodeType

public abstract NodeType getNodeType()

Returns:

scalar, sequence, mapping

getStartMark

public Optional<Mark> getStartMark()

setTag

public void setTag(Tag tag)

equals

public final boolean equals(Object obj)

Node is only equal to itself

Overrides:

equals in class Object

setRecursive

public void setRecursive(boolean recursive)

isRecursive

public boolean isRecursive()

Indicates if this node must be constructed in two steps.

Two-step construction is required whenever a node is a child (direct or indirect) of it self. That is, if a recursive structure is build using anchors and aliases.

Set by Composer, used during the construction process.

Only relevant during loading.

Returns:

true if the node is self referenced.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getAnchor

public Optional<Anchor> getAnchor()

Get the anchor if it was defined for this Node

Returns:

the Anchor if available

See Also:

3.2.2.2. Anchors and Aliases

setAnchor

public void setAnchor(Optional<Anchor> anchor)

Set the anchor for this Node

Parameters:

anchor - - the Anchor for this Node

See Also:

3.2.2.2. Anchors and Aliases

setProperty

public Object setProperty(String key,
                          Object value)

Define a custom runtime property. It is not used by Engine but may be used by other tools.

Parameters:

key - - the key for the custom property

value - - the value for the custom property

Returns:

the previous value for the provided key if it was defined

getProperty

public Object getProperty(String key)

Get the custom runtime property.

Parameters:

key - - the key of the runtime property

Returns:

the value if it was specified