Class CppSourceFileAccess
- java.lang.Object
-
- com.hello2morrow.sonargraph.core.api.model.ElementAccess<com.hello2morrow.sonargraph.core.model.path.SourceFile>
-
- com.hello2morrow.sonargraph.core.api.model.SourceFileAccess
-
- com.hello2morrow.sonargraph.languageprovider.cplusplus.api.model.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.api.model.ElementAccess
ElementAccess.IAccessFactory
-
Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.api.model.INamedElementAccess
INamedElementAccess.INamedElementAccessVisitor
-
Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.api.model.ISourceFileAccess
ISourceFileAccess.IVisitor
-
-
Constructor Summary
Constructors Constructor Description CppSourceFileAccess(com.hello2morrow.sonargraph.languageprovider.cplusplus.model.path.CppSource element)
Internal use only
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.api.model.SourceFileAccess
accept, getAuthors, getAverageComplexityMetric, getAverageNestingMetric, getChangeCount30, getChangeCount365, getChangeCount90, getChurn30, getChurn365, getChurn90, getChurnRate30, getChurnRate365, getChurnRate90, getCodeCommentLinesMetric, getCommentLinesMetric, getFile, getLinesOfCodeMetric, getMaxNestingMetric, getMetricLevel, getNumberOfAuthors, getPath, getSourceLines, getSourceLines, getTotalLinesMetric, isModified
-
Methods inherited from class com.hello2morrow.sonargraph.core.api.model.ElementAccess
equals, getChildren, getElement, getFullyQualifiedName, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getIssueCount, getName, getNameWithSignature, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively, getShortName, getShortNameWithSignature, hashCode, ignoreIssues, isExcluded, isExternal, setFactory, toString
-
Methods inherited from interface com.hello2morrow.sonargraph.api.model.IElementAccess
getName, getNameWithSignature, getShortName, getShortNameWithSignature, ignoreIssues, isExcluded, isExternal
-
Methods inherited from interface com.hello2morrow.sonargraph.api.model.INamedElementAccess
accept, getChildren, getFullyQualifiedName, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getIssueCount, getIssueCount, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively
-
Methods inherited from interface com.hello2morrow.sonargraph.api.model.ISourceFileAccess
getAuthors, getAverageComplexityMetric, getAverageNestingMetric, getChangeCount30, getChangeCount365, getChangeCount90, getChurn30, getChurn365, getChurn90, getChurnRate30, getChurnRate365, getChurnRate90, getCodeCommentLinesMetric, getCommentLinesMetric, getFile, getLinesOfCodeMetric, getMaxNestingMetric, getNumberOfAuthors, getPath, getSourceLines, getSourceLines, getTotalLinesMetric, isModified
-
-
-
-
Method Detail
-
isIncludeFile
public boolean isIncludeFile()
Return true, if this file is included by other source files.- Specified by:
isIncludeFile
in interfaceICppSourceFileAccess
- Returns:
- see above
-
getIncluders
public java.util.List<CppSourceFileAccess> getIncluders()
Get a list of source files including this file.- Specified by:
getIncluders
in interfaceICppSourceFileAccess
- 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
-
-