de.uka.ipd.sdq.beagle.core

Class CodeSection

java.lang.Object

de.uka.ipd.sdq.beagle.core.CodeSection

All Implemented Interfaces:

Serializable

public class CodeSection
extends Object
implements Serializable

Describes a section in examined software’s source code. Code sections may span multiple methods, types and compilation units. They are defined by a start statement in one source code file and an end statement in another source code file that may or may not be the same as the first one. A statement is identified by the index of the statement’s first character in its source file. Code sections are immutable, meaning that once created, their attributes cannot be changed.

A code section must describe a continuous part of source code, meaning that the last statement in the section will always be executed if the first one was executed, given that no Exceptions occur. Furthermore, if the last statement is not the same as the first one, the last statement may only be executed after the first one was. All statements that may potentially be executed after the first statement but before the last one are considered to be “in” the section. A code section is considered to have been “completely executed” if the section’s first and last statement were executed. This does generally not mean that all statements in the section were executed. Code Sections no fulfilling these requirements must not be created. However, this is not checked at run time, because doing so would solve the halting problem.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CodeSection(File startFile, int startIndex, File endFile, int endIndex) Creates a code section that spans from the statements starting at startIndex in startFile to the statement starting at endIndex in endFile.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
File	getEndFile() Gets the file that contains this section’s last statement.
int	getEndSectionIndex() Gets the index of the first character of the last statement in this code section.
File	getStartFile() Gets the file that contains this section’s first statement.
int	getStartSectionIndex() Gets the index of the first character of the last statement in this code section.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CodeSection

public CodeSection(File startFile,
                   int startIndex,
                   File endFile,
                   int endIndex)

Creates a code section that spans from the statements starting at startIndex in startFile to the statement starting at endIndex in endFile.

Parameters:

startFile - The file containing this section’s first statement. Must not be null and startFile.isFile() must return true.

startIndex - The index of this section’s first statement’s first character in startFile. Counting starts at 0.

endFile - The file containing this section’s last statement. Must not be null and endFile.isFile() must return true.

endIndex - The index of this section’s last statement’s first character in endFile. Counting starts at 0.

Throws:

IllegalArgumentException - When startFile.isFile() or endFile.isFile() returned false.

RuntimeException - If startFile or endFile cannot be read.

Method Detail

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getEndFile

public File getEndFile()

Gets the file that contains this section’s last statement.

Returns:

The file containing this section’s last statement. Will never be null and getEndFile().isFile() always returns true.

getEndSectionIndex

public int getEndSectionIndex()

Gets the index of the first character of the last statement in this code section. Counting starts at 0. The number thus describes how many characters precede the section’s last statement in the end source code file.

Returns:

The last statement’s index. A non-negative integer.

getStartFile

public File getStartFile()

Gets the file that contains this section’s first statement.

Returns:

The file containing this section’s first statement. Will never be null and getStartFile().isFile() always returns true.

getStartSectionIndex

public int getStartSectionIndex()

Gets the index of the first character of the last statement in this code section. Counting starts at 0. The number thus describes how many characters precede the section’s last statement in the end source code file.

Returns:

The first statement’s index. A non-negative integer.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object