javax.tools

Enum Diagnostic.Kind

java.lang.Object

java.lang.Enum<Diagnostic.Kind>

javax.tools.Diagnostic.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Diagnostic.Kind>

Enclosing interface:

Diagnostic<S>

public static enum Diagnostic.Kind
extends java.lang.Enum<Diagnostic.Kind>

Kinds of diagnostics, for example, error or warning. The kind of a diagnostic can be used to determine how the diagnostic should be presented to the user. For example, errors might be colored red or prefixed with the word "Error", while warnings might be colored yellow or prefixed with the word "Warning". There is no requirement that the Kind should imply any inherent semantic meaning to the message of the diagnostic: for example, a tool might provide an option to report all warnings as errors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Problem which prevents the tool's normal completion.
MANDATORY_WARNING Problem similar to a warning, but is mandated by the tool's specification.
NOTE Informative message from the tool.
OTHER Diagnostic which does not fit within the other kinds.
WARNING Problem which does not usually prevent the tool from completing normally.

Method Summary

Methods

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

Problem which prevents the tool's normal completion.

WARNING

public static final Diagnostic.Kind WARNING

Problem which does not usually prevent the tool from completing normally.

MANDATORY_WARNING

public static final Diagnostic.Kind MANDATORY_WARNING

Problem similar to a warning, but is mandated by the tool's specification. For example, the Java™ Language Specification mandates warnings on certain unchecked operations and the use of deprecated methods.

NOTE

public static final Diagnostic.Kind NOTE

Informative message from the tool.

OTHER

public static final Diagnostic.Kind OTHER

Diagnostic which does not fit within the other kinds.

Method Detail

values

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

Returns:

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

valueOf

public static Diagnostic.Kind 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