org.raml.yagi.framework.nodes

Interface Node

All Known Subinterfaces:

ArrayNode, BooleanNode, ExecutableNode, FloatingNode, IntegerNode, KeyValueNode, NullNode, ObjectNode, ReferenceNode, SimpleTypeNode<T>, StringNode

All Known Implementing Classes:

AbstractObjectNode, AbstractRamlNode, AbstractStringNode, ArrayWrapperNode, BaseNode, EmptyErrorNode, ErrorNode, IncludeErrorNode, JArrayNode, JBaseRamlNode, JBooleanNode, JFloatingNode, JIntegerNode, JNullNode, JObjectNode, JStringNode, KeyValueNodeImpl, NullNodeImpl, ObjectNodeImpl, StringNodeImpl, SYArrayNode, SYBaseRamlNode, SYBooleanNode, SYFloatingNode, SYIncludeNode, SYIntegerNode, SYNullNode, SYObjectNode, SYStringNode

public interface Node

Method Summary

Modifier and Type	Method and Description
void	addChild(int idx, Node newNode) Adds a child at a specified index.
void	addChild(Node node) Adds a new child.
void	annotate(NodeAnnotation annotation) Adds an annotation to this node
Collection<NodeAnnotation>	annotations() Returns all the annotations of this node
Node	copy() Creates a new copy of this node
<T extends Node> T	findAncestorWith(Class<T> nodeType) Returns the nearest ancestor node that is instance of the specified class
<T extends Node> List<T>	findDescendantsWith(Class<T> nodeType) Returns the list of descendants nodes that are instances of the specified class
Node	get(String selector) Returns the child node that matches the desired selector or null if there is no match
List<Node>	getChildren() All the children
Position	getEndPosition() The end position of this node
Node	getParent() The parent of this node
Node	getRootNode() The ancestor that does not has any parent.
Node	getSource() Return the source of this node.
Position	getStartPosition() The start position of this node
NodeType	getType() Returns the type of this node
void	removeChild(Node node) Removes a child.
void	removeChildren() Removes all the children of this given node.
void	replaceTree(Node newSubTree) Replace this subtree with the given one.
void	replaceWith(Node newNode) Replace this node in the tree with a new specialized node.
void	setChild(int idx, Node newNode) Sets a child at a specified index.
void	setParent(Node parent) Sets the parent node to this node.
void	setSource(Node source) The source of this node.

Method Detail

getStartPosition

@Nonnull
Position getStartPosition()

The start position of this node

Returns:

The position

getEndPosition

@Nonnull
Position getEndPosition()

The end position of this node

Returns:

The position

getRootNode

Node getRootNode()

The ancestor that does not has any parent. It is the first node that it parent returns null in the parent path.

Returns:

The root node.

getParent

@Nullable
Node getParent()

The parent of this node

Returns:

The parent

getChildren

@Nonnull
List<Node> getChildren()

All the children

Returns:

The Children

addChild

void addChild(Node node)

Adds a new child. The new child is going to have this as a parent

Parameters:

node - Adds a new child to this node

removeChild

void removeChild(Node node)

Removes a child. The new child is going to have this as a parent

Parameters:

node - Adds a new child to this node

setParent

void setParent(Node parent)

Sets the parent node to this node.

Parameters:

parent - The new parent node

setSource

void setSource(Node source)

The source of this node. This is used at transformation phases when the original Yaml node are being replaced by a more specialized node. This way the node specialization can be tracked on all the history changes.

Parameters:

source - The original node.

findDescendantsWith

@Nonnull
<T extends Node> List<T> findDescendantsWith(Class<T> nodeType)

Returns the list of descendants nodes that are instances of the specified class

Type Parameters:

T - The type of the class

Parameters:

nodeType - The class that the node should implement

Returns:

The matching types

findAncestorWith

@Nullable
<T extends Node> T findAncestorWith(Class<T> nodeType)

Returns the nearest ancestor node that is instance of the specified class

Type Parameters:

T - The type of the class

Parameters:

nodeType - The class that the node should implement

Returns:

The matching type or null if none

getSource

@Nullable
Node getSource()

Return the source of this node.

Returns:

The source cause.

get

@Nullable
Node get(String selector)

Returns the child node that matches the desired selector or null if there is no match

replaceWith

void replaceWith(Node newNode)

Replace this node in the tree with a new specialized node. The new node will have as a source this node.

Parameters:

newNode - The new node

setChild

void setChild(int idx,
              Node newNode)

Sets a child at a specified index. The new child is going to have this as a parent

Parameters:

idx - The index

newNode - The new child

addChild

void addChild(int idx,
              Node newNode)

Adds a child at a specified index. The new child is going to have this as a parent

Parameters:

idx - The index

newNode - The new child

copy

@Nonnull
Node copy()

Creates a new copy of this node

Returns:

a new copy of this node

getType

NodeType getType()

Returns the type of this node

Returns:

The node type

removeChildren

void removeChildren()

Removes all the children of this given node.

annotate

void annotate(NodeAnnotation annotation)

Adds an annotation to this node

Parameters:

annotation - The annotation

annotations

Collection<NodeAnnotation> annotations()

Returns all the annotations of this node

Returns:

All the annotations

replaceTree

void replaceTree(Node newSubTree)

Replace this subtree with the given one. Current children are not going to be transferred to the new one

Parameters:

newSubTree - The new subtree