api_spec/Errors.js.html - ignite-nodejs-thin-client - Git at Google

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

     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->
     <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: Errors.js</h1>


     <section>
         <article>
             <pre class="prettyprint source linenums"><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';

 const Util = require('util');

 /**
  * Base Ignite client error class.
  */
 class IgniteClientError extends Error {
     constructor(message) {
         super(message);
     }

     /**
      * Ignite client does not support one of the specified or received data types.
      * @ignore
      */
     static unsupportedTypeError(type) {
         const BinaryUtils = require('./internal/BinaryUtils');
         return new IgniteClientError(Util.format('Type %s is not supported', BinaryUtils.getTypeName(type)));
     }

     /**
      * The real type of data is not equal to the specified one.
      * @ignore
      */
     static typeCastError(fromType, toType) {
         const BinaryUtils = require('./internal/BinaryUtils');
         return new IgniteClientError(Util.format('Type "%s" can not be cast to %s',
             BinaryUtils.getTypeName(fromType), BinaryUtils.getTypeName(toType)));
     }

     /**
      * The real value can not be cast to the specified type.
      * @ignore
      */
     static valueCastError(value, toType) {
         const BinaryUtils = require('./internal/BinaryUtils');
         return new IgniteClientError(Util.format('Value "%s" can not be cast to %s',
             value, BinaryUtils.getTypeName(toType)));
     }

     /**
      * An illegal or inappropriate argument has been passed to the API method.
      * @ignore
      */
     static illegalArgumentError(message) {
         return new IgniteClientError(message);
     }

     /**
      * Ignite client internal error.
      * @ignore
      */
     static internalError(message = null) {
         return new IgniteClientError(message || 'Internal library error');
     }

     /**
      * Serialization/deserialization errors.
      * @ignore
      */
     static serializationError(serialize, message = null) {
         let msg = serialize ? 'Complex object can not be serialized' : 'Complex object can not be deserialized';
         if (message) {
             msg = msg + ': ' + message;
         }
         return new IgniteClientError(msg);
     }
 }

 /**
  * Ignite server returns error for the requested operation.
  * @extends IgniteClientError
  */
 class OperationError extends IgniteClientError {
     constructor(message) {
         super(message);
     }
 }

 /**
  * Ignite client is not in an appropriate state for the requested operation.
  * @extends IgniteClientError
  */
 class IllegalStateError extends IgniteClientError {
     constructor(message = null) {
         super(message || 'Ignite client is not in an appropriate state for the requested operation');
     }
 }

 /**
  * The requested operation is not completed due to the connection lost.
  * @extends IgniteClientError
  */
 class LostConnectionError extends IgniteClientError {
     constructor(message = null) {
         super(message || 'Request is not completed due to the connection lost');
     }
 }

 module.exports.IgniteClientError = IgniteClientError;
 module.exports.OperationError = OperationError;
 module.exports.IllegalStateError = IllegalStateError;
 module.exports.LostConnectionError = LostConnectionError;
 </code></pre>
         </article>
     </section>


 </div>

 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul>
 </nav>

 <br class="clear">

 <footer>
     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 22 2018 12:08:48 GMT+0300 (Russia TZ 2 Standard Time)
 </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: Errors.js</title>

	<script src="scripts/prettify/prettify.js"> </script>
	<script src="scripts/prettify/lang-css.js"> </script>
	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<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: Errors.js</h1>






	<section>
	<article>
	<pre class="prettyprint source linenums"><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';

	const Util = require('util');

	/**
	* Base Ignite client error class.
	*/
	class IgniteClientError extends Error {
	constructor(message) {
	super(message);
	}

	/**
	* Ignite client does not support one of the specified or received data types.
	* @ignore
	*/
	static unsupportedTypeError(type) {
	const BinaryUtils = require('./internal/BinaryUtils');
	return new IgniteClientError(Util.format('Type %s is not supported', BinaryUtils.getTypeName(type)));
	}

	/**
	* The real type of data is not equal to the specified one.
	* @ignore
	*/
	static typeCastError(fromType, toType) {
	const BinaryUtils = require('./internal/BinaryUtils');
	return new IgniteClientError(Util.format('Type "%s" can not be cast to %s',
	BinaryUtils.getTypeName(fromType), BinaryUtils.getTypeName(toType)));
	}

	/**
	* The real value can not be cast to the specified type.
	* @ignore
	*/
	static valueCastError(value, toType) {
	const BinaryUtils = require('./internal/BinaryUtils');
	return new IgniteClientError(Util.format('Value "%s" can not be cast to %s',
	value, BinaryUtils.getTypeName(toType)));
	}

	/**
	* An illegal or inappropriate argument has been passed to the API method.
	* @ignore
	*/
	static illegalArgumentError(message) {
	return new IgniteClientError(message);
	}

	/**
	* Ignite client internal error.
	* @ignore
	*/
	static internalError(message = null) {
	return new IgniteClientError(message \|\| 'Internal library error');
	}

	/**
	* Serialization/deserialization errors.
	* @ignore
	*/
	static serializationError(serialize, message = null) {
	let msg = serialize ? 'Complex object can not be serialized' : 'Complex object can not be deserialized';
	if (message) {
	msg = msg + ': ' + message;
	}
	return new IgniteClientError(msg);
	}
	}

	/**
	* Ignite server returns error for the requested operation.
	* @extends IgniteClientError
	*/
	class OperationError extends IgniteClientError {
	constructor(message) {
	super(message);
	}
	}

	/**
	* Ignite client is not in an appropriate state for the requested operation.
	* @extends IgniteClientError
	*/
	class IllegalStateError extends IgniteClientError {
	constructor(message = null) {
	super(message \|\| 'Ignite client is not in an appropriate state for the requested operation');
	}
	}

	/**
	* The requested operation is not completed due to the connection lost.
	* @extends IgniteClientError
	*/
	class LostConnectionError extends IgniteClientError {
	constructor(message = null) {
	super(message \|\| 'Request is not completed due to the connection lost');
	}
	}

	module.exports.IgniteClientError = IgniteClientError;
	module.exports.OperationError = OperationError;
	module.exports.IllegalStateError = IllegalStateError;
	module.exports.LostConnectionError = LostConnectionError;
	</code></pre>
	</article>
	</section>




	</div>

	<nav>
	<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul>
	</nav>

	<br class="clear">

	<footer>
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 22 2018 12:08:48 GMT+0300 (Russia TZ 2 Standard Time)
	</footer>

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