In the analysis server API, change RequestError.code to an enum.

pkg/analysis_server/lib/src/protocol.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library protocol;
 
 import 'dart:collection';
 import 'dart:convert';
 
 import 'package:analysis_server/src/computer/element.dart' show
@@ skipping 739 matching lines @@
    * related to the error.
    */
   static const String DATA = 'data';
 
   /**
    * The name of the JSON attribute containing a short description of the error.
    */
   static const String MESSAGE = 'message';
 
   /**
-   * An error code indicating a parse error. Invalid JSON was received by the
-   * server. An error occurred on the server while parsing the JSON text.
-   */
-  static const String CODE_PARSE_ERROR = 'PARSE_ERROR';
-
-  /**
-   * An error code indicating that the analysis server has already been
-   * started (and hence won't accept new connections).
-   */
-  static const String CODE_SERVER_ALREADY_STARTED = 'SERVER_ALREADY_STARTED';
-
-  /**
-   * An error code indicating an invalid request. The JSON sent is not a valid
-   * [Request] object.
-   */
-  static const String CODE_INVALID_REQUEST = 'INVALID_REQUEST';
-
-  /**
-   * An error code indicating a method not found. The method does not exist or
-   * is not currently available.
-   */
-  static const String CODE_METHOD_NOT_FOUND = 'METHOD_NOT_FOUND';
-
-  /**
-   * An error code indicating one or more invalid parameters.
-   */
-  static const String CODE_INVALID_PARAMS = 'INVALID_PARAMS';
-
-  /**
-   * An error code indicating an internal error.
-   */
-  static const String CODE_INTERNAL_ERROR = 'INTERNAL_ERROR';
-
-  /**
    * An error code indicating a problem using the specified Dart SDK.
    */
   static const String CODE_SDK_ERROR = 'SDK_ERROR';
 
   /**
    * An error code indicating a problem during 'analysis.getErrors'.
    */
   static const String CODE_ANALISYS_GET_ERRORS_ERROR = 'ANALYSIS_GET_ERRORS_ERROR';
 
   /**
    * The code that uniquely identifies the error that occurred.
    */
-  final String code;
+  final RequestErrorCode code;
 
   /**
    * A short description of the error.
    */
   final String message;
 
   /**
    * A table mapping the names of notification parameters to their values.
    */
   final Map<String, Object> data = new HashMap<String, Object>();
 
   /**
    * Initialize a newly created [Error] to have the given [code] and [message].
    */
   RequestError(this.code, this.message);
 
   /**
    * Initialize a newly created [Error] from the given JSON.
    */
   factory RequestError.fromJson(Map<String, Object> json) {
     try {
-      String code = json[RequestError.CODE];
+      RequestErrorCode code = new RequestErrorCode(json[RequestError.CODE]);
       String message = json[RequestError.MESSAGE];
       Map<String, Object> data = json[RequestError.DATA];
       RequestError requestError = new RequestError(code, message);
       if (data != null) {
         data.forEach((String key, Object value) {
           requestError.setData(key, value);
         });
       }
       return requestError;
     } catch (exception) {
       return null;
     }
   }
 
   /**
-   * Initialize a newly created [Error] to indicate an internal error.
-   */
-  RequestError.internalError() : this(CODE_INTERNAL_ERROR, "Internal error");
-
-  /**
-   * Initialize a newly created [Error] to indicate one or more invalid
-   * parameters.
-   */
-  RequestError.invalidParameters() : this(CODE_INVALID_PARAMS, "Invalid parameters");
-
-  /**
-   * Initialize a newly created [Error] to indicate an invalid request. The
-   * JSON sent is not a valid [Request] object.
-   */
-  RequestError.invalidRequest() : this(CODE_INVALID_REQUEST, "Invalid request");
-
-  /**
-   * Initialize a newly created [Error] to indicate that a method was not found.
-   * Either the method does not exist or is not currently available.
-   */
-  RequestError.methodNotFound() : this(CODE_METHOD_NOT_FOUND, "Method not found");
-
-  /**
-   * Initialize a newly created [Error] to indicate a parse error. Invalid JSON
-   * was received by the server. An error occurred on the server while parsing
-   * the JSON text.
-   */
-  RequestError.parseError() : this(CODE_PARSE_ERROR, "Parse error");
-
-  /**
    * Initialize a newly created [Error] to indicate that the analysis server
    * has already been started (and hence won't accept new connections).
    */
   RequestError.serverAlreadyStarted()
-    : this(CODE_SERVER_ALREADY_STARTED, "Server already started");
+    : this(RequestErrorCode.SERVER_ALREADY_STARTED, "Server already started");
 
   /**
    * Return the value of the data with the given [name], or `null` if there is
    * no such data associated with this error.
    */
   Object getData(String name) => data[name];
 
   /**
    * Set the value of the data with the given [name] to the given [value].
    */
   void setData(String name, Object value) {
     data[name] = value;
   }
 
   /**
    * Return a table representing the structure of the Json object that will be
    * sent to the client to represent this response.
    */
   Map<String, Object> toJson() {
     Map<String, Object> jsonObject = new HashMap<String, Object>();
-    jsonObject[CODE] = code;
+    jsonObject[CODE] = code.name;
     jsonObject[MESSAGE] = message;
     if (!data.isEmpty) {
       jsonObject[DATA] = data;
     }
     return jsonObject;
   }
 
   @override
   String toString() => toJson().toString();
 }
@@ skipping 76 matching lines @@
 
   /**
    * Initialize a newly created instance to represent a response to a request
    * with the given [id].  If [_result] is provided, it will be used as the
    * result; otherwise an empty result will be used.  If an [error] is provided
    * then the response will represent an error condition.
    */
   Response(this.id, {Map<String, Object> result, this.error})
       : _result = result;
 
