java.lang.Object
- com.hello2morrow.sonargraph.core.api.model.ElementAccess<com.hello2morrow.sonargraph.core.model.path.SourceFile>
- - com.hello2morrow.sonargraph.core.api.model.SourceFileAccess

All Implemented Interfaces:

IElementAccess, INamedElementAccess, ISourceFileAccess

Direct Known Subclasses:

CppSourceFileAccess, CSharpSourceFileAccess, JavaSourceFileAccess, PythonSourceFileAccess
```
public class SourceFileAccess
extends ElementAccess<com.hello2morrow.sonargraph.core.model.path.SourceFile>
implements ISourceFileAccess
```
An access object for 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

SourceFileAccess(com.hello2morrow.sonargraph.core.model.path.SourceFile element)
Internal use only

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(INamedElementAccess.INamedElementAccessVisitor visitor)`	Internal
`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()`
`java.lang.Object`	`getMetricLevel()`	Internal use only
`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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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
getChildren, getFullyQualifiedName, getIncomingDependenciesRecursively, getIncomingDependenciesRecursively, getIssueCount, getIssueCount, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getOutgoingDependenciesRecursively, getParent, getParent, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencedElementsRecursively, getReferencingElementsRecursively, getReferencingElementsRecursively

- Constructor Detail
  - SourceFileAccess
```
public SourceFileAccess(com.hello2morrow.sonargraph.core.model.path.SourceFile element)
```
    Internal use only
- 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).
  - getMaxNestingMetric
```
public int getMaxNestingMetric()
```
    Specified by:
    
    getMaxNestingMetric in interface ISourceFileAccess
  - getAverageComplexityMetric
```
public float getAverageComplexityMetric()
```
    Specified by:
    
    getAverageComplexityMetric in interface ISourceFileAccess
  - getAverageNestingMetric
```
public float getAverageNestingMetric()
```
    Specified by:
    
    getAverageNestingMetric in interface ISourceFileAccess
  - getChangeCount30
```
public int getChangeCount30()
```
    Specified by:
    
    getChangeCount30 in interface ISourceFileAccess
  - getChangeCount90
```
public int getChangeCount90()
```
    Specified by:
    
    getChangeCount90 in interface ISourceFileAccess
  - getChangeCount365
```
public int getChangeCount365()
```
    Specified by:
    
    getChangeCount365 in interface ISourceFileAccess
  - getChurn30
```
public int getChurn30()
```
    Specified by:
    
    getChurn30 in interface ISourceFileAccess
  - getChurn90
```
public int getChurn90()
```
    Specified by:
    
    getChurn90 in interface ISourceFileAccess
  - getChurn365
```
public int getChurn365()
```
    Specified by:
    
    getChurn365 in interface ISourceFileAccess
  - getChurnRate30
```
public float getChurnRate30()
```
    Specified by:
    
    getChurnRate30 in interface ISourceFileAccess
  - getChurnRate90
```
public float getChurnRate90()
```
    Specified by:
    
    getChurnRate90 in interface ISourceFileAccess
  - getChurnRate365
```
public float getChurnRate365()
```
    Specified by:
    
    getChurnRate365 in interface ISourceFileAccess
  - getNumberOfAuthors
```
public int getNumberOfAuthors()
```
    Specified by:
    
    getNumberOfAuthors in interface ISourceFileAccess
  - 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 de.schlichtherle.truezip.file.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.
  - getMetricLevel
```
public final java.lang.Object getMetricLevel()
```
    Description copied from class: ElementAccess
    
    Internal use only
    
    Overrides:
    
    getMetricLevel in class ElementAccess<com.hello2morrow.sonargraph.core.model.path.SourceFile>
  - getSourceLines
```
public final java.util.List<java.lang.String> getSourceLines(boolean withLineBreaks)
```
    Description copied from interface: ISourceFileAccess
    
    Return raw content of source file.
    
    Specified by:
    
    getSourceLines in interface ISourceFileAccess
    
    Parameters:
    
    withLineBreaks - If true lines will be terminated by line breaks, otherwise line breaks are stripped.
    
    Returns:
    
    List of lines in this source file.
  - getSourceLines
```
public final java.util.List<ISourceLineAccess> getSourceLines()
```
    Specified by:
    
    getSourceLines in interface ISourceFileAccess
    
    Returns:
    
    the content of a source file, line by line.
    The ISourceLineAccess allow the creation of context-aware issues, so that resolutions can be applied even if line is changed in the future.
  - 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<com.hello2morrow.sonargraph.core.model.path.SourceFile>
    
    Parameters:
    
    visitor - The visitor implementation
  - getAuthors
```
public java.util.Set<java.lang.String> getAuthors(IScmPeriod period)
```
    Specified by:
    
    getAuthors in interface ISourceFileAccess

Class SourceFileAccess

Nested Class Summary

Nested classes/interfaces inherited from class com.hello2morrow.sonargraph.core.api.model.ElementAccess

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

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

Constructor Summary

Method Summary

Methods inherited from class com.hello2morrow.sonargraph.core.api.model.ElementAccess

Methods inherited from class java.lang.Object

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

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

Constructor Detail

SourceFileAccess

Method Detail

getLinesOfCodeMetric

getTotalLinesMetric

getCommentLinesMetric

getCodeCommentLinesMetric

getMaxNestingMetric

getAverageComplexityMetric

getAverageNestingMetric

getChangeCount30

getChangeCount90

getChangeCount365

getChurn30

getChurn90

getChurn365

getChurnRate30

getChurnRate90

getChurnRate365

getNumberOfAuthors

getPath

getFile

getMetricLevel

getSourceLines

getSourceLines

isModified

accept

getAuthors