com.atlassian.clover.registry.entities

Class FullClassInfo

java.lang.Object

com.atlassian.clover.registry.FixedFileRegion

com.atlassian.clover.registry.entities.BaseClassInfo

com.atlassian.clover.registry.entities.FullClassInfo

All Implemented Interfaces:

ClassInfo, EntityContainer, HasAggregatedMetrics, HasClasses, HasContextFilter, HasMethods, HasMetrics, HasParent, HasStatements, SourceInfo, TaggedPersistent, CoverageDataRange, CoverageDataReceptor, FileInfoRegion, HasMetricsNode

public class FullClassInfo
extends BaseClassInfo
implements HasMetricsNode, CoverageDataReceptor, TaggedPersistent, ClassInfo

Field Summary

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

contextFilter, metrics, modifiers, name, packageInfo, qualifiedName, rawMetrics, testClass, typeAnnotation, typeEnum, typeInterface

Fields inherited from class com.atlassian.clover.registry.FixedFileRegion

containingFile, region

Constructor Summary

Constructors

Constructor and Description
FullClassInfo(FullPackageInfo packageInfo, FullClassInfo parentClass, int dataIndex, String name, SourceInfo region, Modifiers modifiers, boolean typeInterface, boolean typeEnum, boolean typeAnnotation)
FullClassInfo(FullPackageInfo packageInfo, FullFileInfo parentFile, int dataIndex, String name, SourceInfo region, Modifiers modifiers, boolean typeInterface, boolean typeEnum, boolean typeAnnotation)
FullClassInfo(FullPackageInfo packageInfo, FullMethodInfo parentMethod, int dataIndex, String name, SourceInfo region, Modifiers modifiers, boolean typeInterface, boolean typeEnum, boolean typeAnnotation)

Method Summary

Modifier and Type	Method and Description
void	addClass(FullClassInfo classInfo)
void	addMethod(FullMethodInfo meth)
void	addStatement(FullStatementInfo statement)
void	addTestCase(TestCaseInfo tci)
FullClassInfo	copy(FullFileInfo newParent, HasMetricsFilter filter)
void	gatherSourceRegions(Set<SourceInfo> regions)
int	getAggregatedComplexity()
int	getAggregatedStatementCount()
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 inner classes declared on the top level of the class.
ClassInfo	getContainingClass() Returns a class in which this class is declared (case for inner classes) or null otherwise.
FileInfo	getContainingFile() Returns a file in which this class is declared.
MethodInfo	getContainingMethod() Returns a method in which this class (an anonymous inline class for instance) is declared or null otherwise.
int	getDataIndex()
int	getDataLength()
CoverageDataProvider	getDataProvider()
int	getIndexOfChild(HasMetricsNode child)
List<? extends MethodInfo>	getMethods() Returns list of methods declared on the top level of the class.
BlockMetrics	getMetrics()
int	getNumChildren()
int	getNumMethods()
EntityContainer	getParent()
BlockMetrics	getRawMetrics()
int	getRelativeDataIndex()
List<? extends StatementInfo>	getStatements() Returns list of statements declared on the to level of the class, i.e.
TestCaseInfo	getTestCase(Integer id) Gets the runtime testcase for the given id of this class.
TestCaseInfo	getTestCase(String testname)
Collection<TestCaseInfo>	getTestCases()
FullMethodInfo	getTestMethodDeclaration(String methodname) find a method decl from its name at the moment this method just returns the first method that has the requested name, or null
void	increaseAggregatedComplexity(int increment)
void	increaseAggregatedStatements(int increment)
boolean	isEmpty() Returns true if this class does not contain any nested entities (method or inner classes)
boolean	isLeaf()
static FullClassInfo	read(TaggedDataInput in)
void	setAggregatedComplexity(int aggregatedComplexity)
void	setAggregatedStatementCount(int aggregatedStatements)
void	setComparator(Comparator cmp)
void	setContainingClass(FullClassInfo containingClass)
void	setContainingFile(FullFileInfo fileInfo)
void	setContainingMethod(FullMethodInfo containingMethod)
void	setDataLength(int length)
void	setDataProvider(CoverageDataProvider data)
void	setRegionEnd(int endLine, int endCol)
void	visitElements(FileElementVisitor visitor)
void	write(TaggedDataOutput out)

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

getContextFilter, getModifiers, getName, getPackage, getQualifiedName, isAnnotationType, isEnum, isInterface, isTestClass, setMetrics, toString, visit

