refdiff.core.cst

Class CstNode

java.lang.Object

refdiff.core.cst.CstNode

All Implemented Interfaces:

HasChildrenNodes

public class CstNode
extends java.lang.Object
implements HasChildrenNodes

A node in the Code Structure Tree (CST). It represents a code element in the target programming language. For example, in Java we represent classes, interfaces, enums, and methods as CST nodes.

Constructor Summary

Constructors

Constructor and Description
CstNode(int id)

Method Summary

Modifier and Type	Method and Description
void	addNode(CstNode node)
void	addStereotypes(Stereotype stereotype)
int	getId()
java.lang.String	getLocalName()
Location	getLocation()
java.lang.String	getNamespace()
java.util.List<CstNode>	getNodes()
java.util.List<Parameter>	getParameters()
java.util.Optional<CstNode>	getParent()
java.util.Optional<CstNode>	getRootParent()
java.lang.String	getSimpleName()
java.util.Set<Stereotype>	getStereotypes()
java.lang.String	getType()
boolean	hasStereotype(Stereotype stereotype)
void	setLocalName(java.lang.String logicalName)
void	setLocation(Location location)
void	setNamespace(java.lang.String namespace)
void	setNodes(java.util.List<CstNode> nodes)
void	setParameters(java.util.List<Parameter> parameters)
void	setParent(CstNode node)
void	setSimpleName(java.lang.String simpleName)
void	setStereotypes(java.util.Set<Stereotype> stereotypes)
void	setType(java.lang.String type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CstNode

public CstNode(int id)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public int getId()

Returns:

An unique id of the node in the CST.

getType

public java.lang.String getType()

Returns:

The type of the code element in the target programming language.

setType

public void setType(java.lang.String type)

getLocation

public Location getLocation()

Returns:

The location of the CST node in the source code.

setLocation

public void setLocation(Location location)

getLocalName

public java.lang.String getLocalName()

Returns:

The declared name and signature of the code element that uniquely identifies it whithin its parent node. For example, the local name of m1 may be encoded as "m1(int,String)" in the Java example below.

 class A {
   void m1(int n, String message) {
     // body
   }
 }
 

setLocalName

public void setLocalName(java.lang.String logicalName)

getSimpleName

public java.lang.String getSimpleName()

Returns:

The declared name of the code element. For example, the simple name of m1 is "m1" in the Java example below.

 class A {
   void m1(int n, String message) {
     // body
   }
 }
 

setSimpleName

public void setSimpleName(java.lang.String simpleName)

getNodes

public java.util.List<CstNode> getNodes()

Specified by:

getNodes in interface HasChildrenNodes

Returns:

The children nodes of this node.

addNode

public void addNode(CstNode node)

Specified by:

addNode in interface HasChildrenNodes

setNodes

public void setNodes(java.util.List<CstNode> nodes)

getStereotypes

public java.util.Set<Stereotype> getStereotypes()

setStereotypes

public void setStereotypes(java.util.Set<Stereotype> stereotypes)

addStereotypes

public void addStereotypes(Stereotype stereotype)

hasStereotype

public boolean hasStereotype(Stereotype stereotype)

setParent

public void setParent(CstNode node)

getParent

public java.util.Optional<CstNode> getParent()

Returns:

The parent node of this node. Top-level declarations dos not have a parent node.

getRootParent

public java.util.Optional<CstNode> getRootParent()

Returns:

The top-level ancestor node of this node.

getNamespace

public java.lang.String getNamespace()

Returns:

The prefix that should be appended to {#code getLocalName} to uniquely identify this node. Nodes that have a parent should have a null namespace, i.e., only top-level declarations should have a namespace.

In the example below, class A should have "foo." as namespace and "A" as local name.

 package foo;
 
 public class A {
   void m1(int n, String message) {
     // body
   }
 }
 

setNamespace

public void setNamespace(java.lang.String namespace)

getParameters

public java.util.List<Parameter> getParameters()

setParameters

public void setParameters(java.util.List<Parameter> parameters)