com.atlassian.clover.registry.entities

Class FullMethodInfo

java.lang.Object

com.atlassian.clover.registry.entities.FullElementInfo<BasicMethodInfo>

com.atlassian.clover.registry.entities.FullMethodInfo

All Implemented Interfaces:

ElementInfo, EntityContainer, HasAggregatedMetrics, HasBranches, HasClasses, HasContextFilter, HasMethods, HasMetrics, HasParent, HasStatements, InstrumentationInfo, MethodInfo, SourceInfo, TaggedPersistent, CoverageDataRange, CoverageDataReceptor, FileInfoRegion, HasMetricsNode

public class FullMethodInfo
extends FullElementInfo<BasicMethodInfo>
implements HasAggregatedMetrics, HasMetricsNode, TaggedPersistent, MethodInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_METHOD_COMPLEXITY

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

context, sharedInfo

Constructor Summary

Constructors

Constructor and Description
FullMethodInfo(FullClassInfo containingClass, ContextSet context, BasicMethodInfo methodInfo) For method-in-class
FullMethodInfo(FullClassInfo containingClass, int relativeDataIndex, ContextSet context, SourceInfo region, MethodSignature signature, boolean isTest, String staticTestName, boolean isLambda, int complexity)
FullMethodInfo(FullClassInfo containingClass, int relativeDataIndex, ContextSet context, SourceInfo region, MethodSignature signature, boolean isTest, String staticTestName, boolean isLambda, int complexity, LanguageConstruct construct)
FullMethodInfo(FullFileInfo containingFile, ContextSet context, BasicMethodInfo methodInfo) For method-in-file
FullMethodInfo(FullMethodInfo containingMethod, ContextSet context, BasicMethodInfo methodInfo) For method-in-method

Method Summary

Modifier and Type	Method and Description
void	addBranch(FullBranchInfo branch)
void	addClass(FullClassInfo classInfo)
void	addMethod(FullMethodInfo methodInfo)
void	addStatement(FullStatementInfo stmt)
FullMethodInfo	copy(FullClassInfo classAsParent)
FullMethodInfo	copy(FullFileInfo fileAsParent)
FullMethodInfo	copy(FullMethodInfo methodAsParent)
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.
int	getBranchCount()
List<? extends BranchInfo>	getBranches() Returns list of branches
HasMetricsNode	getChild(int i)
String	getChildType()
List<? extends ClassInfo>	getClasses() Returns list of classes
ClassInfo	getContainingClass() Returns a class in which method is declared or null if method (actually it will be a function or procedure) is declared outside the class.
FileInfo	getContainingFile() Returns a file in which this method is declared.
MethodInfo	getContainingMethod() Returns a method in which this method (an inner function actually) is declared or null if method is not nested inside other method.
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	getDataLength()
CoverageDataProvider	getDataProvider()
int	getIndexOfChild(HasMetricsNode child)
List<? extends MethodInfo>	getMethods() Returns list of methods
BlockMetrics	getMetrics()
String	getName()
int	getNumChildren()
EntityContainer	getParent() Returns an object which encloses this method.
String	getQualifiedName()
BlockMetrics	getRawMetrics()
MethodSignature	getSignature() Returns method signature (annotations, keywords, type parameters, method name, parameters, return type, throws).
String	getSimpleName()
List<? extends StatementInfo>	getStatements() Returns list of statements
String	getStaticTestName() Name of the test associated with a method.
String	getVisibility() convenience method
void	increaseAggregatedComplexity(int increment)
void	increaseAggregatedStatementCount(int increment)
boolean	isEmpty() Returns whether method is empty, i.e.
boolean	isLambda() Returns whether it's a lambda function or not.
boolean	isLeaf()
boolean	isPublic() convenience method
boolean	isTest() Returns whether it's a test method or not.
boolean	isVoidReturnType()
static FullMethodInfo	read(TaggedDataInput in)
void	setAggregatedComplexity(int aggregatedComplexity)
void	setAggregatedStatementCount(int aggregatedStatementCount)
void	setComparator(Comparator cmp)
protected void	setContainingClass(FullClassInfo classInfo)
protected void	setContainingFile(FullFileInfo fileInfo)
protected void	setContainingMethod(FullMethodInfo methodInfo)
void	setDataLength(int length)
void	setDataProvider(CoverageDataProvider data)
void	setMetrics(BlockMetrics metrics)
void	setRegionEnd(int endLine, int endCol)
void	setStaticTestName(String staticTestName)
void	setVoidReturnType(boolean voidReturnType)
String	toString()
void	visit(EntityVisitor entityVisitor) Visit yourself
void	visit(FileElementVisitor visitor)
void	write(TaggedDataOutput out)

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

