Key/Value Pair

Description

"codeapedia.keyValuePair.js" Defines a key/value pair that can be set or retrieved.

Code

/**
* @projectDescription  keyValuePair library
*
* @author   Ryan Estes  http://www.codeapedia.com
* @version  0.1
*/

/**
* Create a new instance of keyValuePair
*
* @classDescription           Defines a key/value pair
* @return {keyValuePair}      Returns a new keyValuePair.
* @type {Object}
* @constructor 
*/
function keyValuePair()
{
   var strKey = null;
   var strValue = null;

   if(arguments.length == 2)
   {
      strKey = arguments[0];
      strValue = arguments[1];
   }

   this.key = strKey;
   this.value = strValue;
   
   /**
   * Concatenates the key and value of a keyValuePair.
   * (Optional) Argument specifies the delimiter
   * @return {String}
   */
   this.toString = function() {
      var strDelimiter = (arguments.length == 1)? 
                          arguments[0] : "";
      return this.key + strDelimiter + this.value;
   }
}

Examples

Code section below results with alerts "Key" and "Value".
// demonstrates default constructor
var objKeyValue = new keyValuePair();
objKeyValue.key = "Key";
objKeyValue.value = "Value";
alert(objKeyValue.key);
alert(objKeyValue.value);

Code section below results with alerts "Key" and "Value".
// demonstrates contructor optional parameters
var objKeyValue = new keyValuePair("Key","Value");
alert(objKeyValue.key);
alert(objKeyValue.value);