BaseFileInfo (OpenClover 4.5.2 API)

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

All Implemented Interfaces:

EntityContainer, FileInfo, HasClasses, HasContextFilter, HasMethods, HasMetrics, HasParent, HasStatements, InstrumentationInfo, SourceInfo

Direct Known Subclasses:

FullFileInfo
```
public class BaseFileInfo
extends Object
implements FileInfo
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`checksum`
`protected BasePackageInfo`	`containingPackage`
`protected ContextSet`	`contextFilter`
`protected String`	`encoding`
`protected long`	`filesize`
`protected int`	`lineCount`
`protected BlockMetrics`	`metrics`
`protected String`	`name`
`protected int`	`ncLineCount`
`protected BlockMetrics`	`rawMetrics`
`protected long`	`timestamp`

Constructor Summary

Constructors
Constructor and Description
`BaseFileInfo(BasePackageInfo containingPackage, String name, String encoding, int lineCount, int ncLineCount, long timestamp, long filesize, long checksum)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`List<? extends ClassInfo>`	`getAllClasses()` Returns list of all classes, including indirect descendants.
`List<? extends MethodInfo>`	`getAllMethods()` Returns list of all methods, including indirect descendants.
`long`	`getChecksum()`
`List<? extends ClassInfo>`	`getClasses()` Returns list of classes which are declared on a top-level of this source file (i.e.
`PackageInfo`	`getContainingPackage()` Returns a package for which this package belongs to (or the default package) Note: it supports only one package namespace per source file
`ContextSet`	`getContextFilter()` Returns context filter for the entity, i.e set of custom statement/method contexts as well as Clover's built-in code contexts.
`int`	`getDataIndex()`
`int`	`getDataLength()`
`String`	`getEncoding()` Returns file encoding, e.g.
`int`	`getEndColumn()`
`int`	`getEndLine()`
`long`	`getFilesize()` Returns file size in bytes
`int`	`getLineCount()` Returns number of source lines in a file
`List<? extends MethodInfo>`	`getMethods()` Returns list of methods which are declared on a top-level of this source file.
`BlockMetrics`	`getMetrics()`
`String`	`getName()` Returns source file name
`int`	`getNcLineCount()` Returns number of non-comment and non-empty source lines in a file.
`String`	`getPackagePath()` Returns a file name with a package path, e.g.
`EntityContainer`	`getParent()`
`BlockMetrics`	`getRawMetrics()`
`int`	`getStartColumn()`
`int`	`getStartLine()`
`List<? extends StatementInfo>`	`getStatements()` Returns list of statements which are declared on a top-level of this source file.
`long`	`getTimestamp()` Returns file modification time stamp as per File.lastModified()
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns true if the file does not contain any inner code entities.
`boolean`	`isTestFile()` Returns true if this is a test file (according to the test pattern defined during instrumentation)
`void`	`setContainingPackage(BasePackageInfo containingPackage)`
`void`	`setMetrics(BlockMetrics metrics)`
`void`	`visit(EntityVisitor entityVisitor)` Visit yourself

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

- Field Detail
  - name
```
protected String name
```
  - encoding
```
protected String encoding
```
  - lineCount
```
protected int lineCount
```
  - ncLineCount
```
protected int ncLineCount
```
  - timestamp
```
protected long timestamp
```
  - filesize
```
protected long filesize
```
  - checksum
```
protected long checksum
```
  - containingPackage
```
protected transient BasePackageInfo containingPackage
```
  - rawMetrics
```
protected transient BlockMetrics rawMetrics
```
  - metrics
```
protected transient BlockMetrics metrics
```
  - contextFilter
```
protected transient ContextSet contextFilter
```
- Constructor Detail
  - BaseFileInfo
```
public BaseFileInfo(BasePackageInfo containingPackage,
                    String name,
                    String encoding,
                    int lineCount,
                    int ncLineCount,
                    long timestamp,
                    long filesize,
                    long checksum)
```
- Method Detail
  - isTestFile
```
public boolean isTestFile()
```
    Description copied from interface: FileInfo
    
    Returns true if this is a test file (according to the test pattern defined during instrumentation)
    
    Specified by:
    
    isTestFile in interface FileInfo
    
    Returns:
    
    boolean - true if it's a test file, false otherwise
  - 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
    
    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
    
    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
    
    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
    
    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
    
    Returns:
    
    List<? extends MethodInfo> - list of methods or empty list if none
  - getName
```
public String getName()
```
    Description copied from interface: FileInfo
    
    Returns source file name
    
    Specified by:
    
    getName in interface FileInfo
    
    Specified by:
    
    getName in interface HasMetrics
    
    Returns:
    
    String
  - getMetrics
```
public BlockMetrics getMetrics()
```
    Specified by:
    
    getMetrics in interface HasMetrics
  - setMetrics
```
public void setMetrics(BlockMetrics metrics)
```
    Specified by:
    
    setMetrics in interface HasMetrics
  - getRawMetrics
```
public BlockMetrics getRawMetrics()
```
    Specified by:
    
    getRawMetrics in interface HasMetrics
  - getEncoding
```
public String getEncoding()
```
    Description copied from interface: FileInfo
    
    Returns file encoding, e.g. "UTF-8"
    
    Specified by:
    
    getEncoding in interface FileInfo
    
    Returns:
    
    String
  - getTimestamp
```
public long getTimestamp()
```
    Description copied from interface: FileInfo
    
    Returns file modification time stamp as per File.lastModified()
    
    Specified by:
    
    getTimestamp in interface FileInfo
    
    Returns:
    
    long time stamp
  - getFilesize
```
public long getFilesize()
```
    Description copied from interface: FileInfo
    
    Returns file size in bytes
    
    Specified by:
    
    getFilesize in interface FileInfo
    
    Returns:
    
    long size
  - getChecksum
```
public long getChecksum()
```
    Specified by:
    
    getChecksum in interface FileInfo
  - getPackagePath
```
public String getPackagePath()
```
    Description copied from interface: FileInfo
    
    Returns a file name with a package path, e.g. "com/acme/Foo.java" Note: it supports only one package namespace per source file
    
    Specified by:
    
    getPackagePath in interface FileInfo
    
    Returns:
    
    String package path
  - getContainingPackage
```
public PackageInfo getContainingPackage()
```
    Description copied from interface: FileInfo
    
    Returns a package for which this package belongs to (or the default package) Note: it supports only one package namespace per source file
    
    Specified by:
    
    getContainingPackage in interface FileInfo
    
    Returns:
    
    PackageInfo
  - setContainingPackage
```
public void setContainingPackage(BasePackageInfo containingPackage)
```
  - getParent
```
public EntityContainer getParent()
```
    Specified by:
    
    getParent in interface HasParent
  - getContextFilter
```
public ContextSet getContextFilter()
```
    Description copied from interface: HasContextFilter
    
    Returns context filter for the entity, i.e set of custom statement/method contexts as well as Clover's built-in code contexts.
    
    Specified by:
    
    getContextFilter in interface HasContextFilter
    
    Returns:
    
    ContextSet
  - getLineCount
```
public int getLineCount()
```
    Description copied from interface: FileInfo
    
    Returns number of source lines in a file
    
    Specified by:
    
    getLineCount in interface FileInfo
    
    Returns:
    
    int
  - getNcLineCount
```
public int getNcLineCount()
```
    Description copied from interface: FileInfo
    
    Returns number of non-comment and non-empty source lines in a file.
    
    Specified by:
    
    getNcLineCount in interface FileInfo
    
    Returns:
    
    int
  - 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
    
    Returns:
    
    boolean - true if getClasses() is empty
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getDataIndex
```
public int getDataIndex()
```
    Specified by:
    
    getDataIndex in interface InstrumentationInfo
  - getDataLength
```
public int getDataLength()
```
    Specified by:
    
    getDataLength in interface InstrumentationInfo
  - getStartLine
```
public int getStartLine()
```
    Specified by:
    
    getStartLine in interface SourceInfo
  - getStartColumn
```
public int getStartColumn()
```
    Specified by:
    
    getStartColumn in interface SourceInfo
  - getEndLine
```
public int getEndLine()
```
    Specified by:
    
    getEndLine in interface SourceInfo
  - getEndColumn
```
public int getEndColumn()
```
    Specified by:
    
    getEndColumn in interface SourceInfo
  - visit
```
public void visit(EntityVisitor entityVisitor)
```
    Visit yourself
    
    Specified by:
    
    visit in interface EntityContainer
    
    Parameters:
    
    entityVisitor - callback

Class BaseFileInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

encoding

lineCount

ncLineCount

timestamp

filesize

checksum

containingPackage

rawMetrics

metrics

contextFilter

Constructor Detail

BaseFileInfo

Method Detail

isTestFile

getClasses

getAllClasses

getMethods

getAllMethods

getStatements

getName

getMetrics

setMetrics

getRawMetrics

getEncoding

getTimestamp

getFilesize

getChecksum

getPackagePath

getContainingPackage

setContainingPackage

getParent

getContextFilter

getLineCount

getNcLineCount

isEmpty

hashCode

equals

getDataIndex

getDataLength

getStartLine

getStartColumn

getEndLine

getEndColumn

visit