content/doc/javascript/apidoc/deferred.js.html - olingo-site - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Source: deferred.js</title>

     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
 </head>

 <body>

 <div id="main">

     <h1 class="page-title">Source: deferred.js</h1>


     <section>
         <article>
             <pre class="prettyprint source"><code>/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.
  */
 'use strict';

 /** @module odatajs/deferred */


 /** Creates a new function to forward a call.
  * @param {Object} thisValue - Value to use as the 'this' object.
  * @param {String} name - Name of function to forward to.
  * @param {Object} returnValue - Return value for the forward call (helps keep identity when chaining calls).
  * @returns {Function} A new function that will forward a call.
  */
 function forwardCall(thisValue, name, returnValue) {
     return function () {
         thisValue[name].apply(thisValue, arguments);
         return returnValue;
     };
 }

 /** Initializes a new DjsDeferred object.
  * &lt;ul>
  * &lt;li> Compability Note A - Ordering of callbacks through chained 'then' invocations &lt;br>
  *
  * The Wiki entry at http://wiki.commonjs.org/wiki/Promises/A
  * implies that .then() returns a distinct object.
  *
  * For compatibility with http://api.jquery.com/category/deferred-object/
  * we return this same object. This affects ordering, as
  * the jQuery version will fire callbacks in registration
  * order regardless of whether they occur on the result
  * or the original object.
  * &lt;/li>
  * &lt;li>Compability Note B - Fulfillment value &lt;br>
  *
  * The Wiki entry at http://wiki.commonjs.org/wiki/Promises/A
  * implies that the result of a success callback is the
  * fulfillment value of the object and is received by
  * other success callbacks that are chained.
  *
  * For compatibility with http://api.jquery.com/category/deferred-object/
  * we disregard this value instead.
  * &lt;/li>&lt;/ul>
  * @class DjsDeferred
  */
  function DjsDeferred() {
     this._arguments = undefined;
     this._done = undefined;
     this._fail = undefined;
     this._resolved = false;
     this._rejected = false;
 }


 DjsDeferred.prototype = {

     /** Adds success and error callbacks for this deferred object.
      * See Compatibility Note A.
      * @method DjsDeferred#then
      * @param {function} [fulfilledHandler] - Success callback ( may be null)
      * @param {function} [errorHandler] - Error callback ( may be null)
      */
     then: function (fulfilledHandler, errorHandler) {

         if (fulfilledHandler) {
             if (!this._done) {
                 this._done = [fulfilledHandler];
             } else {
                 this._done.push(fulfilledHandler);
             }
         }

         if (errorHandler) {
             if (!this._fail) {
                 this._fail = [errorHandler];
             } else {
                 this._fail.push(errorHandler);
             }
         }

         //// See Compatibility Note A in the DjsDeferred constructor.
         //// if (!this._next) {
         ////    this._next = createDeferred();
         //// }
         //// return this._next.promise();

         if (this._resolved) {
             this.resolve.apply(this, this._arguments);
         } else if (this._rejected) {
             this.reject.apply(this, this._arguments);
         }

         return this;
     },

     /** Invokes success callbacks for this deferred object.
      * All arguments are forwarded to success callbacks.
      * @method DjsDeferred#resolve
      */
     resolve: function (/* args */) {
         if (this._done) {
             var i, len;
             for (i = 0, len = this._done.length; i &lt; len; i++) {
                 //// See Compability Note B - Fulfillment value.
                 //// var nextValue =
                 this._done[i].apply(null, arguments);
             }

             //// See Compatibility Note A in the DjsDeferred constructor.
             //// this._next.resolve(nextValue);
             //// delete this._next;

             this._done = undefined;
             this._resolved = false;
             this._arguments = undefined;
         } else {
             this._resolved = true;
             this._arguments = arguments;
         }
     },

     /** Invokes error callbacks for this deferred object.
      * All arguments are forwarded to error callbacks.
      * @method DjsDeferred#reject
      */
     reject: function (/* args */) {

         if (this._fail) {
             var i, len;
             for (i = 0, len = this._fail.length; i &lt; len; i++) {
                 this._fail[i].apply(null, arguments);
             }

             this._fail = undefined;
             this._rejected = false;
             this._arguments = undefined;
         } else {
             this._rejected = true;
             this._arguments = arguments;
         }
     },

     /** Returns a version of this object that has only the read-only methods available.
      * @method DjsDeferred#promise
      * @returns An object with only the promise object.
      */

     promise: function () {
         var result = {};
         result.then = forwardCall(this, "then", result);
         return result;
     }
 };

 /** Creates a deferred object.
  * @returns {DjsDeferred} A new deferred object. If jQuery is installed, then a jQueryDeferred object is returned, which provides a superset of features.
 */
 function createDeferred() {
     if (window.jQuery && window.jQuery.Deferred) {
         return new window.jQuery.Deferred();
     } else {
         return new DjsDeferred();
     }
 }


 /** createDeferred (see {@link module:datajs/deferred~createDeferred}) */
 exports.createDeferred = createDeferred;

 /** DjsDeferred (see {@link DjsDeferred}) */
 exports.DjsDeferred = DjsDeferred;</code></pre>
         </article>
     </section>


 </div>

 <nav>
     <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cache.html">cache</a></li><li><a href="source.html">cache/source</a></li><li><a href="module-odata.html">odata</a></li><li><a href="batch.html">odata/batch</a></li><li><a href="handler.html">odata/handler</a></li><li><a href="json.html">odata/json</a></li><li><a href="metadata.html">odata/metadata</a></li><li><a href="net.html">odata/net</a></li><li><a href="utils.html">odata/utils</a></li><li><a href="deferred.html">odatajs/deferred</a></li><li><a href="utils_.html">odatajs/utils</a></li><li><a href="xml.html">odatajs/xml</a></li><li><a href="module-store.html">store</a></li><li><a href="dom.html">store/dom</a></li><li><a href="indexeddb.html">store/indexeddb</a></li><li><a href="memory.html">store/memory</a></li></ul><h3>Classes</h3><ul><li><a href="DataCache.html">DataCache</a></li><li><a href="DataCacheOperation.html">DataCacheOperation</a></li><li><a href="DjsDeferred.html">DjsDeferred</a></li><li><a href="dom-DomStore.html">DomStore</a></li><li><a href="indexeddb-IndexedDBStore.html">IndexedDBStore</a></li><li><a href="memory-MemoryStore.html">MemoryStore</a></li><li><a href="ODataCacheSource.html">ODataCacheSource</a></li></ul><h3><a href="global.html">Global</a></h3>
 </nav>

 <br clear="both">

 <footer>
     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Apr 09 2015 08:31:26 GMT+0200 (MESZ)
 </footer>

 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>
 </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>JSDoc: Source: deferred.js</title>

	<script src="scripts/prettify/prettify.js"> </script>
	<script src="scripts/prettify/lang-css.js"> </script>
	<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
	<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
	</head>

	<body>

	<div id="main">

	<h1 class="page-title">Source: deferred.js</h1>





	<section>
	<article>
	<pre class="prettyprint source"><code>/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.
	*/
	'use strict';

	/** @module odatajs/deferred */



	/** Creates a new function to forward a call.
	* @param {Object} thisValue - Value to use as the 'this' object.
	* @param {String} name - Name of function to forward to.
	* @param {Object} returnValue - Return value for the forward call (helps keep identity when chaining calls).
	* @returns {Function} A new function that will forward a call.
	*/
	function forwardCall(thisValue, name, returnValue) {
	return function () {
	thisValue[name].apply(thisValue, arguments);
	return returnValue;
	};
	}

	/** Initializes a new DjsDeferred object.
	* <ul>
	* <li> Compability Note A - Ordering of callbacks through chained 'then' invocations <br>
	*
	* The Wiki entry at http://wiki.commonjs.org/wiki/Promises/A
	* implies that .then() returns a distinct object.
	*
	* For compatibility with http://api.jquery.com/category/deferred-object/
	* we return this same object. This affects ordering, as
	* the jQuery version will fire callbacks in registration
	* order regardless of whether they occur on the result
	* or the original object.
	* </li>
	* <li>Compability Note B - Fulfillment value <br>
	*
	* The Wiki entry at http://wiki.commonjs.org/wiki/Promises/A
	* implies that the result of a success callback is the
	* fulfillment value of the object and is received by
	* other success callbacks that are chained.
	*
	* For compatibility with http://api.jquery.com/category/deferred-object/
	* we disregard this value instead.
	* </li></ul>
	* @class DjsDeferred
	*/
	function DjsDeferred() {
	this._arguments = undefined;
	this._done = undefined;
	this._fail = undefined;
	this._resolved = false;
	this._rejected = false;
	}


	DjsDeferred.prototype = {

	/** Adds success and error callbacks for this deferred object.
	* See Compatibility Note A.
	* @method DjsDeferred#then
	* @param {function} [fulfilledHandler] - Success callback ( may be null)
	* @param {function} [errorHandler] - Error callback ( may be null)
	*/
	then: function (fulfilledHandler, errorHandler) {

	if (fulfilledHandler) {
	if (!this._done) {
	this._done = [fulfilledHandler];
	} else {
	this._done.push(fulfilledHandler);
	}
	}

	if (errorHandler) {
	if (!this._fail) {
	this._fail = [errorHandler];
	} else {
	this._fail.push(errorHandler);
	}
	}

	//// See Compatibility Note A in the DjsDeferred constructor.
	//// if (!this._next) {
	//// this._next = createDeferred();
	//// }
	//// return this._next.promise();

	if (this._resolved) {
	this.resolve.apply(this, this._arguments);
	} else if (this._rejected) {
	this.reject.apply(this, this._arguments);
	}

	return this;
	},

	/** Invokes success callbacks for this deferred object.
	* All arguments are forwarded to success callbacks.
	* @method DjsDeferred#resolve
	*/
	resolve: function (/* args */) {
	if (this._done) {
	var i, len;
	for (i = 0, len = this._done.length; i < len; i++) {
	//// See Compability Note B - Fulfillment value.
	//// var nextValue =
	this._done[i].apply(null, arguments);
	}

	//// See Compatibility Note A in the DjsDeferred constructor.
	//// this._next.resolve(nextValue);
	//// delete this._next;

	this._done = undefined;
	this._resolved = false;
	this._arguments = undefined;
	} else {
	this._resolved = true;
	this._arguments = arguments;
	}
	},

	/** Invokes error callbacks for this deferred object.
	* All arguments are forwarded to error callbacks.
	* @method DjsDeferred#reject
	*/
	reject: function (/* args */) {

	if (this._fail) {
	var i, len;
	for (i = 0, len = this._fail.length; i < len; i++) {
	this._fail[i].apply(null, arguments);
	}

	this._fail = undefined;
	this._rejected = false;
	this._arguments = undefined;
	} else {
	this._rejected = true;
	this._arguments = arguments;
	}
	},

	/** Returns a version of this object that has only the read-only methods available.
	* @method DjsDeferred#promise
	* @returns An object with only the promise object.
	*/

	promise: function () {
	var result = {};
	result.then = forwardCall(this, "then", result);
	return result;
	}
	};

	/** Creates a deferred object.
	* @returns {DjsDeferred} A new deferred object. If jQuery is installed, then a jQueryDeferred object is returned, which provides a superset of features.
	*/
	function createDeferred() {
	if (window.jQuery && window.jQuery.Deferred) {
	return new window.jQuery.Deferred();
	} else {
	return new DjsDeferred();
	}
	}




	/** createDeferred (see {@link module:datajs/deferred~createDeferred}) */
	exports.createDeferred = createDeferred;

	/** DjsDeferred (see {@link DjsDeferred}) */
	exports.DjsDeferred = DjsDeferred;</code></pre>
	</article>
	</section>




	</div>

	<nav>
	<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-cache.html">cache</a></li><li><a href="source.html">cache/source</a></li><li><a href="module-odata.html">odata</a></li><li><a href="batch.html">odata/batch</a></li><li><a href="handler.html">odata/handler</a></li><li><a href="json.html">odata/json</a></li><li><a href="metadata.html">odata/metadata</a></li><li><a href="net.html">odata/net</a></li><li><a href="utils.html">odata/utils</a></li><li><a href="deferred.html">odatajs/deferred</a></li><li><a href="utils_.html">odatajs/utils</a></li><li><a href="xml.html">odatajs/xml</a></li><li><a href="module-store.html">store</a></li><li><a href="dom.html">store/dom</a></li><li><a href="indexeddb.html">store/indexeddb</a></li><li><a href="memory.html">store/memory</a></li></ul><h3>Classes</h3><ul><li><a href="DataCache.html">DataCache</a></li><li><a href="DataCacheOperation.html">DataCacheOperation</a></li><li><a href="DjsDeferred.html">DjsDeferred</a></li><li><a href="dom-DomStore.html">DomStore</a></li><li><a href="indexeddb-IndexedDBStore.html">IndexedDBStore</a></li><li><a href="memory-MemoryStore.html">MemoryStore</a></li><li><a href="ODataCacheSource.html">ODataCacheSource</a></li></ul><h3><a href="global.html">Global</a></h3>
	</nav>

	<br clear="both">

	<footer>
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Apr 09 2015 08:31:26 GMT+0200 (MESZ)
	</footer>

	<script> prettyPrint(); </script>
	<script src="scripts/linenumber.js"> </script>
	</body>
	</html>