org.sonar.python.api

Enum PythonMetric

java.lang.Object

java.lang.Enum<PythonMetric>

org.sonar.python.api.PythonMetric

All Implemented Interfaces:

Serializable, Comparable<PythonMetric>, org.sonar.squidbridge.measures.MetricDef

public enum PythonMetric
extends Enum<PythonMetric>
implements org.sonar.squidbridge.measures.MetricDef

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASSES
COMMENT_LINES
COMPLEXITY
FILES
FUNCTIONS
LINES
LINES_OF_CODE
STATEMENTS

Method Summary

Methods

Modifier and Type	Method and Description
boolean	aggregateIfThereIsAlreadyAValue()
org.sonar.squidbridge.measures.CalculatedMetricFormula	getCalculatedMetricFormula()
String	getName()
boolean	isCalculatedMetric()
boolean	isThereAggregationFormula()
static PythonMetric	valueOf(String name) Returns the enum constant of this type with the specified name.
static PythonMetric[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FILES

public static final PythonMetric FILES

LINES

public static final PythonMetric LINES

LINES_OF_CODE

public static final PythonMetric LINES_OF_CODE

STATEMENTS

public static final PythonMetric STATEMENTS

FUNCTIONS

public static final PythonMetric FUNCTIONS

CLASSES

public static final PythonMetric CLASSES

COMPLEXITY

public static final PythonMetric COMPLEXITY

COMMENT_LINES

public static final PythonMetric COMMENT_LINES

Method Detail

values

public static PythonMetric[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PythonMetric c : PythonMetric.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PythonMetric valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Specified by:

getName in interface org.sonar.squidbridge.measures.MetricDef

isCalculatedMetric

public boolean isCalculatedMetric()

Specified by:

isCalculatedMetric in interface org.sonar.squidbridge.measures.MetricDef

aggregateIfThereIsAlreadyAValue

public boolean aggregateIfThereIsAlreadyAValue()

Specified by:

aggregateIfThereIsAlreadyAValue in interface org.sonar.squidbridge.measures.MetricDef

isThereAggregationFormula

public boolean isThereAggregationFormula()

Specified by:

isThereAggregationFormula in interface org.sonar.squidbridge.measures.MetricDef

getCalculatedMetricFormula

public org.sonar.squidbridge.measures.CalculatedMetricFormula getCalculatedMetricFormula()

Specified by:

getCalculatedMetricFormula in interface org.sonar.squidbridge.measures.MetricDef