FullFileInfo (OpenClover 4.5.2 API)

java.lang.Object
- com.atlassian.clover.registry.entities.BaseFileInfo
- - com.atlassian.clover.registry.entities.FullFileInfo

All Implemented Interfaces:

EntityContainer, FileInfo, HasClasses, HasContextFilter, HasMethods, HasMetrics, HasParent, HasStatements, InstrumentationInfo, SourceInfo, TaggedPersistent, CoverageDataRange, CoverageDataReceptor, HasMetricsNode
```
public class FullFileInfo
extends BaseFileInfo
implements CoverageDataReceptor, FileInfo, HasMetricsNode, TaggedPersistent
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,FullClassInfo>`	`classes` classes declared inside the file
`protected int`	`dataIndex`
`protected List<FullMethodInfo>`	`methods` methods (functions) declared on the top-level of the file (e.g.
`static long`	`NO_VERSION`
`protected List<FullStatementInfo>`	`statements` statements declared inside the file on the top-level (e.g in scripts)

Fields inherited from class com.atlassian.clover.registry.entities.BaseFileInfo
checksum, containingPackage, contextFilter, encoding, filesize, lineCount, metrics, name, ncLineCount, rawMetrics, timestamp

Constructor Summary

Constructors
Constructor and Description
`FullFileInfo(FullPackageInfo containingPackage, File actualFile, String encoding, int dataIndex, int lineCount, int ncLineCount, long timestamp, long filesize, long checksum, long minVersion)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClass(FullClassInfo classInfo)`
`void`	`addFailStackEntry(int lineNum, StackTraceInfo.TraceEntry traceEntry)`
`void`	`addMethod(FullMethodInfo methodInfo)`
`void`	`addStatement(FullStatementInfo statementInfo)`
`void`	`addVersion(long version)`
`void`	`addVersions(long minVersion, long maxVersion)`
`boolean`	`changedFrom(long checksum, long filesize)`
`FullFileInfo`	`copy(FullPackageInfo pkg, HasMetricsFilter filter)`
`List<? extends ClassInfo>`	`getAllClasses()` Returns list of all classes, including indirect descendants.
`List<? extends MethodInfo>`	`getAllMethods()` Returns list of all methods, including indirect descendants.
`HasMetricsNode`	`getChild(int i)`
`String`	`getChildType()`
`List<? extends ClassInfo>`	`getClasses()` Returns list of classes which are declared on a top-level of this source file (i.e.
`int`	`getDataIndex()`
`int`	`getDataLength()`
`CoverageDataProvider`	`getDataProvider()`
`Map<Integer,List<StackTraceInfo.TraceEntry>>`	`getFailStackEntries()`
`int`	`getIndexOfChild(HasMetricsNode child)`
`Language`	`getLanguage()`
`LineInfo[]`	`getLineInfo(boolean showLambdaFunctions, boolean showInnerFunctions)`
`LineInfo[]`	`getLineInfo(int ensureLineCountAtLeast, boolean showLambdaFunctions, boolean showInnerFunctions)`
`long`	`getMaxVersion()`
`List<? extends MethodInfo>`	`getMethods()` Returns list of methods which are declared on a top-level of this source file.
`BlockMetrics`	`getMetrics()`
`long`	`getMinVersion()`
`ClassInfo`	`getNamedClass(String name)`
`int`	`getNumChildren()`
`File`	`getPhysicalFile()`
`BlockMetrics`	`getRawMetrics()`
`Reader`	`getSourceReader()`
`Set<SourceInfo>`	`getSourceRegions()`
`List<? extends StatementInfo>`	`getStatements()` Returns list of statements which are declared on a top-level of this source file.
`Set<TestCaseInfo>`	`getUniqueFailingTests()`
`boolean`	`isEmpty()` Returns true if the file does not contain any inner code entities.
`boolean`	`isLeaf()`
`static FullFileInfo`	`read(TaggedDataInput in)`
`void`	`resetVersions(long version)`
`void`	`resolve(Path path)`
`void`	`setComparator(Comparator cmp)`
`void`	`setDataIndex(int dataIndex)`
`void`	`setDataLength(int length)`
`void`	`setDataProvider(CoverageDataProvider data)`
`void`	`setFailStackEntries(Map<Integer,List<StackTraceInfo.TraceEntry>> entries)`
`boolean`	`supportsVersion(long version)`
`boolean`	`validatePhysicalFile()`
`void`	`visitElements(FileElementVisitor visitor)`
`void`	`write(TaggedDataOutput out)`

Methods inherited from class com.atlassian.clover.registry.entities.BaseFileInfo
equals, getChecksum, getContainingPackage, getContextFilter, getEncoding, getEndColumn, getEndLine, getFilesize, getLineCount, getName, getNcLineCount, getPackagePath, getParent, getStartColumn, getStartLine, getTimestamp, hashCode, isTestFile, setContainingPackage, setMetrics, visit

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.clover.api.registry.FileInfo
getChecksum, getContainingPackage, getEncoding, getFilesize, getLineCount, getName, getNcLineCount, getPackagePath, getTimestamp, isTestFile

Methods inherited from interface com.atlassian.clover.api.registry.SourceInfo
getEndColumn, getEndLine, getStartColumn, getStartLine

Methods inherited from interface com.atlassian.clover.api.registry.EntityContainer
visit

Methods inherited from interface com.atlassian.clover.api.registry.HasContextFilter
getContextFilter

Methods inherited from interface com.atlassian.clover.api.registry.HasParent
getParent

Methods inherited from interface com.atlassian.clover.api.registry.HasMetrics
setMetrics

- Field Detail
  - NO_VERSION
```
public static final long NO_VERSION
```
    See Also:
    
    Constant Field Values
  - classes
```
protected Map<String,FullClassInfo> classes
```
    classes declared inside the file
  - statements
```
protected List<FullStatementInfo> statements
```
    statements declared inside the file on the top-level (e.g in scripts)
  - methods
```
protected List<FullMethodInfo> methods
```
    methods (functions) declared on the top-level of the file (e.g. outside classes
  - dataIndex
```
protected int dataIndex
```
- Constructor Detail
  - FullFileInfo
```
public FullFileInfo(FullPackageInfo containingPackage,
                    File actualFile,
                    String encoding,
                    int dataIndex,
                    int lineCount,
                    int ncLineCount,
                    long timestamp,
                    long filesize,
                    long checksum,
                    long minVersion)
```
- Method Detail
  - getDataProvider
```
public CoverageDataProvider getDataProvider()
```
    Specified by:
    
    getDataProvider in interface CoverageDataReceptor
  - setDataProvider
```
public void setDataProvider(CoverageDataProvider data)
```
    Specified by:
    
    setDataProvider in interface CoverageDataReceptor
  - getDataIndex
```
public int getDataIndex()
```
    Specified by:
    
    getDataIndex in interface InstrumentationInfo
    
    Specified by:
    
    getDataIndex in interface CoverageDataRange
    
    Overrides:
    
    getDataIndex in class BaseFileInfo
    
    Returns:
    
    the starting index for this element (or its first child)
  - getDataLength
```
public int getDataLength()
```
    Specified by:
    
    getDataLength in interface InstrumentationInfo
    
    Specified by:
    
    getDataLength in interface CoverageDataRange
    
    Overrides:
    
    getDataLength in class BaseFileInfo
    
    Returns:
    
    the minimum length (from the data index) of coverage data to ensure enough data for this element and all children.
  - getClasses
```
@NotNull
public List<? extends ClassInfo> getClasses()
```
    Description copied from interface: FileInfo
    Returns list of classes which are declared on a top-level of this source file (i.e. it does not return inner classes). Exact content may depend on the programming language, e.g.:
    - Java, Groovy - classes and interfaces
    - Scala - classes, objects, traits
    Specified by:
    
    getClasses in interface FileInfo
    
    Specified by:
    
    getClasses in interface HasClasses
    
    Overrides:
    
    getClasses in class BaseFileInfo
    
    Returns:
    
    List<? extends ClassInfo> - list of classes or empty list if none
  - getAllClasses
```
@NotNull
public List<? extends ClassInfo> getAllClasses()
```
    Description copied from interface: HasClasses
    
    Returns list of all classes, including indirect descendants.
    
    Specified by:
    
    getAllClasses in interface HasClasses
    
    Overrides:
    
    getAllClasses in class BaseFileInfo
    
    Returns:
    
    List<? extends ClassInfo> - list of classes or empty list if none
  - getMethods
```
@NotNull
public List<? extends MethodInfo> getMethods()
```
    Description copied from interface: FileInfo
    Returns list of methods which are declared on a top-level of this source file. Exact content may depend on the programming language, e.g.:
    - Java - not applicable
    - Groovy - methods declared outside a class (in a groovy script)
    - Scala - functions declared outside a class
    Specified by:
    
    getMethods in interface FileInfo
    
    Specified by:
    
    getMethods in interface HasMethods
    
    Overrides:
    
    getMethods in class BaseFileInfo
    
    Returns:
    
    List<? extends MethodInfo> - list of methods or empty list if none
  - getAllMethods
```
@NotNull
public List<? extends MethodInfo> getAllMethods()
```
    Description copied from interface: HasMethods
    
    Returns list of all methods, including indirect descendants.
    
    Specified by:
    
    getAllMethods in interface HasMethods
    
    Overrides:
    
    getAllMethods in class BaseFileInfo
    
    Returns:
    
    List<? extends MethodInfo> - list of methods or empty list if none
  - getStatements
```
@NotNull
public List<? extends StatementInfo> getStatements()
```
    Description copied from interface: FileInfo
    Returns list of statements which are declared on a top-level of this source file. Exact content may depend on the programming language, e.g.:
    - Java - not applicable (it's not possible to write statements outside a class)
    - Groovy - methods declared outside a class (in a groovy script)
    - Scala - functions declared outside a class
    Specified by:
    
    getStatements in interface FileInfo
    
    Specified by:
    
    getStatements in interface HasStatements
    
    Overrides:
    
    getStatements in class BaseFileInfo
    
    Returns:
    
    List<? extends MethodInfo> - list of methods or empty list if none
  - getMetrics
```
public BlockMetrics getMetrics()
```
    Specified by:
    
    getMetrics in interface HasMetrics
    
    Overrides:
    
    getMetrics in class BaseFileInfo
  - getRawMetrics
```
public BlockMetrics getRawMetrics()
```
    Specified by:
    
    getRawMetrics in interface HasMetrics
    
    Overrides:
    
    getRawMetrics in class BaseFileInfo
  - getChildType
```
public String getChildType()
```
    Specified by:
    
    getChildType in interface HasMetricsNode
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: FileInfo
    
    Returns true if the file does not contain any inner code entities.
    
    Specified by:
    
    isEmpty in interface FileInfo
    
    Specified by:
    
    isEmpty in interface HasMetricsNode
    
    Overrides:
    
    isEmpty in class BaseFileInfo
    
    Returns:
    
    boolean - true if getClasses() is empty
  - getNumChildren
```
public int getNumChildren()
```
    Specified by:
    
    getNumChildren in interface HasMetricsNode
  - getChild
```
public HasMetricsNode getChild(int i)
```
    Specified by:
    
    getChild in interface HasMetricsNode
  - getIndexOfChild
```
public int getIndexOfChild(HasMetricsNode child)
```
    Specified by:
    
    getIndexOfChild in interface HasMetricsNode
  - isLeaf
```
public boolean isLeaf()
```
    Specified by:
    
    isLeaf in interface HasMetricsNode
  - setComparator
```
public void setComparator(Comparator cmp)
```
    Specified by:
    
    setComparator in interface HasMetricsNode
  - getPhysicalFile
```
public File getPhysicalFile()
```
  - validatePhysicalFile
```
public boolean validatePhysicalFile()
```
  - getSourceRegions
```
public Set<SourceInfo> getSourceRegions()
```
    Returns:
    
    a set of source regions for this file, sorted by start position and length.
  - getLineInfo
```
public LineInfo[] getLineInfo(boolean showLambdaFunctions,
                              boolean showInnerFunctions)
```
  - getLineInfo
```
public LineInfo[] getLineInfo(int ensureLineCountAtLeast,
                              boolean showLambdaFunctions,
                              boolean showInnerFunctions)
```
  - visitElements
```
public void visitElements(FileElementVisitor visitor)
```
  - resolve
```
public void resolve(Path path)
```
  - setDataIndex
```
public void setDataIndex(int dataIndex)
```
  - setDataLength
```
public void setDataLength(int length)
```
  - addVersion
```
public void addVersion(long version)
```
  - addVersions
```
public void addVersions(long minVersion,
                        long maxVersion)
```
  - supportsVersion
```
public boolean supportsVersion(long version)
```
  - getMinVersion
```
public long getMinVersion()
```
  - getMaxVersion
```
public long getMaxVersion()
```
  - resetVersions
```
public void resetVersions(long version)
```
  - changedFrom
```
public boolean changedFrom(long checksum,
                           long filesize)
```
  - addClass
```
public void addClass(FullClassInfo classInfo)
```
  - addMethod
```
public void addMethod(FullMethodInfo methodInfo)
```
  - addStatement
```
public void addStatement(FullStatementInfo statementInfo)
```
  - getNamedClass
```
public ClassInfo getNamedClass(String name)
```
  - copy
```
public FullFileInfo copy(FullPackageInfo pkg,
                         HasMetricsFilter filter)
```
  - getUniqueFailingTests
```
public Set<TestCaseInfo> getUniqueFailingTests()
```
    Returns:
    
    the unique set of tests whose failures touched this class
  - getFailStackEntries
```
public Map<Integer,List<StackTraceInfo.TraceEntry>> getFailStackEntries()
```
  - setFailStackEntries
```
public void setFailStackEntries(Map<Integer,List<StackTraceInfo.TraceEntry>> entries)
```
  - addFailStackEntry
```
public void addFailStackEntry(int lineNum,
                              StackTraceInfo.TraceEntry traceEntry)
```
  - getSourceReader
```
public Reader getSourceReader()
                       throws IOException
```
    Throws:
    
    IOException
  - getLanguage
```
public Language getLanguage()
```
  - write
```
public void write(TaggedDataOutput out)
           throws IOException
```
    Specified by:
    
    write in interface TaggedPersistent
    
    Throws:
    
    IOException
  - read
```
public static FullFileInfo read(TaggedDataInput in)
                         throws IOException
```
    Throws:
    
    IOException

Class FullFileInfo

Field Summary

Fields inherited from class com.atlassian.clover.registry.entities.BaseFileInfo

Constructor Summary

Method Summary

Methods inherited from class com.atlassian.clover.registry.entities.BaseFileInfo

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.clover.api.registry.FileInfo

Methods inherited from interface com.atlassian.clover.api.registry.SourceInfo

Methods inherited from interface com.atlassian.clover.api.registry.EntityContainer

Methods inherited from interface com.atlassian.clover.api.registry.HasContextFilter

Methods inherited from interface com.atlassian.clover.api.registry.HasParent

Methods inherited from interface com.atlassian.clover.api.registry.HasMetrics

Field Detail

NO_VERSION

classes

statements

methods

dataIndex

Constructor Detail

FullFileInfo

Method Detail

getDataProvider

setDataProvider

getDataIndex

getDataLength

getClasses

getAllClasses

getMethods

getAllMethods

getStatements

getMetrics

getRawMetrics

getChildType

isEmpty

getNumChildren

getChild

getIndexOfChild

isLeaf

setComparator

getPhysicalFile

validatePhysicalFile

getSourceRegions

getLineInfo

getLineInfo

visitElements

resolve

setDataIndex

setDataLength

addVersion

addVersions

supportsVersion

getMinVersion

getMaxVersion

resetVersions

changedFrom

addClass

addMethod

addStatement

getNamedClass

copy

getUniqueFailingTests

getFailStackEntries

setFailStackEntries

addFailStackEntry

getSourceReader

getLanguage

write

read