/* ************************************************************************

   qooxdoo - the new era of web development

   http://qooxdoo.org

   Copyright:
     2004-2010 1&1 Internet AG, Germany, http://www.1und1.de

   License:
     LGPL: http://www.gnu.org/licenses/lgpl.html
     EPL: http://www.eclipse.org/org/documents/epl-v10.php
     See the LICENSE file in the project's top-level directory for details.

   Authors:
     * Daniel Wagner (d_wagner)

************************************************************************ */

/**
 * This error is thrown by the unit test class if an infrastructure requirement
 * is not met. The unit testing framework should skip the test and visually mark
 * the test as not having been executed.
 */
qx.Class.define("qx.dev.unit.RequirementError", {

  extend : Error,


  /*
  *****************************************************************************
     CONSTRUCTOR
  *****************************************************************************
  */

  /**
   * @param requirement {String?} The requirement ID, e.g. "SSL"
   * @param message {String?} Optional error message
   */
  construct : function(requirement, message) {

    this.__message = message || "Requirement not met";
    this.__requirement = requirement;

    var inst = Error.call(this, this.__message);
    // map stack trace properties since they're not added by Error's constructor
    if (inst.stack) {
      this.stack = inst.stack;
    }
    if (inst.stacktrace) {
      this.stacktrace = inst.stacktrace;
    }
  },


  /*
  *****************************************************************************
     MEMBERS
  *****************************************************************************
  */
  members :
  {
    __message : null,
    __requirement : null,


    /**
     * Returns the ID of the requirement that was not satisfied.
     *
     * @return {String} The requirement ID
     */
    getRequirement : function()
    {
      return this.__requirement;
    },


    /**
     * Returns a string representation of the error.
     *
     * @return {String} Error message
     */
    toString : function()
    {
      var msg = this.__message;
      if (this.__requirement) {
        msg += ": " + this.__requirement;
      }
      return msg;
    }
  }
});