Package com.ensoftcorp.open.commons.analyzers

Class CyclomaticComplexity

java.lang.Object

com.ensoftcorp.open.commons.analyzers.Analyzer

com.ensoftcorp.open.commons.analyzers.Property

com.ensoftcorp.open.commons.analyzers.CyclomaticComplexity

public class CyclomaticComplexity
extends Property

An analyzer for cyclomatic complexity

Author:

Ben Holland

Nested Class Summary

Nested classes/interfaces inherited from class com.ensoftcorp.open.commons.analyzers.Analyzer

Analyzer.Result

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	RESULT_PREFIX

Constructor Summary

Constructors

Constructor	Description
CyclomaticComplexity()

Method Summary

Modifier and Type	Method	Description
static int	cyclomaticComplexity(com.ensoftcorp.atlas.core.db.graph.Node function, boolean includeExceptionControlFlows)	Computes the cyclomatic complexity of a function as defined by https://en.wikipedia.org/wiki/Cyclomatic_complexity
java.lang.String[]	getAssumptions()	Returns an array of assumptions made when writing the analyzer
java.lang.String	getDescription()	Returns a short description of the analyzer
java.lang.String	getName()	Returns a name of the analyzer
java.util.Comparator<Analyzer.Result>	getResultOrder()	Sort results based on complexity
java.util.List<Analyzer.Result>	getResults(com.ensoftcorp.atlas.core.query.Q context)	Return analyzer's labeled results Results are for results within a given context

Methods inherited from class com.ensoftcorp.open.commons.analyzers.Property

getCategory

Methods inherited from class com.ensoftcorp.open.commons.analyzers.Analyzer

equals, getAllResults, getCodemapStageDependencies, getMarkup, getMarkupKey, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESULT_PREFIX

public static final java.lang.String RESULT_PREFIX

See Also:

Constant Field Values

Constructor Detail

CyclomaticComplexity

public CyclomaticComplexity()

Method Detail

getName

public java.lang.String getName()

Description copied from class: Analyzer

Returns a name of the analyzer

Overrides:

getName in class Analyzer

Returns:

getDescription

public java.lang.String getDescription()

Description copied from class: Analyzer

Returns a short description of the analyzer

Specified by:

getDescription in class Analyzer

Returns:

getAssumptions

public java.lang.String[] getAssumptions()

Description copied from class: Analyzer

Returns an array of assumptions made when writing the analyzer

Overrides:

getAssumptions in class Analyzer

Returns:

getResults

public java.util.List<Analyzer.Result> getResults(com.ensoftcorp.atlas.core.query.Q context)

Description copied from class: Analyzer

Return analyzer's labeled results Results are for results within a given context

Specified by:

getResults in class Analyzer

Returns:

cyclomaticComplexity

public static int cyclomaticComplexity(com.ensoftcorp.atlas.core.db.graph.Node function,
                                       boolean includeExceptionControlFlows)

Computes the cyclomatic complexity of a function as defined by https://en.wikipedia.org/wiki/Cyclomatic_complexity

Parameters:

function -

includeExceptionControlFlows - If true exception control flow graph edges will be included in the result

Returns:

getResultOrder

public java.util.Comparator<Analyzer.Result> getResultOrder()

Sort results based on complexity

Overrides:

getResultOrder in class Analyzer

Returns: