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 Description static interface
ISourceFileAccess.IVisitor
-
Nested classes/interfaces inherited from interface com.hello2morrow.sonargraph.api.model.INamedElementAccess
INamedElementAccess.INamedElementAccessVisitor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Set<java.lang.String>
getAuthors(IScmPeriod period)
float
getAverageComplexityMetric()
float
getAverageNestingMetric()
int
getChangeCount30()
int
getChangeCount365()
int
getChangeCount90()
int
getChurn30()
int
getChurn365()
int
getChurn90()
float
getChurnRate30()
float
getChurnRate365()
float
getChurnRate90()
int
getCodeCommentLinesMetric()
int
getCommentLinesMetric()
de.schlichtherle.truezip.file.TFile
getFile()
int
getLinesOfCodeMetric()
int
getMaxNestingMetric()
int
getNumberOfAuthors()
java.lang.String
getPath()
java.util.List<ISourceLineAccess>
getSourceLines()
java.util.List<java.lang.String>
getSourceLines(boolean withLineBreaks)
Return raw content of source file.int
getTotalLinesMetric()
boolean
isModified()
-
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
-
-
-
-
Method Detail
-
getSourceLines
java.util.List<ISourceLineAccess> getSourceLines()
- Returns:
- the content of a source file, line by line.
TheISourceLineAccess
allow the creation of context-aware issues, so that resolutions can be applied even if line is changed in the future.
-
getSourceLines
java.util.List<java.lang.String> getSourceLines(boolean withLineBreaks)
Return raw 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
de.schlichtherle.truezip.file.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).
-
getMaxNestingMetric
int getMaxNestingMetric()
-
getAverageComplexityMetric
float getAverageComplexityMetric()
-
getAverageNestingMetric
float getAverageNestingMetric()
-
getChangeCount30
int getChangeCount30()
-
getChangeCount90
int getChangeCount90()
-
getChangeCount365
int getChangeCount365()
-
getChurn30
int getChurn30()
-
getChurn90
int getChurn90()
-
getChurn365
int getChurn365()
-
getChurnRate30
float getChurnRate30()
-
getChurnRate90
float getChurnRate90()
-
getChurnRate365
float getChurnRate365()
-
getNumberOfAuthors
int getNumberOfAuthors()
-
getAuthors
java.util.Set<java.lang.String> getAuthors(IScmPeriod period)
-
isModified
boolean isModified()
-
-