Source: error/AbstractError.js

  1. /*
  2.  * Copyright 2003-2006, 2009, 2017, 2020 United States Government, as represented
  3.  * by the Administrator of the National Aeronautics and Space Administration.
  4.  * All rights reserved.
  5.  *
  6.  * The NASAWorldWind/WebWorldWind platform is licensed under the Apache License,
  7.  * Version 2.0 (the "License"); you may not use this file except in compliance
  8.  * with the License. You may obtain a copy of the License
  9.  * at http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software distributed
  12.  * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  13.  * CONDITIONS OF ANY KIND, either express or implied. See the License for the
  14.  * specific language governing permissions and limitations under the License.
  15.  *
  16.  * NASAWorldWind/WebWorldWind also contains the following 3rd party Open Source
  17.  * software:
  18.  *
  19.  *    ES6-Promise – under MIT License
  20.  *    libtess.js – SGI Free Software License B
  21.  *    Proj4 – under MIT License
  22.  *    JSZip – under MIT License
  23.  *
  24.  * A complete listing of 3rd Party software notices and licenses included in
  25.  * WebWorldWind can be found in the WebWorldWind 3rd-party notices and licenses
  26.  * PDF found in code  directory.
  27.  */
  28. /**
  29.  * @exports AbstractError
  30.  */
  31. define(function () {
  32.     "use strict";
  34.     /**
  35.      * Constructs an error with a specified name and message.
  36.      * @alias AbstractError
  37.      * @constructor
  38.      * @abstract
  39.      * @classdesc Provides an abstract base class for error classes. This class is not meant to be instantiated
  40.      * directly but used only by subclasses.
  41.      * @param {String} name The error's name.
  42.      * @param {String} message The message.
  43.      */
  44.     var AbstractError = function (name, message) {
  45.         this.name = name;
  46.         this.message = message;
  47.     };
  49.     /**
  50.      * Returns the message and stack trace associated with this error.
  51.      * @returns {String} The message and stack trace associated with this error.
  52.      */
  53.     AbstractError.prototype.toString = function () {
  54.         var str = this.name + ': ' + this.message;
  56.         if (this.stack) {
  57.             str += '\n' + this.stack.toString();
  58.         }
  60.         return str;
  61.     };
  63.     return AbstractError;
  65. });