org.scripthelper.debug.model

Class SourceModel

java.lang.Object

org.scripthelper.debug.model.SourceModel

All Implemented Interfaces:

java.lang.Cloneable, LineNumberConverter

Direct Known Subclasses:

DebugSourceModel

public class SourceModel
extends java.lang.Object
implements LineNumberConverter, java.lang.Cloneable

The source model models the source of a script.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	countImportLines The number of import lines in the initial script.
protected java.util.SortedMap<java.lang.Integer,Var>	fields The fields.
protected boolean	hasSingletonMethod True if there is a singleton method.
protected java.util.SortedMap<java.lang.Integer,Method>	methods The methods.

Constructor Summary

Constructors

Constructor and Description
SourceModel(java.lang.String scriptContent, boolean hasSingletonMethod, int offset, int countImportLines) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addField(Var var) Add a field.
void	addMethod(Method method) Add a method.
SourceModel	clone()
int	countImportLines() Return the number of import lines.
java.util.SortedMap<java.lang.Integer,Var>	getFields() Return the fields.
java.util.SortedSet<Var>	getFieldVariables() Return the list of variables seen in a specified line number.
int	getFirstLine() Return the first effective line of the script, after the import declarations.
int	getLineNumber(int lineNumber, boolean isException) Return the effective line number of a line detected in the script runtime.
java.util.SortedMap<java.lang.Integer,Method>	getMethods() Return the methods.
int	getOffset() Return the offset.
java.lang.String	getScriptContent() Return the script content.
java.lang.String	getSource(int lineNumber) Return the source for a line number.
java.util.SortedSet<Var>	getVariables(int lineNumber) Return the list of variables seen in a specified line number.
boolean	hasSingletonMethod() Return true if there is a singleton method.
protected void	replace(SourceModel model) Replace the content of the model.
void	setFirstLine(int firstLine) Set the first effective line of the script, after the import declarations.
void	setScriptContent(java.lang.String scriptContent) Set the script content.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.model.LineNumberConverter

getLineNumber

Field Detail

hasSingletonMethod

protected boolean hasSingletonMethod

True if there is a singleton method.

countImportLines

protected int countImportLines

The number of import lines in the initial script.

fields

protected final java.util.SortedMap<java.lang.Integer,Var> fields

The fields.

methods

protected final java.util.SortedMap<java.lang.Integer,Method> methods

The methods.

Constructor Detail

SourceModel

public SourceModel(java.lang.String scriptContent,
                   boolean hasSingletonMethod,
                   int offset,
                   int countImportLines)

Constructor.

Parameters:

scriptContent - the script content

hasSingletonMethod - true if there is a singleton method

offset - the line offset

countImportLines - the number of specific import lines in the script

Method Detail

setScriptContent

public void setScriptContent(java.lang.String scriptContent)

Set the script content.

Parameters:

scriptContent - the script content

hasSingletonMethod

public boolean hasSingletonMethod()

Return true if there is a singleton method.

Returns:

true if there is a singleton method

getOffset

public int getOffset()

Return the offset. The offset is the number of lines between the beginning of the script and the first method.

Returns:

the offset

countImportLines

public int countImportLines()

Return the number of import lines.

Returns:

the number of import lines

replace

protected final void replace(SourceModel model)
                      throws java.lang.CloneNotSupportedException

Replace the content of the model.

Parameters:

model - the source model

Throws:

java.lang.CloneNotSupportedException

clone

public SourceModel clone()
                  throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getScriptContent

public java.lang.String getScriptContent()

Return the script content.

Returns:

the script content

setFirstLine

public void setFirstLine(int firstLine)

Set the first effective line of the script, after the import declarations.

Parameters:

firstLine - the first effective line of the script

getFirstLine

public int getFirstLine()

Return the first effective line of the script, after the import declarations.

Returns:

the first effective line of the script

addMethod

public void addMethod(Method method)

Add a method.

Parameters:

method - the method

addField

public void addField(Var var)

Add a field.

Parameters:

var - the field

getFieldVariables

public java.util.SortedSet<Var> getFieldVariables()

Return the list of variables seen in a specified line number.

Returns:

the set of fields

getVariables

public java.util.SortedSet<Var> getVariables(int lineNumber)

Return the list of variables seen in a specified line number.

Parameters:

lineNumber - the line number

Returns:

the set of variables

getFields

public java.util.SortedMap<java.lang.Integer,Var> getFields()

Return the fields.

Returns:

the fields

getMethods

public java.util.SortedMap<java.lang.Integer,Method> getMethods()

Return the methods.

Returns:

the methods

getLineNumber

public int getLineNumber(int lineNumber,
                         boolean isException)

Return the effective line number of a line detected in the script runtime.

Specified by:

getLineNumber in interface LineNumberConverter

Parameters:

lineNumber - the line number

isException - true for getting the line number for an exception

Returns:

the effective line number

getSource

public java.lang.String getSource(int lineNumber)

Return the source for a line number.

Parameters:

lineNumber - the line number

Returns:

the source