Package org.sonar.api.code

Enum CodeCharacteristic

java.lang.Object

java.lang.Enum<CodeCharacteristic>

org.sonar.api.code.CodeCharacteristic

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CodeCharacteristic>

@Beta
public enum CodeCharacteristic
extends java.lang.Enum<CodeCharacteristic>

Enum that represents Characteristic according to the new Clean Code Taxonomy. Should be used instead of RuleType as it will become mandatory in the future to provide it.

Since:

9.16

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLEAR
COMPLIANT
CONSISTENT
PORTABLE
ROBUST
SECURE
STRUCTURED
TESTED

Method Summary

Modifier and Type	Method	Description
CharacteristicsCategory	getCharacteristicsCategory()
static CodeCharacteristic	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CodeCharacteristic[]	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

CLEAR

public static final CodeCharacteristic CLEAR

CONSISTENT

public static final CodeCharacteristic CONSISTENT

STRUCTURED

public static final CodeCharacteristic STRUCTURED

TESTED

public static final CodeCharacteristic TESTED

ROBUST

public static final CodeCharacteristic ROBUST

SECURE

public static final CodeCharacteristic SECURE

PORTABLE

public static final CodeCharacteristic PORTABLE

COMPLIANT

public static final CodeCharacteristic COMPLIANT

Method Detail

values

public static CodeCharacteristic[] 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 (CodeCharacteristic c : CodeCharacteristic.values())
    System.out.println(c);

Returns:

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

valueOf

public static CodeCharacteristic valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getCharacteristicsCategory

public CharacteristicsCategory getCharacteristicsCategory()