addContext, getComplexity, getConstruct, getContext, getDataIndex, getEndColumn, getEndLine, getHitCount, getRelativeDataIndex, getStartColumn, getStartLine, isFiltered, setComplexity, setContext

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

getComplexity, getContext, getHitCount

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

getEndColumn, getEndLine, getStartColumn, getStartLine

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

getDataIndex

Field Detail

DEFAULT_METHOD_COMPLEXITY

public static final int DEFAULT_METHOD_COMPLEXITY

See Also:

Constant Field Values

Constructor Detail

FullMethodInfo

public FullMethodInfo(FullClassInfo containingClass,
                      int relativeDataIndex,
                      ContextSet context,
                      SourceInfo region,
                      MethodSignature signature,
                      boolean isTest,
                      String staticTestName,
                      boolean isLambda,
                      int complexity)

FullMethodInfo

public FullMethodInfo(FullClassInfo containingClass,
                      int relativeDataIndex,
                      ContextSet context,
                      SourceInfo region,
                      MethodSignature signature,
                      boolean isTest,
                      String staticTestName,
                      boolean isLambda,
                      int complexity,
                      LanguageConstruct construct)

FullMethodInfo

public FullMethodInfo(FullClassInfo containingClass,
                      ContextSet context,
                      BasicMethodInfo methodInfo)

For method-in-class

FullMethodInfo

public FullMethodInfo(FullMethodInfo containingMethod,
                      ContextSet context,
                      BasicMethodInfo methodInfo)

For method-in-method

FullMethodInfo

public FullMethodInfo(FullFileInfo containingFile,
                      ContextSet context,
                      BasicMethodInfo methodInfo)

For method-in-file

Method Detail

getName

public String getName()

Specified by:

getName in interface HasMetrics

Specified by:

getName in interface MethodInfo

getSimpleName

public String getSimpleName()

Specified by:

getSimpleName in interface MethodInfo

getSignature

@NotNull
public MethodSignature getSignature()

Description copied from interface: MethodInfo

Returns method signature (annotations, keywords, type parameters, method name, parameters, return type, throws).

Specified by:

getSignature in interface MethodInfo

Returns:

MethodSignatureInfo

getQualifiedName

public String getQualifiedName()

Specified by:

getQualifiedName in interface MethodInfo

getContainingClass

@Nullable
public ClassInfo getContainingClass()

Description copied from interface: MethodInfo

Returns a class in which method is declared or null if method (actually it will be a function or procedure) is declared outside the class.

Specified by:

getContainingClass in interface MethodInfo

Returns:

ClassInfo containing class or null

getContainingMethod

@Nullable
public MethodInfo getContainingMethod()

Description copied from interface: MethodInfo

Returns a method in which this method (an inner function actually) is declared or null if method is not nested inside other method.

Specified by:

getContainingMethod in interface MethodInfo

Returns:

MethodInfo containing method or null

isTest

public boolean isTest()

Description copied from interface: MethodInfo

Returns whether it's a test method or not. Classification as a test method depends on the test pattern defined at instrumentation time.

Specified by:

isTest in interface MethodInfo

Returns:

boolean true if test method, false otherwise

getStaticTestName

@Nullable
public String getStaticTestName()

Description copied from interface: MethodInfo

Name of the test associated with a method. Some test frameworks can declare a name of the test using annotations or javadoc tags, so that later the test name and not the original method name is used in reporting.

For instance, the Spock framweork uses @FeatureMetadata(name="name of the test")

Note that this method returns a static name of the test, i.e. declared in the code. Some test frameworks might dynamically generate test names. Examples are the Spock's @Unroll and JUnit's @Parameterized.

Specified by:

getStaticTestName in interface MethodInfo

Returns:

String name of the test associated to this method or null if not declared

isLambda

public boolean isLambda()

Description copied from interface: MethodInfo

Returns whether it's a lambda function or not.

Specified by:

isLambda in interface MethodInfo

Returns:

boolean true for lambda function, false otherwise

isEmpty

public boolean isEmpty()

Description copied from interface: MethodInfo

Returns whether method is empty, i.e. does not contain any executable code in it - no statements or branches. Nested methods (functions) and classes defined inside the method body are treated separately, i.e. a method having them can still be empty if it has no statements or branches.

Specified by:

isEmpty in interface MethodInfo

Specified by:

isEmpty in interface HasMetricsNode

Returns:

boolean true if has no statements and no branches, false otherwise

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

getAggregatedStatementCount

public int getAggregatedStatementCount()

Specified by:

getAggregatedStatementCount in interface HasAggregatedMetrics

setAggregatedStatementCount

public void setAggregatedStatementCount(int aggregatedStatementCount)

Specified by:

setAggregatedStatementCount in interface HasAggregatedMetrics

increaseAggregatedStatementCount

