BaseProjectInfo (OpenClover 4.5.2 API)

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

All Implemented Interfaces:

EntityContainer, HasContextFilter, HasMetrics, HasPackages, ProjectInfo, CachingInfo

Direct Known Subclasses:

FullProjectInfo
```
public class BaseProjectInfo
extends Object
implements ProjectInfo, CachingInfo
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,BaseClassInfo>`	`classLookup`
`protected ContextSet`	`contextFilter`
`protected Map<String,BaseFileInfo>`	`fileLookup`
`protected BlockMetrics`	`metrics`
`protected String`	`name`
`protected Map<String,BasePackageInfo>`	`packages`
`protected BlockMetrics`	`rawMetrics`
`protected long`	`version`

Constructor Summary

Constructors
Constructor and Description

BaseProjectInfo(String name)

BaseProjectInfo(String name, long version)

Constructors
Constructor and Description
`BaseProjectInfo(String name)`
`BaseProjectInfo(String name, long version)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPackage(BasePackageInfo pkg)`
`ClassInfo`	`findClass(String fqcn)` convenience method to find a class in a project using its fully qualified name.
`FileInfo`	`findFile(String pkgPath)` convenience method to find a file in a project using its package path.
`PackageInfo`	`findPackage(String name)` Searches for a package with given name
`List<? extends PackageInfo>`	`getAllPackages()` Returns list of all packages defined in the project (including nested packages).
`List<? extends BaseClassInfo>`	`getClasses(HasMetricsFilter filter)` convenience method to get all classes in a project that meet some criteria
`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.
`BasePackageInfo`	`getDefaultPackage()`
`List`	`getFiles(HasMetricsFilter filter)` convenience method to get all filees in a project that meet some criteria
`BlockMetrics`	`getMetrics()`
`String`	`getName()` Returns name of the project
`BasePackageInfo`	`getNamedPackage(String name)`
`List<BasePackageInfo>`	`getPackages(HasMetricsFilter filter)`
`BlockMetrics`	`getRawMetrics()`
`long`	`getVersion()`
`void`	`invalidateCaches()`
`boolean`	`isEmpty()` Returns true if project is empty.
`void`	`setContextFilter(ContextSet filter)`
`void`	`setMetrics(BlockMetrics metrics)`
`void`	`setName(String name)`
`void`	`setVersion(long version)`
`void`	`visit(EntityVisitor entityVisitor)` Visit yourself
`void`	`visitFiles(FileInfoVisitor visitor)`

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

- Field Detail
  - name
```
protected String name
```
  - packages
```
protected Map<String,BasePackageInfo> packages
```
  - version
```
protected long version
```
  - classLookup
```
protected Map<String,BaseClassInfo> classLookup
```
  - fileLookup
```
protected Map<String,BaseFileInfo> fileLookup
```
  - rawMetrics
```
protected BlockMetrics rawMetrics
```
  - metrics
```
protected BlockMetrics metrics
```
  - contextFilter
```
protected ContextSet contextFilter
```
- Constructor Detail
  - BaseProjectInfo
```
public BaseProjectInfo(String name,
                       long version)
```
  - BaseProjectInfo
```
public BaseProjectInfo(String name)
```
- Method Detail
  - getAllPackages
```
@NotNull
public List<? extends PackageInfo> getAllPackages()
```
    Description copied from interface: HasPackages
    
    Returns list of all packages defined in the project (including nested packages). It may also contain the default package - see PackageInfo.DEFAULT_PACKAGE_NAME.
    
    Specified by:
    
    getAllPackages in interface HasPackages
    
    Returns:
    
    List<? extends PackageInfo> list of packages or empty list if none
  - addPackage
```
public void addPackage(BasePackageInfo pkg)
```
  - getDefaultPackage
```
public BasePackageInfo getDefaultPackage()
```
  - getNamedPackage
```
public BasePackageInfo getNamedPackage(String name)
```
  - findPackage
```
public PackageInfo findPackage(String name)
```
    Description copied from interface: HasPackages
    
    Searches for a package with given name
    
    Specified by:
    
    findPackage in interface HasPackages
    
    Parameters:
    
    name - fully qualified package name
    
    Returns:
    
    PackageInfo package found or null
  - getName
```
public String getName()
```
    Description copied from interface: ProjectInfo
    
    Returns name of the project
    
    Specified by:
    
    getName in interface HasMetrics
    
    Specified by:
    
    getName in interface ProjectInfo
    
    Returns:
    
    String project name or null
  - setName
```
public void setName(String name)
```
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ProjectInfo
    
    Returns true if project is empty.
    
    Specified by:
    
    isEmpty in interface ProjectInfo
    
    Returns:
    
    boolean - true if getAllPackages() is empty
  - findClass
```
public ClassInfo findClass(String fqcn)
```
    convenience method to find a class in a project using its fully qualified name. Initialized lazily, so the first call may be slow
    
    Specified by:
    
    findClass in interface ProjectInfo
    
    Parameters:
    
    fqcn - a fully qualified class name
    
    Returns:
    
    corresponding BaseClassInfo or null if not found
  - findFile
```
public FileInfo findFile(String pkgPath)
```
    convenience method to find a file in a project using its package path. Initialized lazily, so the first call may be slow
    
    Specified by:
    
    findFile in interface ProjectInfo
    
    Parameters:
    
    pkgPath - - path of the file to look for
    
    Returns:
    
    corresponding BaseFileInfo or null if not found
  - getClasses
```
public List<? extends BaseClassInfo> getClasses(HasMetricsFilter filter)
```
    convenience method to get all classes in a project that meet some criteria
    
    Parameters:
    
    filter - filter to apply
    
    Returns:
    
    list of classes that match filter
  - getFiles
```
public List getFiles(HasMetricsFilter filter)
```
    convenience method to get all filees in a project that meet some criteria
    
    Parameters:
    
    filter - filter to apply
    
    Returns:
    
    list of files that match filter
  - getPackages
```
public List<BasePackageInfo> getPackages(HasMetricsFilter filter)
```
  - getRawMetrics
```
public BlockMetrics getRawMetrics()
```
    Specified by:
    
    getRawMetrics in interface HasMetrics
  - getMetrics
```
public BlockMetrics getMetrics()
```
    Specified by:
    
    getMetrics in interface HasMetrics
  - setMetrics
```
public void setMetrics(BlockMetrics metrics)
```
    Specified by:
    
    setMetrics in interface HasMetrics
  - 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
  - setContextFilter
```
public void setContextFilter(ContextSet filter)
```
  - visit
```
public void visit(EntityVisitor entityVisitor)
```
    Visit yourself
    
    Specified by:
    
    visit in interface EntityContainer
    
    Parameters:
    
    entityVisitor - callback
  - visitFiles
```
public void visitFiles(FileInfoVisitor visitor)
```
  - getVersion
```
public long getVersion()
```
  - setVersion
```
public void setVersion(long version)
```
  - invalidateCaches
```
public void invalidateCaches()
```
    Specified by:
    
    invalidateCaches in interface CachingInfo

Class BaseProjectInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

packages

version

classLookup

fileLookup

rawMetrics

metrics

contextFilter

Constructor Detail

BaseProjectInfo

BaseProjectInfo

Method Detail

getAllPackages

addPackage

getDefaultPackage

getNamedPackage

findPackage

getName

setName

isEmpty

findClass

findFile

getClasses

getFiles

getPackages

getRawMetrics

getMetrics

setMetrics

getContextFilter

setContextFilter

visit

visitFiles

getVersion

setVersion

invalidateCaches