Package org.apache.maven.enforcer.rule.api

Enum EnforcerLevel

java.lang.Object

java.lang.Enum<EnforcerLevel>

org.apache.maven.enforcer.rule.api.EnforcerLevel

All Implemented Interfaces:

Serializable, Comparable<EnforcerLevel>

public enum EnforcerLevel
extends Enum<EnforcerLevel>

Levels steering whether a rule should fail a build or just display a warning.

Since:

1.4

Author:

Mirko Friedenhagen

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Fail the build.
WARN	Just warn.

Method Summary

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

ERROR

public static final EnforcerLevel ERROR

Fail the build.

WARN

public static final EnforcerLevel WARN

Just warn.

Method Detail

values

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

Returns:

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

valueOf

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