Methods inherited from class com.atlassian.clover.registry.FixedFileRegion

getEndColumn, getEndLine, getStartColumn, getStartLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getModifiers, getName, getPackage, getQualifiedName, isTestClass

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.HasMetrics

setMetrics

Constructor Detail

FullClassInfo

public FullClassInfo(FullPackageInfo packageInfo,
                     FullClassInfo parentClass,
                     int dataIndex,
                     String name,
                     SourceInfo region,
                     Modifiers modifiers,
                     boolean typeInterface,
                     boolean typeEnum,
                     boolean typeAnnotation)

FullClassInfo

public FullClassInfo(FullPackageInfo packageInfo,
                     FullMethodInfo parentMethod,
                     int dataIndex,
                     String name,
                     SourceInfo region,
                     Modifiers modifiers,
                     boolean typeInterface,
                     boolean typeEnum,
                     boolean typeAnnotation)

FullClassInfo

public FullClassInfo(FullPackageInfo packageInfo,
                     FullFileInfo parentFile,
                     int dataIndex,
                     String name,
                     SourceInfo region,
                     Modifiers modifiers,
                     boolean typeInterface,
                     boolean typeEnum,
                     boolean typeAnnotation)

Method Detail

isEmpty

public boolean isEmpty()

Description copied from interface: ClassInfo

Returns true if this class does not contain any nested entities (method or inner classes)

Specified by:

isEmpty in interface ClassInfo

Specified by:

isEmpty in interface HasMetricsNode

Overrides:

isEmpty in class BaseClassInfo

Returns:

boolean - true if getMethods() is empty and getClasses() is empty

getClasses

@NotNull
public List<? extends ClassInfo> getClasses()

Description copied from interface: ClassInfo

Returns list of inner classes declared on the top level of the class. It does not return classes declared inside other inner classes, i.e nested more than one level. Exact content depends on a programming language, e.g.:

