BasePackageInfo (OpenClover 4.5.2 API)

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

All Implemented Interfaces:

EntityContainer, HasClasses, HasContextFilter, HasFiles, HasMetrics, HasParent, PackageInfo, CachingInfo

Direct Known Subclasses:

FullPackageInfo
```
public class BasePackageInfo
extends Object
implements PackageInfo, CachingInfo
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<? extends ClassInfo>`	`allClasses` All classes in this package
`protected List<? extends ClassInfo>`	`classes` Top-level classes in this package
`protected BaseProjectInfo`	`containingProject`
`protected ContextSet`	`contextFilter`
`protected boolean`	`defaultPkg`
`protected Map<String,FileInfo>`	`files`
`protected BlockMetrics`	`metrics`
`protected String`	`name`
`protected String`	`path`
`protected BlockMetrics`	`rawMetrics`

Fields inherited from interface com.atlassian.clover.api.registry.PackageInfo
DEFAULT_PACKAGE_NAME

Constructor Summary

Constructors
Constructor and Description

BasePackageInfo(BaseProjectInfo containingProject, String name)

Constructors
Constructor and Description
`BasePackageInfo(BaseProjectInfo containingProject, String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFile(BaseFileInfo file)`
`protected void`	`gatherAllClassesFromPackage()`
`protected void`	`gatherClassesFromPackage()`
`List<? extends ClassInfo>`	`getAllClasses()` Returns list of all classes (including inner or inline classes) declared in this package.
`List<? extends ClassInfo>`	`getAllClassesIncludingSubPackages()` Returns list of all classes (including inner or inline classes) declared in this package AND all sub-packages.
`List<? extends ClassInfo>`	`getClasses()` Return list of top-level classes declared in this package namespace.
`List<? extends ClassInfo>`	`getClasses(HasMetricsFilter filter)` Return list of top-level classes declared in this package matching the filter
`List<? extends ClassInfo>`	`getClassesIncludingSubPackages()` Return list of top-level classes declared in this package namespace as well as from sub-packages.
`ProjectInfo`	`getContainingProject()` Returns a project containing this package.
`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.
`BaseFileInfo`	`getFile(String packagePath)`
`BaseFileInfo`	`getFileInPackage(String name)`
`List<? extends FileInfo>`	`getFiles()` Returns list of source files belonging to this package namespace.
`BlockMetrics`	`getMetrics()`
`String`	`getName()`
`EntityContainer`	`getParent()` Return parent project
`String`	`getPath()`
`BlockMetrics`	`getRawMetrics()`
`void`	`invalidateCaches()`
`boolean`	`isChildOrDescendantOf(BasePackageInfo other)`
`boolean`	`isDefault()`
`static boolean`	`isDefaultName(String name)`
`boolean`	`isDescendantOf(PackageInfo other)`
`boolean`	`isEmpty()`
`boolean`	`isNamed(String name)`
`void`	`setMetrics(BlockMetrics metrics)`
`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 final String name
```
  - defaultPkg
```
protected final boolean defaultPkg
```
  - files
```
protected final Map<String,FileInfo> files
```
  - path
```
protected final String path
```
  - containingProject
```
protected BaseProjectInfo containingProject
```
  - rawMetrics
```
protected BlockMetrics rawMetrics
```
  - metrics
```
protected BlockMetrics metrics
```
  - contextFilter
```
protected ContextSet contextFilter
```
  - classes
```
protected List<? extends ClassInfo> classes
```
    Top-level classes in this package
  - allClasses
```
protected List<? extends ClassInfo> allClasses
```
    All classes in this package
- Constructor Detail
  - BasePackageInfo
```
public BasePackageInfo(BaseProjectInfo containingProject,
                       String name)
