com.hello2morrow.sonargraph.core.controller.system.script

Class SourceFileAccess

java.lang.Object

com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess<SourceFile>

com.hello2morrow.sonargraph.core.controller.system.script.SourceFileAccess

All Implemented Interfaces:

IElementAccess, INamedElementAccess, ISourceFileAccess

Direct Known Subclasses:

CppSourceFileAccess, CSharpSourceFileAccess, JavaSourceFileAccess, PythonSourceFileAccess

public class SourceFileAccess
extends ElementAccess<SourceFile>
implements ISourceFileAccess

An access object for source files.

Nested Class Summary

Nested classes/interfaces inherited from class com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess

ElementAccess.IAccessFactory

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

ISourceFileAccess.IVisitor

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

INamedElementAccess.INamedElementAccessVisitor

Method Summary

Modifier and Type	Method and Description
void	accept(INamedElementAccess.INamedElementAccessVisitor visitor) Internal
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 class com.hello2morrow.sonargraph.core.controller.system.script.ElementAccess

equals, getChildren, getElement, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getName, getNameWithSignature, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively, getShortName, getShortNameWithSignature, hashCode, ignoreIssues, isExcluded, isExternal, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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

getLinesOfCodeMetric

public final int getLinesOfCodeMetric()

Specified by:

getLinesOfCodeMetric in interface ISourceFileAccess

Returns:

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

getTotalLinesMetric

public final int getTotalLinesMetric()

Specified by:

getTotalLinesMetric in interface ISourceFileAccess

Returns:

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

getCommentLinesMetric

public final int getCommentLinesMetric()

Specified by:

getCommentLinesMetric in interface ISourceFileAccess

Returns:

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

getCodeCommentLinesMetric

public final int getCodeCommentLinesMetric()

Specified by:

getCodeCommentLinesMetric in interface ISourceFileAccess

Returns:

the number of comment lines excluding header comments for this source files (number of non-empty and non-comment lines).

getPath

public final java.lang.String getPath()

Specified by:

getPath in interface ISourceFileAccess

Returns:

the path of this source file or 'null' if there is no physical source file.

getFile

public final TFile getFile()

Specified by:

getFile in interface ISourceFileAccess

Returns:

the file object for this source file or 'null' if there is no physical source file.

getSourceLines

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

Description copied from interface: ISourceFileAccess

Return content of source file

Specified by:

getSourceLines in interface ISourceFileAccess

Parameters:

withLineBreaks - 'true' if the line breaks should be included or 'false' otherwise

Returns:

the source lines or 'null' if there is no physical source file.

isModified

public boolean isModified()

Specified by:

isModified in interface ISourceFileAccess

accept

public void accept(INamedElementAccess.INamedElementAccessVisitor visitor)

Internal

Specified by:

accept in interface INamedElementAccess

Overrides:

accept in class ElementAccess<SourceFile>

Parameters:

visitor - The visitor implementation