• Java and Groovy - it does not return anonymous inline classes (they're treated like statements)
• Scala - t.b.d.

Specified by:

getClasses in interface ClassInfo

Specified by:

getClasses in interface HasClasses

Overrides:

getClasses in class BaseClassInfo

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 BaseClassInfo

Returns:

List<? extends ClassInfo> - list of classes or empty list if none

getMethods

@NotNull
public List<? extends MethodInfo> getMethods()

Description copied from interface: ClassInfo

Returns list of methods declared on the top level of the class. It does not return methods declared in nested classes or methods declared inside other methods etc. Exact content depends on a programming language, e.g.:

• Java - traditional methods plus lambda functions assigned to a field (java 8 or above)
• Groovy - methods, extra methods generated by groovyc (getters and setters for instance)
• Scala - t.b.d.

Specified by:

getMethods in interface ClassInfo

Specified by:

getMethods in interface HasMethods

Overrides:

getMethods in class BaseClassInfo

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 BaseClassInfo

Returns:

List<? extends MethodInfo> - list of methods or empty list if none

getStatements

@NotNull
public List<? extends StatementInfo> getStatements()

Description copied from interface: ClassInfo

Returns list of statements declared on the to level of the class, i.e. outside methods. It does not apply to all programming languages:

• Java - not applicable, code put in static initializer blocks is treated as a part of a constructor
• Groovy - not applicable
• Scala - t.b.d.

Specified by:

getStatements in interface ClassInfo

Specified by:

getStatements in interface HasStatements

Overrides:

getStatements in class BaseClassInfo

Returns:

List<? extends StatementInfo> - list of statements or empty list if none

addClass

public void addClass(FullClassInfo classInfo)

addMethod

public void addMethod(FullMethodInfo meth)

addStatement

public void addStatement(FullStatementInfo statement)

addTestCase

public void addTestCase(TestCaseInfo tci)

getTestCases

public Collection<TestCaseInfo> getTestCases()

getTestCase

public TestCaseInfo getTestCase(Integer id)

Gets the runtime testcase for the given id of this class.

Parameters:

id - numeric identifier of the test case

Returns:

TestCaseInfo or

null

if not found

getTestCase

public TestCaseInfo getTestCase(String testname)

Parameters:

testname - - fully qualified test name e.g. com.foo.bar.BarTest.testFoo

Returns:

testCaseInfo for the given test name, or null if not found or no test case info

setDataProvider

public void setDataProvider(CoverageDataProvider data)

Specified by:

setDataProvider in interface CoverageDataReceptor

getDataProvider

public CoverageDataProvider getDataProvider()

Specified by:

getDataProvider in interface CoverageDataReceptor

getDataIndex

public int getDataIndex()

Specified by:

getDataIndex in interface CoverageDataRange

Returns:

the starting index for this element (or its first child)

getRelativeDataIndex

public int getRelativeDataIndex()

getDataLength

public int getDataLength()

Specified by:

getDataLength in interface CoverageDataRange

Returns:

the minimum length (from the data index) of coverage data to ensure enough data for this element and all children.

setDataLength

public void setDataLength(int length)

getAggregatedStatementCount

public int getAggregatedStatementCount()

Specified by:

getAggregatedStatementCount in interface HasAggregatedMetrics

Overrides:

getAggregatedStatementCount in class BaseClassInfo

setAggregatedStatementCount

public void setAggregatedStatementCount(int aggregatedStatements)

Specified by:

setAggregatedStatementCount in interface HasAggregatedMetrics

Overrides:

setAggregatedStatementCount in class BaseClassInfo

increaseAggregatedStatements

public void increaseAggregatedStatements(int increment)

getAggregatedComplexity

public int getAggregatedComplexity()

Specified by:

getAggregatedComplexity in interface HasAggregatedMetrics

Overrides:

getAggregatedComplexity in class BaseClassInfo

setAggregatedComplexity

public void setAggregatedComplexity(int aggregatedComplexity)

Specified by:

setAggregatedComplexity in interface HasAggregatedMetrics

Overrides:

setAggregatedComplexity in class BaseClassInfo

increaseAggregatedComplexity

public void increaseAggregatedComplexity(int increment)

getContainingMethod

@Nullable
public MethodInfo getContainingMethod()

Description copied from interface: ClassInfo

Returns a method in which this class (an anonymous inline class for instance) is declared or null otherwise.

Specified by:

getContainingMethod in interface ClassInfo

Overrides:

getContainingMethod in class BaseClassInfo

Returns:

MethodInfo containing method or null

getContainingClass

@Nullable
public ClassInfo getContainingClass()

Description copied from interface: ClassInfo

Returns a class in which this class is declared (case for inner classes) or null otherwise.

Specified by:

getContainingClass in interface ClassInfo

Overrides:

getContainingClass in class BaseClassInfo

Returns:

ClassInfo containing class or null

getContainingFile

@Nullable
public FileInfo getContainingFile()

Description copied from interface: ClassInfo

Returns a file in which this class is declared.

Specified by:

getContainingFile in interface ClassInfo

Specified by:

getContainingFile in interface FileInfoRegion

Overrides:

getContainingFile in class BaseClassInfo

Returns:

FileInfo file containing this class

getParent

public EntityContainer getParent()

Specified by:

getParent in interface HasParent

Overrides:

getParent in class BaseClassInfo

gatherSourceRegions

public void gatherSourceRegions(Set<SourceInfo> regions)

visitElements

public void visitElements(FileElementVisitor visitor)

getChildType

public String getChildType()

Specified by:

getChildType in interface HasMetricsNode

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

getMetrics

public BlockMetrics getMetrics()

Specified by:

getMetrics in interface HasMetrics

Overrides:

getMetrics in class BaseClassInfo

getRawMetrics

public BlockMetrics getRawMetrics()

Specified by:

getRawMetrics in interface HasMetrics

Overrides:

getRawMetrics in class BaseClassInfo

copy

public FullClassInfo copy(FullFileInfo newParent,
                          HasMetricsFilter filter)

getTestMethodDeclaration

public FullMethodInfo getTestMethodDeclaration(String methodname)

find a method decl from its name at the moment this method just returns the first method that has the requested name, or null

Returns:

FullMethodInfo or null if not found

getNumMethods

public int getNumMethods()

setRegionEnd

public void setRegionEnd(int endLine,
                         int endCol)

setContainingMethod

public void setContainingMethod(FullMethodInfo containingMethod)

setContainingClass

public void setContainingClass(FullClassInfo containingClass)

setContainingFile

public void setContainingFile(FullFileInfo fileInfo)

write

public void write(TaggedDataOutput out)
           throws IOException

Specified by:

write in interface TaggedPersistent

Throws:

IOException

read

public static FullClassInfo read(TaggedDataInput in)
                          throws IOException

Throws:

IOException