org.sonar.api.rule

Enum RuleScope

java.lang.Object

java.lang.Enum<RuleScope>

org.sonar.api.rule.RuleScope

All Implemented Interfaces:

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

public enum RuleScope
extends java.lang.Enum<RuleScope>

Since:

7.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
MAIN
TEST

Method Summary

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

MAIN

public static final RuleScope MAIN

TEST

public static final RuleScope TEST

ALL

public static final RuleScope ALL

Method Detail

values

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

Returns:

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

valueOf

public static RuleScope 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

defaultScope

public static RuleScope defaultScope()