com.google.javascript.jscomp

Class DiagnosticType

java.lang.Object

com.google.javascript.jscomp.DiagnosticType

All Implemented Interfaces:

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

public final class DiagnosticType
extends java.lang.Object
implements java.lang.Comparable<DiagnosticType>, java.io.Serializable

The type of a compile or analysis error.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
CheckLevel	defaultLevel Default level
MessageFormat	format The default way to format errors
java.lang.String	key The error type.
CheckLevel	level Reporting level, initially the defaultLevel but may be changed.
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DiagnosticType(java.lang.String key, CheckLevel level, MessageFormat format) Create a DiagnosticType.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DiagnosticType diagnosticType)
static DiagnosticType	disabled(java.lang.String name, java.lang.String descriptionFormat) Create a DiagnosticType at level CheckLevel.OFF
boolean	equals(java.lang.Object type)
static DiagnosticType	error(java.lang.String name, java.lang.String descriptionFormat) Create a DiagnosticType at level CheckLevel.ERROR
(package private) java.lang.String	format(java.lang.Object... arguments) Create a description from the MessageFormat and the arguments.
int	hashCode()
static DiagnosticType	make(java.lang.String name, CheckLevel level, java.lang.String descriptionFormat) Create a DiagnosticType at a given CheckLevel.
java.lang.String	toString()
static DiagnosticType	warning(java.lang.String name, java.lang.String descriptionFormat) Create a DiagnosticType at level CheckLevel.WARNING

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

key

public final java.lang.String key

The error type. Used as the BugPattern and BugInstance types by BugBot's XML

format

public final MessageFormat format

The default way to format errors

defaultLevel

public final CheckLevel defaultLevel

Default level

level

public CheckLevel level

Reporting level, initially the defaultLevel but may be changed.

Constructor Detail

DiagnosticType

private DiagnosticType(java.lang.String key,
                       CheckLevel level,
                       MessageFormat format)

Create a DiagnosticType. Private to force use of static factory methods.

Method Detail

error

public static DiagnosticType error(java.lang.String name,
                                   java.lang.String descriptionFormat)

Create a DiagnosticType at level CheckLevel.ERROR

Parameters:

name - An identifier

descriptionFormat - A format string

Returns:

A new DiagnosticType

warning

public static DiagnosticType warning(java.lang.String name,
                                     java.lang.String descriptionFormat)

Create a DiagnosticType at level CheckLevel.WARNING

Parameters:

name - An identifier

descriptionFormat - A format string

Returns:

A new DiagnosticType

disabled

public static DiagnosticType disabled(java.lang.String name,
                                      java.lang.String descriptionFormat)

Create a DiagnosticType at level CheckLevel.OFF

Parameters:

name - An identifier

descriptionFormat - A format string

Returns:

A new DiagnosticType

make

public static DiagnosticType make(java.lang.String name,
                                  CheckLevel level,
                                  java.lang.String descriptionFormat)

Create a DiagnosticType at a given CheckLevel.

Parameters:

name - An identifier

level - Either CheckLevel.ERROR or CheckLevel.WARNING

descriptionFormat - A format string

Returns:

A new DiagnosticType

format

java.lang.String format(java.lang.Object... arguments)

Create a description from the MessageFormat and the arguments. Used by unit tests.

equals

public boolean equals(java.lang.Object type)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(DiagnosticType diagnosticType)

Specified by:

compareTo in interface java.lang.Comparable<DiagnosticType>

toString

@GwtIncompatible(value="java.text.MessageFormat.toPattern()")
public java.lang.String toString()

Overrides:

toString in class java.lang.Object