```
- Method Detail
  - isDefaultName
```
public static boolean isDefaultName(String name)
```
  - getParent
```
public EntityContainer getParent()
```
    Return parent project
    
    Specified by:
    
    getParent in interface HasParent
    
    Specified by:
    
    getParent in interface PackageInfo
    
    Returns:
    
    container with ProjectInfo
  - visit
```
public void visit(EntityVisitor entityVisitor)
```
    Visit yourself
    
    Specified by:
    
    visit in interface EntityContainer
    
    Parameters:
    
    entityVisitor - callback
  - getContainingProject
```
public ProjectInfo getContainingProject()
```
    Description copied from interface: PackageInfo
    
    Returns a project containing this package.
    
    Specified by:
    
    getContainingProject in interface PackageInfo
    
    Returns:
    
    parent ProjectInfo
  - 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
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface HasMetrics
    
    Specified by:
    
    getName in interface PackageInfo
  - getPath
```
public String getPath()
```
    Specified by:
    
    getPath in interface PackageInfo
  - isDefault
```
public boolean isDefault()
```
    Specified by:
    
    isDefault in interface PackageInfo
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface PackageInfo
  - getFiles
```
@NotNull
public List<? extends FileInfo> getFiles()
```
    Description copied from interface: PackageInfo
    
    Returns list of source files belonging to this package namespace.
    
    Specified by:
    
    getFiles in interface HasFiles
    
    Specified by:
    
    getFiles in interface PackageInfo
    
    Returns:
    
    List<? extends FileInfo> list of files or empty list if none
  - addFile
```
public void addFile(BaseFileInfo file)
```
  - getFile
```
public BaseFileInfo getFile(String packagePath)
```
  - getFileInPackage
```
public BaseFileInfo getFileInPackage(String name)
```
  - getClasses
```
@NotNull
public List<? extends ClassInfo> getClasses()
```
    Return list of top-level classes declared in this package namespace.
    
    Specified by:
    
    getClasses in interface HasClasses
    
    Specified by:
    
    getClasses in interface PackageInfo
    
    Returns:
    
    List<? extends ClassInfo> list of classes found or empty list
  - getClassesIncludingSubPackages
```
@NotNull
public List<? extends ClassInfo> getClassesIncludingSubPackages()
```
    Return list of top-level classes declared in this package namespace as well as from sub-packages.
    
    Specified by:
    
    getClassesIncludingSubPackages in interface PackageInfo
    
    Returns:
    
    List<? extends ClassInfo> list of classes found or empty list
  - getClasses
```
public List<? extends ClassInfo> getClasses(HasMetricsFilter filter)
```
    Return list of top-level classes declared in this package matching the filter
    
    Parameters:
    
    filter - metrics filter to be applied
    
    Returns:
    
    List<? extends ClassInfo> list of classes found or empty list
  - getAllClasses
```
@NotNull
public List<? extends ClassInfo> getAllClasses()
```
    Description copied from interface: PackageInfo
    
    Returns list of all classes (including inner or inline classes) declared in this package.
    
    Specified by:
    
    getAllClasses in interface HasClasses
    
    Specified by:
    
    getAllClasses in interface PackageInfo
    
    Returns:
    
    List<? extends ClassInfo> - list of classes or empty list if none
  - getAllClassesIncludingSubPackages
```
@NotNull
public List<? extends ClassInfo> getAllClassesIncludingSubPackages()
```
    Description copied from interface: PackageInfo
    
    Returns list of all classes (including inner or inline classes) declared in this package AND all sub-packages.
    For example if this package is named "com.acme" then it will return all top-level and inner classes from "com.acme" as well as from "com.acme.foo", "com.acme.foo.bar" but not from "com.other".
    
    Specified by:
    
    getAllClassesIncludingSubPackages in interface PackageInfo
    
    Returns:
    
    List<? extends ClassInfo> - list of classes or empty list if none
  - isDescendantOf
```
public boolean isDescendantOf(PackageInfo other)
```
    Specified by:
    
    isDescendantOf in interface PackageInfo
  - 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
  - visitFiles
```
public void visitFiles(FileInfoVisitor visitor)
```
  - isChildOrDescendantOf
```
public boolean isChildOrDescendantOf(BasePackageInfo other)
```
    Returns:
    
    true is this package is a child or descendant of the other package. Default packages are considered the parent or ancestor of all packages.
  - isNamed
```
public boolean isNamed(String name)
```
  - invalidateCaches
```
public void invalidateCaches()
```
    Specified by:
    
    invalidateCaches in interface CachingInfo
  - gatherClassesFromPackage
```
protected void gatherClassesFromPackage()
```
  - gatherAllClassesFromPackage
```
protected void gatherAllClassesFromPackage()
```

Class BasePackageInfo

Field Summary

Fields inherited from interface com.atlassian.clover.api.registry.PackageInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

defaultPkg

files

path

containingProject

rawMetrics

metrics

contextFilter

classes

allClasses

Constructor Detail

BasePackageInfo

Method Detail

isDefaultName

getParent

visit

getContainingProject

getContextFilter

getName

getPath

isDefault

isEmpty

getFiles

addFile

getFile

getFileInPackage

getClasses

getClassesIncludingSubPackages

getClasses

getAllClasses

getAllClassesIncludingSubPackages

isDescendantOf

getRawMetrics

getMetrics

setMetrics

visitFiles

isChildOrDescendantOf

isNamed

invalidateCaches

gatherClassesFromPackage

gatherAllClassesFromPackage