com.hello2morrow.sonargraph.plugin.api

Interface ISourceFileAccess

All Superinterfaces:

IElementAccess, INamedElementAccess

All Known Subinterfaces:

ICppSourceFileAccess, IJavaSourceFileAccess, IPythonSourceFileAccess

All Known Implementing Classes:

CppSourceFileAccess, CSharpSourceFileAccess, JavaSourceFileAccess, PythonSourceFileAccess, SourceFileAccess

public interface ISourceFileAccess
extends INamedElementAccess

Access interface for source files

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ISourceFileAccess.IVisitor

Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.plugin.api.INamedElementAccess

INamedElementAccess.INamedElementAccessVisitor

Method Summary

Modifier and Type	Method and Description
int	getCodeCommentLinesMetric()
int	getCommentLinesMetric()
TFile	getFile()
int	getLinesOfCodeMetric()
java.lang.String	getPath()
java.util.List<java.lang.String>	getSourceLines(boolean withLineBreaks) Return content of source file
int	getTotalLinesMetric()
boolean	isModified()

Methods inherited from interface com.hello2morrow.sonargraph.plugin.api.INamedElementAccess

accept, getChildren, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively

Methods inherited from interface com.hello2morrow.sonargraph.plugin.api.IElementAccess

getName, getNameWithSignature, getShortName, getShortNameWithSignature, ignoreIssues, isExcluded, isExternal

Method Detail

getSourceLines

java.util.List<java.lang.String> getSourceLines(boolean withLineBreaks)

Return content of source file

Parameters:

withLineBreaks - If true lines will be terminated by line breaks, otherwise line breaks are stripped.

Returns:

List of lines in this source file.

getFile

TFile getFile()

getPath

java.lang.String getPath()

getCodeCommentLinesMetric

int getCodeCommentLinesMetric()

getCommentLinesMetric

int getCommentLinesMetric()

getTotalLinesMetric

int getTotalLinesMetric()

getLinesOfCodeMetric

int getLinesOfCodeMetric()

Returns:

the lines of code metric for this source files (number of non-empty and non-comment lines).

isModified

boolean isModified()