Package net.sourceforge.pmd

Enum PMD.StatusCode

java.lang.Object

java.lang.Enum<PMD.StatusCode>

net.sourceforge.pmd.PMD.StatusCode

All Implemented Interfaces:

Serializable, Comparable<PMD.StatusCode>

Enclosing class:

PMD

public static enum PMD.StatusCode
extends Enum<PMD.StatusCode>

Represents status codes that are used as exit codes during CLI runs.

See Also:

PMD.runPmd(String[])

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Errors were detected, PMD may have not run to the end.
OK	No errors, no violations.
VIOLATIONS_FOUND	No errors, but PMD found violations.

Method Summary

Modifier and Type	Method	Description
int	toInt()	Returns the exit code as used in CLI.
static PMD.StatusCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PMD.StatusCode[]	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

OK

public static final PMD.StatusCode OK

No errors, no violations. This is exit code 0.

ERROR

public static final PMD.StatusCode ERROR

Errors were detected, PMD may have not run to the end. This is exit code 1.

VIOLATIONS_FOUND

public static final PMD.StatusCode VIOLATIONS_FOUND

No errors, but PMD found violations. This is exit code 4. This is only returned if PMDConfiguration.isFailOnViolation() is set (CLI flag --failOnViolation).

Method Detail

values

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

Returns:

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

valueOf

public static PMD.StatusCode 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

toInt

public int toInt()

Returns the exit code as used in CLI.