edu.rice.cs.hpc.data.experiment.source.SourceFile Interface Reference

The interface implemented by all source file classes. More...

Inheritance diagram for edu.rice.cs.hpc.data.experiment.source.SourceFile:

[legend]

Collaboration diagram for edu.rice.cs.hpc.data.experiment.source.SourceFile:

[legend]

List of all members.

Public Member Functions
abstract int	getFileID ()
abstract String	getName ()
abstract int	getLineCount ()
abstract InputStream	getStream ()
abstract boolean	isAvailable ()
abstract boolean	hasLine (int lineNumber)
abstract File	getFilename ()
abstract boolean	isText ()
abstract void	setIsText (boolean bi)
Static Public Attributes
static final SourceFile	NONE = new EmptySourceFile()
	Empty source file for use by scopes which logically lack a source file.

---

Detailed Description

The interface implemented by all source file classes.

Definition at line 37 of file SourceFile.java.

---

Member Function Documentation

abstract int edu.rice.cs.hpc.data.experiment.source.SourceFile.getFileID

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

Referenced by edu.rice.cs.hpc.data.experiment.scope.visitors.FlatViewScopeVisitor.createFileScope(), and edu.rice.cs.hpc.data.experiment.scope.visitors.FlatViewScopeVisitor.getUniqueFileID().

abstract File edu.rice.cs.hpc.data.experiment.source.SourceFile.getFilename

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

Referenced by edu.rice.cs.hpc.data.experiment.scope.visitors.PrintFlatViewScopeVisitor.printScopeTag().

abstract int edu.rice.cs.hpc.data.experiment.source.SourceFile.getLineCount

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

abstract String edu.rice.cs.hpc.data.experiment.source.SourceFile.getName

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

Referenced by edu.rice.cs.hpc.data.experiment.scope.ProcedureScope.equals(), edu.rice.cs.hpc.viewer.scope.AbstractBaseScopeView.fillContextMenu(), edu.rice.cs.hpc.data.experiment.scope.FileScope.getName(), and edu.rice.cs.hpc.data.experiment.scope.Scope.getSourceCitation().

abstract InputStream edu.rice.cs.hpc.data.experiment.source.SourceFile.getStream

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

abstract boolean edu.rice.cs.hpc.data.experiment.source.SourceFile.hasLine

(

int

lineNumber

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

abstract boolean edu.rice.cs.hpc.data.experiment.source.SourceFile.isAvailable

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

Referenced by edu.rice.cs.hpc.data.experiment.scope.FileScope.getToolTip(), and edu.rice.cs.hpc.viewer.util.Utilities.isFileReadable().

abstract boolean edu.rice.cs.hpc.data.experiment.source.SourceFile.isText

(

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

abstract void edu.rice.cs.hpc.data.experiment.source.SourceFile.setIsText

(

boolean

bi

)

[pure virtual]

Implemented in edu.rice.cs.hpc.data.experiment.source.EmptySourceFile, and edu.rice.cs.hpc.data.experiment.source.FileSystemSourceFile.

Referenced by edu.rice.cs.hpc.data.experiment.xml.BaseExperimentBuilder.begin_PF().

---

Member Data Documentation

final SourceFile edu.rice.cs.hpc.data.experiment.source.SourceFile.NONE = new EmptySourceFile() [static]

Empty source file for use by scopes which logically lack a source file.

Definition at line 45 of file SourceFile.java.

Referenced by edu.rice.cs.hpc.viewer.util.Utilities.isFileReadable().

---

The documentation for this interface was generated from the following file:

• edu.rice.cs.hpc.data/src/edu/rice/cs/hpc/data/experiment/source/SourceFile.java