org.scripthelper.debug.model

Interface Parent

All Known Implementing Classes:

AbstractParent, Block, Method

public interface Parent

Represents a parent element.

Method Summary

Modifier and Type	Method and Description
void	addBlock(Block block) Add a block.
void	addComment(int lineNumber) Add a comment.
void	addSentence(Sentence sentence) Add a sentence.
void	addVar(Var var) Add a variable declaration.
default int	countBlocks() Count the number of blocks.
default Block	getBlock(int lineNumber) Return the block for a specified lineNumber.
java.util.SortedMap<java.lang.Integer,Block>	getBlocks() Return the blocks.
java.util.SortedMap<java.lang.Integer,ChildElement>	getChildrenElements() Return the children elements.
default java.lang.String	getContent() Return the String content of the model for the parent.
int	getFirstLine() Return the first line of the parent.
int	getLastLine() Return the last line of the parent.
SourceModel	getModel() Return the root model.
Parent	getParent() Return the element Parent.
int	getReturnLine() Return the return line of the parent.
java.util.SortedMap<java.lang.Integer,Sentence>	getSentences() Return the sentences.
java.util.SortedMap<java.lang.Integer,java.util.List<Var>>	getVars() Return the variable declarations.
default boolean	isBeforeReturnLine(int line) Return true if a line number is before the return line of the parent.
boolean	isComment(int lineNumber) Return true if there is a comment on a line.
default Block	lastBlock() Return the last block.
void	setFirstLine(int firstLine) Set the first line.
void	setLastLine(int lastLine) Set the last line of the parent.
void	setReturnLine(int returnLine) Set the return line of the parent.

Method Detail

getModel

SourceModel getModel()

Return the root model.

Returns:

the root model.

getParent

Parent getParent()

Return the element Parent.

Returns:

the element Parent.

setFirstLine

void setFirstLine(int firstLine)

Set the first line.

Parameters:

firstLine - the first line

getFirstLine

int getFirstLine()

Return the first line of the parent.

Returns:

the first line of the parent

setReturnLine

void setReturnLine(int returnLine)

Set the return line of the parent.

Parameters:

returnLine - the return line of the parent

isBeforeReturnLine

default boolean isBeforeReturnLine(int line)

Return true if a line number is before the return line of the parent.

Parameters:

line - the line number

Returns:

true if the line number is before the return line of the parent

getReturnLine

int getReturnLine()

Return the return line of the parent.

Returns:

the return line of the parent

setLastLine

void setLastLine(int lastLine)

Set the last line of the parent.

Parameters:

lastLine - the last line of the parent

getLastLine

int getLastLine()

Return the last line of the parent.

Returns:

the last line of the parent

addBlock

void addBlock(Block block)

Add a block.

Parameters:

block - the block

getBlocks

java.util.SortedMap<java.lang.Integer,Block> getBlocks()

Return the blocks.

Returns:

the blocks

getChildrenElements

java.util.SortedMap<java.lang.Integer,ChildElement> getChildrenElements()

Return the children elements.

Returns:

the children elements

getBlock

default Block getBlock(int lineNumber)

Return the block for a specified lineNumber.

Parameters:

lineNumber - the line number

Returns:

the block

countBlocks

default int countBlocks()

Count the number of blocks.

Returns:

the number of blocks

lastBlock

default Block lastBlock()

Return the last block.

Returns:

the last block

addSentence

void addSentence(Sentence sentence)

Add a sentence.

Parameters:

sentence - the sentence

getSentences

java.util.SortedMap<java.lang.Integer,Sentence> getSentences()

Return the sentences.

Returns:

the sentences

addComment

void addComment(int lineNumber)

Add a comment.

Parameters:

lineNumber - the line number

isComment

boolean isComment(int lineNumber)

Return true if there is a comment on a line.

Parameters:

lineNumber - the line number

Returns:

true if there is a comment on the line

addVar

void addVar(Var var)

Add a variable declaration.

Parameters:

var - the variable declaration

getVars

java.util.SortedMap<java.lang.Integer,java.util.List<Var>> getVars()

Return the variable declarations.

Returns:

the variable declarations

getContent

default java.lang.String getContent()

Return the String content of the model for the parent.

Returns:

the string content of the model for the parent