public void increaseAggregatedStatementCount(int increment)

getAggregatedComplexity

public int getAggregatedComplexity()

Specified by:

getAggregatedComplexity in interface HasAggregatedMetrics

setAggregatedComplexity

public void setAggregatedComplexity(int aggregatedComplexity)

Specified by:

setAggregatedComplexity in interface HasAggregatedMetrics

increaseAggregatedComplexity

public void increaseAggregatedComplexity(int increment)

addClass

public void addClass(FullClassInfo classInfo)

addMethod

public void addMethod(FullMethodInfo methodInfo)

getClasses

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

Returns list of classes

Specified by:

getClasses in interface HasClasses

Returns:

List<? extends ClassInfo> - a cloned list

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()

Returns list of methods

Specified by:

getMethods in interface HasMethods

Returns:

List<? extends MethodInfo> - a cloned list

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

addStatement

public void addStatement(FullStatementInfo stmt)

addBranch

public void addBranch(FullBranchInfo branch)

getStatements

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

Description copied from interface: HasStatements

Returns list of statements

Specified by:

getStatements in interface HasStatements

Returns:

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

getBranches

@NotNull
public List<? extends BranchInfo> getBranches()

Description copied from interface: HasBranches

Returns list of branches

Specified by:

getBranches in interface HasBranches

Returns:

List<? extends BranchInfo> - list of branches or empty list if none

getBranchCount

public int getBranchCount()

getMetrics

public BlockMetrics getMetrics()

Specified by:

getMetrics in interface HasMetrics

getRawMetrics

public BlockMetrics getRawMetrics()

Specified by:

getRawMetrics in interface HasMetrics

setMetrics

public void setMetrics(BlockMetrics metrics)

Specified by:

setMetrics in interface HasMetrics

setDataProvider

public void setDataProvider(CoverageDataProvider data)

Specified by:

setDataProvider in interface CoverageDataReceptor

gatherSourceRegions

public void gatherSourceRegions(Set<SourceInfo> regions)

visit

public void visit(EntityVisitor entityVisitor)

Visit yourself

Specified by:

visit in interface EntityContainer

Parameters:

entityVisitor - callback

visit

public void visit(FileElementVisitor visitor)

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface HasMetricsNode

getNumChildren

public int getNumChildren()

Specified by:

getNumChildren in interface HasMetricsNode

getChildType

public String getChildType()

Specified by:

getChildType 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

setComparator

public void setComparator(Comparator cmp)

Specified by:

setComparator in interface HasMetricsNode

copy

public FullMethodInfo copy(FullClassInfo classAsParent)

copy

public FullMethodInfo copy(FullMethodInfo methodAsParent)

copy

public FullMethodInfo copy(FullFileInfo fileAsParent)

isPublic

public boolean isPublic()

convenience method

Returns:

true if public, false otherwise

getVisibility

public String getVisibility()

convenience method

Returns:

return either "public", "package", "protected" or "private"

getDataProvider

public CoverageDataProvider getDataProvider()

Specified by:

getDataProvider in interface CoverageDataReceptor

getDataLength

public int getDataLength()

Specified by:

getDataLength in interface InstrumentationInfo

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)

setContainingClass

protected void setContainingClass(FullClassInfo classInfo)

setContainingMethod

protected void setContainingMethod(FullMethodInfo methodInfo)

setContainingFile

protected void setContainingFile(FullFileInfo fileInfo)

getContainingFile

@Nullable
public FileInfo getContainingFile()

Description copied from interface: MethodInfo

Returns a file in which this method is declared. Note that some programming languages allows to define a function outside a class (or other function).

Specified by:

getContainingFile in interface MethodInfo

Specified by:

getContainingFile in interface FileInfoRegion

Returns:

FileInfo file containing this method

getParent

@NotNull
public EntityContainer getParent()

Description copied from interface: MethodInfo

Returns an object which encloses this method. You can access it via:

• EntityVisitor.visitClass(ClassInfo) - for a method declared inside a class
• EntityVisitor.visitMethod(MethodInfo) - for a method declared inside another method
• EntityVisitor.visitFile(FileInfo) - for a method declared in the file (on a top-level)

Specified by:

getParent in interface HasParent

Specified by:

getParent in interface MethodInfo

Returns:

EntityContainer parent code entity

setRegionEnd

public void setRegionEnd(int endLine,
                         int endCol)

setStaticTestName

public void setStaticTestName(String staticTestName)

isVoidReturnType

public boolean isVoidReturnType()

setVoidReturnType

public void setVoidReturnType(boolean voidReturnType)

write

public void write(TaggedDataOutput out)
           throws IOException

Specified by:

write in interface TaggedPersistent

Throws:

IOException

read

public static FullMethodInfo read(TaggedDataInput in)
                           throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object