com.hello2morrow.sonargraph.languageprovider.cplusplus.controller.system.script

Class CppSourceFileAccess

java.lang.Object

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

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

com.hello2morrow.sonargraph.languageprovider.cplusplus.controller.system.script.CppSourceFileAccess

All Implemented Interfaces:

ICppSourceFileAccess, IElementAccess, INamedElementAccess, ISourceFileAccess

public final class CppSourceFileAccess
extends SourceFileAccess
implements ICppSourceFileAccess

Access object for C/C++ 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
java.util.List<CppCompilationUnitFragmentAccess>	getIncludedFiles() Returns a list of included header files packaged as CppCompilationUnitFragments.
java.util.List<CppSourceFileAccess>	getIncluders() Get a list of source files including this file.
boolean	isIncludeFile() Return true, if this file is included by other source files.

Methods inherited from class com.hello2morrow.sonargraph.core.controller.system.script.SourceFileAccess

accept, getCodeCommentLinesMetric, getCommentLinesMetric, getFile, getLinesOfCodeMetric, getPath, getSourceLines, getTotalLinesMetric, 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.ISourceFileAccess

getCodeCommentLinesMetric, getCommentLinesMetric, getFile, getLinesOfCodeMetric, getPath, getSourceLines, getTotalLinesMetric, 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

isIncludeFile

public boolean isIncludeFile()

Return true, if this file is included by other source files.

Specified by:

isIncludeFile in interface ICppSourceFileAccess

Returns:

see above

getIncluders

public java.util.List<CppSourceFileAccess> getIncluders()

Get a list of source files including this file.

Specified by:

getIncluders in interface ICppSourceFileAccess

Returns:

see above

getIncludedFiles

public java.util.List<CppCompilationUnitFragmentAccess> getIncludedFiles()

Returns a list of included header files packaged as CppCompilationUnitFragments. Only works if isIncludeFile() returns false. To find the include files included by a header file start at the compilation unit (the source file) and then walk the tree by asking CppCompilationUnitFragment's for their includes.

Returns:

see above