SnakeYAML Engine 2.10 · org.snakeyaml.engine.v2.nodes.Node

Modifier and Type	Field and Description
private Optional<Anchor>	anchor
private List<CommentLine>	blockComments
private List<CommentLine>	endComments
protected Optional<Mark>	endMark
private List<CommentLine>	inLineComments
private Map<String, Object>	properties
private boolean	recursive
protected boolean	resolved true when the tag is assigned by the resolver
private final Optional<Mark>	startMark
private Tag	tag

Access	Constructor and Description
public	Node(Tag - the tag tag, Optional<Mark> - start mark when available startMark, Optional<Mark> - end mark when available endMark) Create Node to be parsed

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object obj) Overrides java.lang.Object.equals. Node is only equal to itself
public Optional<Anchor>	Returns: the Anchor if available getAnchor() Get the anchor if it was defined for this Node
public List<CommentLine>	Returns: the comment line list. getBlockComments() The ordered list of blank lines and block comments (full line) that appear before this node.
public List<CommentLine>	Returns: the comment line list. getEndComments() The ordered list of blank lines and block comments (full line) that appear AFTER this node.
public Optional<Mark>	getEndMark()
public List<CommentLine>	Returns: the comment line list. getInLineComments() The ordered list of in-line comments.
public abstract NodeType	Returns: scalar, sequence, mapping getNodeType()
public Object	Returns: the value if it was specified getProperty(String - the key of the runtime property key) Get the custom runtime property.
public Optional<Mark>	getStartMark()
public Tag	Returns: Tag of this node. getTag() Tag of this node.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: `true` if the node is self referenced. isRecursive() Indicates if this node must be constructed in two steps.
public void	setAnchor(Optional<Anchor> - the Anchor for this Node anchor) Set the anchor for this Node
public void	setBlockComments(List<CommentLine> blockComments)
public void	setEndComments(List<CommentLine> endComments)
public void	setInLineComments(List<CommentLine> inLineComments)
public Object	Returns: the previous value for the provided key if it was defined setProperty(String - the key for the custom property key, Object - the value for the custom property value) Define a custom runtime property.
public void	setRecursive(boolean recursive)
public void	setTag(Tag tag)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

anchor	back to summary
private Optional<Anchor> anchor

blockComments	back to summary
private List<CommentLine> blockComments

endComments	back to summary
private List<CommentLine> endComments

endMark	back to summary
protected Optional<Mark> endMark

inLineComments	back to summary
private List<CommentLine> inLineComments

properties	back to summary
private Map<String, Object> properties

recursive	back to summary
private boolean recursive

resolved	back to summary
protected boolean resolved true when the tag is assigned by the resolver

startMark	back to summary
private final Optional<Mark> startMark

tag	back to summary
private Tag tag

Node	back to summary
public Node(Tag tag, Optional<Mark> startMark, Optional<Mark> endMark) Create Node to be parsed Parameters tag:Tag - the tag startMark:Optional<Mark> - start mark when available endMark:Optional<Mark> - end mark when available

Method Detail

equals	back to summary
public final boolean equals(Object obj) Overrides java.lang.Object.equals. Node is only equal to itself Annotations @Override

equals

back to summary

public final boolean equals(Object obj)

Overrides java.lang.Object.equals.

Node is only equal to itself

Annotations

@Override

getAnchor	back to summary
public Optional<Anchor> getAnchor() Get the anchor if it was defined for this Node Returns:Optional<Anchor> the Anchor if available See Also 3.2.2.2. Anchors and Aliases

getAnchor

back to summary

public Optional<Anchor> getAnchor()

Get the anchor if it was defined for this Node

Returns:Optional<Anchor>: the Anchor if available
See Also: 3.2.2.2. Anchors and Aliases

getBlockComments	back to summary
public List<CommentLine> getBlockComments() The ordered list of blank lines and block comments (full line) that appear before this node. Returns:List<CommentLine> the comment line list.

getBlockComments

back to summary

public List<CommentLine> getBlockComments()

The ordered list of blank lines and block comments (full line) that appear before this node.

Returns:List<CommentLine>: the comment line list.

getEndComments	back to summary
public List<CommentLine> getEndComments() The ordered list of blank lines and block comments (full line) that appear AFTER this node. Note these comment should occur only in the last node in a document, when walking the node tree "in order" Returns:List<CommentLine> the comment line list.

getEndComments

back to summary

public List<CommentLine> getEndComments()

The ordered list of blank lines and block comments (full line) that appear AFTER this node.

Note

these comment should occur only in the last node in a document, when walking the node tree "in order"

Returns:List<CommentLine>: the comment line list.

getEndMark	back to summary
public Optional<Mark> getEndMark()

getInLineComments	back to summary
public List<CommentLine> getInLineComments() The ordered list of in-line comments. The first of which appears at the end of the line respresent by this node. The rest are in the following lines, indented per the Spec to indicate they are continuation of the inline comment. Returns:List<CommentLine> the comment line list.

getInLineComments

back to summary

public List<CommentLine> getInLineComments()

The ordered list of in-line comments. The first of which appears at the end of the line respresent by this node. The rest are in the following lines, indented per the Spec to indicate they are continuation of the inline comment.

Returns:List<CommentLine>: the comment line list.

getNodeType	back to summary
public abstract NodeType getNodeType() Returns:NodeType scalar, sequence, mapping

getProperty	back to summary
public Object getProperty(String key) Get the custom runtime property. Parameters key:String - the key of the runtime property Returns:Object the value if it was specified

getProperty

back to summary

public Object getProperty(String key)

Get the custom runtime property.

Parameters

key:String: - the key of the runtime property

Returns:Object

the value if it was specified

getStartMark	back to summary
public Optional<Mark> getStartMark()

getTag	back to summary
public Tag getTag() Tag of this node. Every node has a tag assigned. The tag is either local or global. Returns:Tag Tag of this node.

getTag

back to summary

public Tag getTag()

Tag of this node.

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

Returns:Tag: Tag of this node.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

isRecursive back to summary

isRecursive	back to summary
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 `org.snakeyaml.engine.v2.composer.Composer`, used during the construction process. Only relevant during loading. Returns:boolean `true` if the node is self referenced.

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 org.snakeyaml.engine.v2.composer.Composer, used during the construction process.

Only relevant during loading.

Returns:boolean: true if the node is self referenced.

setAnchor	back to summary
public void setAnchor(Optional<Anchor> anchor) Set the anchor for this Node Parameters anchor:Optional<Anchor> - the Anchor for this Node See Also 3.2.2.2. Anchors and Aliases

setAnchor

back to summary

public void setAnchor(Optional<Anchor> anchor)

Set the anchor for this Node

Parameters

anchor:Optional<Anchor>: - the Anchor for this Node

See Also

3.2.2.2. Anchors and Aliases

setBlockComments	back to summary
public void setBlockComments(List<CommentLine> blockComments)

setEndComments	back to summary
public void setEndComments(List<CommentLine> endComments)

setInLineComments	back to summary
public void setInLineComments(List<CommentLine> inLineComments)

setProperty	back to summary
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:String - the key for the custom property value:Object - the value for the custom property Returns:Object the previous value for the provided key if it was defined

setProperty

back to summary

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:String: - the key for the custom property
value:Object: - the value for the custom property

Returns:Object

the previous value for the provided key if it was defined

setRecursive	back to summary
public void setRecursive(boolean recursive)

setTag	back to summary
public void setTag(Tag tag)

public abstract Class Node

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail