org.raml.yagi.framework.nodes

Class BaseNode

java.lang.Object

org.raml.yagi.framework.nodes.BaseNode

All Implemented Interfaces:

Node

Direct Known Subclasses:

AbstractRamlNode, ArrayWrapperNode, JBaseRamlNode, KeyValueNodeImpl, SYBaseRamlNode

public abstract class BaseNode
extends Object
implements Node

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Node>	children

Constructor Summary

Constructors

Constructor and Description
BaseNode()
BaseNode(BaseNode 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
<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
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.raml.yagi.framework.nodes.Node

copy, getEndPosition, getStartPosition, getType

Field Detail

children

protected List<Node> children

Constructor Detail

BaseNode

public BaseNode()

BaseNode

public BaseNode(BaseNode node)

Method Detail

annotate

public void annotate(NodeAnnotation annotation)

Description copied from interface: Node

Adds an annotation to this node

Specified by:

annotate in interface Node

Parameters:

annotation - The annotation

annotations

public Collection<NodeAnnotation> annotations()

Description copied from interface: Node

Returns all the annotations of this node

Specified by:

annotations in interface Node

Returns:

All the annotations

getParent

public Node getParent()

Description copied from interface: Node

The parent of this node

Specified by:

getParent in interface Node

Returns:

The parent

getChildren

@Nonnull
public List<Node> getChildren()

Description copied from interface: Node

All the children

Specified by:

getChildren in interface Node

Returns:

The Children

addChild

public void addChild(Node node)

Description copied from interface: Node

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

Specified by:

addChild in interface Node

Parameters:

node - Adds a new child to this node

removeChild

public void removeChild(Node node)

Description copied from interface: Node

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

Specified by:

removeChild in interface Node

Parameters:

node - Adds a new child to this node

getRootNode

public Node getRootNode()

Description copied from interface: Node

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

Specified by:

getRootNode in interface Node

Returns:

The root node.

findDescendantsWith

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

Description copied from interface: Node

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

Specified by:

findDescendantsWith in interface Node

Type Parameters:

T - The type of the class

Parameters:

nodeType - The class that the node should implement

Returns:

The matching types

findAncestorWith

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

Description copied from interface: Node

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

Specified by:

findAncestorWith in interface Node

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

replaceWith

public void replaceWith(Node newNode)

Description copied from interface: Node

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

Specified by:

replaceWith in interface Node

Parameters:

newNode - The new node

replaceTree

public void replaceTree(Node newSubTree)

Description copied from interface: Node

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

Specified by:

replaceTree in interface Node

Parameters:

newSubTree - The new subtree

removeChildren

public void removeChildren()

Description copied from interface: Node

Removes all the children of this given node.

Specified by:

removeChildren in interface Node

setChild

public void setChild(int idx,
                     Node newNode)

Description copied from interface: Node

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

Specified by:

setChild in interface Node

Parameters:

idx - The index

newNode - The new child

addChild

public void addChild(int idx,
                     Node newNode)

Description copied from interface: Node

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

Specified by:

addChild in interface Node

Parameters:

idx - The index

newNode - The new child

setParent

public void setParent(Node parent)

Description copied from interface: Node

Sets the parent node to this node.

Specified by:

setParent in interface Node

Parameters:

parent - The new parent node

setSource

public void setSource(Node source)

Description copied from interface: Node

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.

Specified by:

setSource in interface Node

Parameters:

source - The original node.

getSource

public Node getSource()

Description copied from interface: Node

Return the source of this node.

Specified by:

getSource in interface Node

Returns:

The source cause.

get

@Nullable
public Node get(String selector)

Description copied from interface: Node

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

Specified by:

get in interface Node