com.atlassian.clover.api.registry

Interface ProjectInfo

All Superinterfaces:

EntityContainer, HasContextFilter, HasMetrics, HasPackages

All Known Implementing Classes:

BaseProjectInfo, FullProjectInfo

public interface ProjectInfo
extends EntityContainer, HasPackages, HasContextFilter, HasMetrics

Method Summary

Modifier and Type	Method and Description
ClassInfo	findClass(String fullyQualifiedName) Searches and returns a class having the specified fully qualified name
FileInfo	findFile(String pkgPath) Searches and returns a file at the specified relative path.
String	getName() Returns name of the project
boolean	isEmpty() Returns true if project is empty.

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

visit

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

findPackage, getAllPackages

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

getContextFilter

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

getMetrics, getRawMetrics, setMetrics

Method Detail

getName

String getName()

Returns name of the project

Specified by:

getName in interface HasMetrics

Returns:

String project name or null

isEmpty

boolean isEmpty()

Returns true if project is empty.

Returns:

boolean - true if getAllPackages() is empty

findClass

ClassInfo findClass(String fullyQualifiedName)

Searches and returns a class having the specified fully qualified name

Parameters:

fullyQualifiedName - a class name with its package

Returns:

ClassInfo specified class or null if not found

findFile

FileInfo findFile(String pkgPath)

Searches and returns a file at the specified relative path. For example: com/acme/Foo.java

Parameters:

pkgPath - file name prefixed by a package path

Returns:

FileInfo specified file or null if not found