-  Response.contextAlreadyExists(Request request)
-    : this(request.id, error: new RequestError('CONTENT_ALREADY_EXISTS', 'Context already exists'));
-
-  /**
-   * Initialize a newly created instance to represent an error condition caused
-   * by a [request] referencing a context that does not exist.
-   */
-  Response.contextDoesNotExist(Request request)
-    : this(request.id, error: new RequestError('NONEXISTENT_CONTEXT', 'Context does not exist'));
-
   /**
    * Initialize a newly created instance based upon the given JSON data
    */
   factory Response.fromJson(Map<String, Object> json) {
     try {
       Object id = json[Response.ID];
       if (id is! String) {
         return null;
       }
       Object error = json[Response.ERROR];
@@ skipping 14 matching lines @@
   }
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by an error during `analysis.getErrors`.
    */
   Response.getErrorsError(Request request, String message,
       Map<String, Object> result)
     : this(
         request.id,
-        error: new RequestError('GET_ERRORS_ERROR', 'Error during `analysis.getErrors`: $message.'),
+        error: new RequestError(RequestErrorCode.GET_ERRORS_ERROR, 'Error during `analysis.getErrors`: $message.'),
         result: result);
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a [request] that had invalid parameter.  [path] is the path to the
    * invalid parameter, in Javascript notation (e.g. "foo.bar" means that the
    * parameter "foo" contained a key "bar" whose value was the wrong type).
    * [expectation] is a description of the type of data that was expected.
    */
   Response.invalidParameter(Request request, String path, String expectation)
-      : this(request.id, error: new RequestError('INVALID_PARAMETER',
+      : this(request.id, error: new RequestError(RequestErrorCode.INVALID_PARAMETER,
           "Expected parameter $path to $expectation"));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a malformed request.
    */
   Response.invalidRequestFormat()
-    : this('', error: new RequestError('INVALID_REQUEST', 'Invalid request'));
+    : this('', error: new RequestError(RequestErrorCode.INVALID_REQUEST, 'Invalid request'));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
-   * by a [request] that does not have a required parameter.
-   */
-  Response.missingRequiredParameter(Request request, String parameterName)
-    : this(request.id, error: new RequestError('MISSING_PARAMETER', 'Missing required parameter: $parameterName'));
-
-  /**
-   * Initialize a newly created instance to represent an error condition caused
    * by a `analysis.setPriorityFiles` [request] that includes one or more files
    * that are not being analyzed.
    */
   Response.unanalyzedPriorityFiles(Request request, String fileNames)
-    : this(request.id, error: new RequestError('UNANALYZED_PRIORITY_FILES', "Unanalyzed files cannot be a priority: '$fileNames'"));
-
-  /**
-   * Initialize a newly created instance to represent an error condition caused
-   * by a [request] that takes a set of analysis options but for which an
-   * unknown analysis option was provided.
-   */
-  Response.unknownAnalysisOption(Request request, String optionName)
-    : this(request.id, error: new RequestError('UNKNOWN_ANALYSIS_OPTION', 'Unknown analysis option: "$optionName"'));
-
-  /**
-   * Initialize a newly created instance to represent an error condition caused
-   * by a `analysis.setSubscriptions` [request] that includes an unknown
-   * analysis service name.
-   */
-  Response.unknownAnalysisService(Request request, String name)
-    : this(request.id, error: new RequestError('UNKNOWN_ANALYSIS_SERVICE', 'Unknown analysis service: "$name"'));
-
-  /**
-   * Initialize a newly created instance to represent an error condition caused
-   * by a `analysis.updateOptions` [request] that includes an unknown analysis
-   * option.
-   */
-  Response.unknownOptionName(Request request, String optionName)
-    : this(request.id, error: new RequestError('UNKNOWN_OPTION_NAME', 'Unknown analysis option: "$optionName"'));
+    : this(request.id, error: new RequestError(RequestErrorCode.UNANALYZED_PRIORITY_FILES, "Unanalyzed files cannot be a priority: '$fileNames'"));
 
   /**
    * Initialize a newly created instance to represent an error condition caused
    * by a [request] that cannot be handled by any known handlers.
    */
   Response.unknownRequest(Request request)
-    : this(request.id, error: new RequestError('UNKNOWN_REQUEST', 'Unknown request'));
+    : this(request.id, error: new RequestError(RequestErrorCode.UNKNOWN_REQUEST, 'Unknown request'));
 
   Response.unsupportedFeature(String requestId, String message)
-    : this(requestId, error: new RequestError('UNSUPPORTED_FEATURE', message));
+    : this(requestId, error: new RequestError(RequestErrorCode.UNSUPPORTED_FEATURE, message));
 
   /**
    * Return a table representing the structure of the Json object that will be
    * sent to the client to represent this response.
    */
   Map<String, Object> toJson() {
     Map<String, Object> jsonObject = new HashMap<String, Object>();
     jsonObject[ID] = id;
     if (error != null) {
       jsonObject[ERROR] = error.toJson();
@@ skipping 38 matching lines @@
     hash = 0x1fffffff & (hash + ((0x03ffffff & hash) << 3));
     hash = hash ^ (hash >> 11);
     return 0x1fffffff & (hash + ((0x00003fff & hash) << 15));
   }
 
   static int hash2(a, b) => finish(combine(combine(0, a), b));
 
   static int hash4(a, b, c, d) =>
       finish(combine(combine(combine(combine(0, a), b), c), d));
 }