com.google.javascript.jscomp.DiagnosticType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of closure-compiler Show documentation
Show all versions of closure-compiler Show documentation
Closure Compiler is a JavaScript optimizing compiler. It parses your
JavaScript, analyzes it, removes dead code and rewrites and minimizes
what's left. It also checks syntax, variable references, and types, and
warns about common JavaScript pitfalls. It is used in many of Google's
JavaScript apps, including Gmail, Google Web Search, Google Maps, and
Google Docs.
/*
* Copyright 2008 The Closure Compiler Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.javascript.jscomp;
import java.io.Serializable;
/**
* The type of a compile or analysis error.
*/
public final class DiagnosticType
implements Comparable, Serializable {
private static final long serialVersionUID = 1;
/**
* The error type. Used as the BugPattern and BugInstance types by
* BugBot's XML
*/
public final String key;
/** The default way to format errors. The style of format is java.text.MessageFormat. */
public final String format;
/** The default reporting level for this diagnostic */
public final CheckLevel level;
/**
* Create a DiagnosticType at level CheckLevel.ERROR
*
* @param name An identifier
* @param descriptionFormat A format string
* @return A new DiagnosticType
*/
public static DiagnosticType error(String name, String descriptionFormat) {
return make(name, CheckLevel.ERROR, descriptionFormat);
}
/**
* Create a DiagnosticType at level CheckLevel.WARNING
*
* @param name An identifier
* @param descriptionFormat A format string
* @return A new DiagnosticType
*/
public static DiagnosticType warning(String name, String descriptionFormat) {
return make(name, CheckLevel.WARNING, descriptionFormat);
}
/**
* Create a DiagnosticType at level CheckLevel.OFF
*
* @param name An identifier
* @param descriptionFormat A format string
* @return A new DiagnosticType
*/
public static DiagnosticType disabled(String name,
String descriptionFormat) {
return make(name, CheckLevel.OFF, descriptionFormat);
}
/**
* Create a DiagnosticType at a given CheckLevel.
*
* @param name An identifier
* @param level Either CheckLevel.ERROR or CheckLevel.WARNING
* @param descriptionFormat A format string
* @return A new DiagnosticType
*/
public static DiagnosticType make(String name, CheckLevel level,
String descriptionFormat) {
return new DiagnosticType(name, level, descriptionFormat);
}
/** Create a DiagnosticType. Private to force use of static factory methods. */
private DiagnosticType(String key, CheckLevel level, String format) {
this.key = key;
this.level = level;
this.format = format;
}
String format(String... arguments) {
return Platform.formatMessage(format, arguments);
}
@Override
public boolean equals(Object type) {
return type instanceof DiagnosticType && ((DiagnosticType) type).key.equals(key);
}
@Override
public int hashCode() {
return key.hashCode();
}
@Override
public int compareTo(DiagnosticType diagnosticType) {
return key.compareTo(diagnosticType.key);
}
@Override
public String toString() {
return key + ": " + format;
}
}