jeb.api.ast

Interface IElement

All Known Subinterfaces:

IExpression, ILeftExpression

All Known Implementing Classes:

ArrayElt, Assignment, Block, Break, Call, Class, Compound, ConditionalExpression, Constant, Continue, Definition, DoWhileStm, Expression, Field, ForStm, Goto, Identifier, IfStm, InstanceField, Label, Method, Monitor, New, NewArray, NonStatement, Predicate, Return, Statement, StaticField, SwitchStm, Throw, TryStm, TypeReference, WhileStm

public interface IElement

Base interface for all elements of an Abstract Syntax Tree.

Every AST element implements this interface, either via:

• the NonStatement abstract class. Examples: Method, Constant, StaticField, etc.
• the Statement abstract class. Examples: Assignment, Continue, WhileStm, etc.

Since version 1.5.201404100, AST elements can be annotated.

Since:

1.4.201309040

Method Summary

Modifier and Type	Method and Description
void	attachTag(java.lang.String name, java.lang.Object data) Attach a tag to that element.
java.util.List<IElement>	getSubElements() Get the list of elements contained within this element.
boolean	replaceSubElement(IElement old_elt, IElement new_elt) Replace an element by another element.
java.lang.Object	retrieveTag(java.lang.String name) Retrieve tag data by name.

Method Detail

getSubElements

java.util.List<IElement> getSubElements()

Get the list of elements contained within this element.

Example: a Method contains a list of Definition to represent the method parameters, as well as a Block element to represent the method's body.

Returns:

the list of child elements, may be empty but never null

Since:

1.4.201309040

replaceSubElement

boolean replaceSubElement(IElement old_elt,
                          IElement new_elt)

Replace an element by another element. Be careful when using this method: no semantic checks are performed on the new and old elements, and the the AST can be corrupted.

Parameters:

old_elt - the element to be replaced

new_elt - the new element

Returns:

true if an element was replaced, false otherwise

Since:

1.4.201309040

attachTag

void attachTag(java.lang.String name,
               java.lang.Object data)

Attach a tag to that element.

Parameters:

name - the optional tag name (can be null to denote the nameless tag)

data - the mandatory tag data

Since:

1.5.201404100

retrieveTag

java.lang.Object retrieveTag(java.lang.String name)

Retrieve tag data by name.

Parameters:

name - the tag name (can be null to retrieve the nameless tag)

Returns:

the tag data, null if no tag matching the provided name was found

Since:

1.5.201404100