com.android.tools.lint.detector.api

Enum Severity

java.lang.Object

java.lang.Enum<Severity>

com.android.tools.lint.detector.api.Severity

All Implemented Interfaces:

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

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

Severity of an issue found by lint

NOTE: This is not a public or final API; if you rely on this be prepared to adjust your code for the next tools release.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Errors: The issue is known to be a real error that must be addressed.
FATAL Fatal: Use sparingly because a warning marked as fatal will be considered critical and will abort Export APK etc in ADT
IGNORE Ignore: The user doesn't want to see this issue
INFORMATIONAL Information only: Might not be a problem, but the check has found something interesting to say about the code.
WARNING Warning: Probably a problem.

Method Summary

Modifier and Type	Method and Description
static Severity	fromLintOptionSeverity(int severity) Returns a severity corresponding to the various LintOptions severity constants
static Severity	fromName(java.lang.String name) Looks up the severity corresponding to a given named severity.
java.lang.String	getDescription() Returns a description of this severity suitable for display to the user
java.lang.String	getName() Returns the name of this severity
boolean	isError() Returns true if this severity is at least an error
static Severity	max(Severity severity1, Severity severity2) Returns the largest / most severe of the two given severities
static Severity	min(Severity severity1, Severity severity2) Returns the smallest / least severe of the two given severities
static Severity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Severity[]	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

FATAL

@NonNull
public static final Severity FATAL

Fatal: Use sparingly because a warning marked as fatal will be considered critical and will abort Export APK etc in ADT

ERROR

@NonNull
public static final Severity ERROR

Errors: The issue is known to be a real error that must be addressed.

WARNING

@NonNull
public static final Severity WARNING

Warning: Probably a problem.

INFORMATIONAL

@NonNull
public static final Severity INFORMATIONAL

Information only: Might not be a problem, but the check has found something interesting to say about the code.

IGNORE

@NonNull
public static final Severity IGNORE

Ignore: The user doesn't want to see this issue

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

@NonNull
public java.lang.String getDescription()

Returns a description of this severity suitable for display to the user

Returns:

a description of the severity

getName

@NonNull
public java.lang.String getName()

Returns the name of this severity

fromName

@Nullable
public static Severity fromName(@NonNull
                                          java.lang.String name)

Looks up the severity corresponding to a given named severity. The severity string should be one returned by Enum.toString()

Parameters:

name - the name to look up

Returns:

the corresponding severity, or null if it is not a valid severity name

fromLintOptionSeverity

@NonNull
public static Severity fromLintOptionSeverity(int severity)

Returns a severity corresponding to the various LintOptions severity constants

Parameters:

severity - the LintOptions severity constant, such as LintOptions.SEVERITY_FATAL

Returns:

the corresponding lint Severity

min

@NonNull
public static Severity min(@NonNull
                                    Severity severity1,
                                    @NonNull
                                    Severity severity2)

Returns the smallest / least severe of the two given severities

Parameters:

severity1 - the first severity to compare

severity2 - the second severity to compare

Returns:

the least severe of the given severities

max

@NonNull
public static Severity max(@NonNull
                                    Severity severity1,
                                    @NonNull
                                    Severity severity2)

Returns the largest / most severe of the two given severities

Parameters:

severity1 - the first severity to compare

severity2 - the second severity to compare

Returns:

the most severe of the given severities

isError

public boolean isError()

Returns true if this severity is at least an error