as3corelib 0.1.0

data/src/com/adobe/utils/DictionaryUtil.as

@@ -0,0 +1,87 @@
+/*
+  Copyright (c) 2008, Adobe Systems Incorporated
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without 
+  modification, are permitted provided that the following conditions are
+  met:
+
+  * Redistributions of source code must retain the above copyright notice, 
+    this list of conditions and the following disclaimer.
+  
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the 
+    documentation and/or other materials provided with the distribution.
+  
+  * Neither the name of Adobe Systems Incorporated nor the names of its 
+    contributors may be used to endorse or promote products derived from 
+    this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+package com.adobe.utils
+{
+	import flash.utils.Dictionary;
+	
+	public class DictionaryUtil
+	{
+		
+		/**
+		*	Returns an Array of all keys within the specified dictionary.	
+		* 
+		* 	@param d The Dictionary instance whose keys will be returned.
+		* 
+		* 	@return Array of keys contained within the Dictionary
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/					
+		public static function getKeys(d:Dictionary):Array
+		{
+			var a:Array = new Array();
+			
+			for (var key:Object in d)
+			{
+				a.push(key);
+			}
+			
+			return a;
+		}
+		
+		/**
+		*	Returns an Array of all values within the specified dictionary.		
+		* 
+		* 	@param d The Dictionary instance whose values will be returned.
+		* 
+		* 	@return Array of values contained within the Dictionary
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/					
+		public static function getValues(d:Dictionary):Array
+		{
+			var a:Array = new Array();
+			
+			for each (var value:Object in d)
+			{
+				a.push(value);
+			}
+			
+			return a;
+		}
+		
+	}
+}

data/src/com/adobe/utils/IntUtil.as

@@ -0,0 +1,99 @@
+/*
+  Copyright (c) 2008, Adobe Systems Incorporated
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without 
+  modification, are permitted provided that the following conditions are
+  met:
+
+  * Redistributions of source code must retain the above copyright notice, 
+    this list of conditions and the following disclaimer.
+  
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the 
+    documentation and/or other materials provided with the distribution.
+  
+  * Neither the name of Adobe Systems Incorporated nor the names of its 
+    contributors may be used to endorse or promote products derived from 
+    this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+package com.adobe.utils {
+	
+	import flash.utils.Endian;
+	
+	/**
+	 * Contains reusable methods for operations pertaining 
+	 * to int values.
+	 */
+	public class IntUtil {
+		
+		/**
+		 * Rotates x left n bits
+		 *
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 * @tiptext
+		 */
+		public static function rol ( x:int, n:int ):int {
+			return ( x << n ) | ( x >>> ( 32 - n ) );
+		}
+		
+		/**
+		 * Rotates x right n bits
+		 *
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 * @tiptext
+		 */
+		public static function ror ( x:int, n:int ):uint {
+			var nn:int = 32 - n;
+			return ( x << nn ) | ( x >>> ( 32 - nn ) );
+		}
+		
+		/** String for quick lookup of a hex character based on index */
+		private static var hexChars:String = "0123456789abcdef";
+		
+		/**
+		 * Outputs the hex value of a int, allowing the developer to specify
+		 * the endinaness in the process.  Hex output is lowercase.
+		 *
+		 * @param n The int value to output as hex
+		 * @param bigEndian Flag to output the int as big or little endian
+		 * @return A string of length 8 corresponding to the 
+		 *		hex representation of n ( minus the leading "0x" )
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 * @tiptext
+		 */
+		public static function toHex( n:int, bigEndian:Boolean = false ):String {
+			var s:String = "";
+			
+			if ( bigEndian ) {
+				for ( var i:int = 0; i < 4; i++ ) {
+					s += hexChars.charAt( ( n >> ( ( 3 - i ) * 8 + 4 ) ) & 0xF ) 
+						+ hexChars.charAt( ( n >> ( ( 3 - i ) * 8 ) ) & 0xF );
+				}
+			} else {
+				for ( var x:int = 0; x < 4; x++ ) {
+					s += hexChars.charAt( ( n >> ( x * 8 + 4 ) ) & 0xF )
+						+ hexChars.charAt( ( n >> ( x * 8 ) ) & 0xF );
+				}
+			}
+			
+			return s;
+		}
+	}
+		
+}

data/src/com/adobe/utils/NumberFormatter.as

@@ -0,0 +1,74 @@
+/*
+  Copyright (c) 2008, Adobe Systems Incorporated
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without 
+  modification, are permitted provided that the following conditions are
+  met:
+
+  * Redistributions of source code must retain the above copyright notice, 
+    this list of conditions and the following disclaimer.
+  
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the 
+    documentation and/or other materials provided with the distribution.
+  
+  * Neither the name of Adobe Systems Incorporated nor the names of its 
+    contributors may be used to endorse or promote products derived from 
+    this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+package com.adobe.utils
+{
+
+	/**
+	* 	Class that contains static utility methods for formatting Numbers
+	* 
+	* 	@langversion ActionScript 3.0
+	*	@playerversion Flash 9.0
+	*	@tiptext
+	*
+	*	@see #mx.formatters.NumberFormatter
+	*/		
+	public class NumberFormatter
+	{
+	
+		/**
+		*	Formats a number to include a leading zero if it is a single digit
+		*	between -1 and 10. 	
+		* 
+		* 	@param n The number that will be formatted
+		*
+		*	@return A string with single digits between -1 and 10 padded with a 
+		*	leading zero.
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/		
+		public static function addLeadingZero(n:Number):String
+		{
+			var out:String = String(n);
+			
+			if(n < 10 && n > -1)
+			{
+				out = "0" + out;
+			}
+			
+			return out;
+		}	
+	
+	}
+}

data/src/com/adobe/utils/StringUtil.as

@@ -0,0 +1,239 @@
+/*
+  Copyright (c) 2008, Adobe Systems Incorporated
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without 
+  modification, are permitted provided that the following conditions are
+  met:
+
+  * Redistributions of source code must retain the above copyright notice, 
+    this list of conditions and the following disclaimer.
+  
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the 
+    documentation and/or other materials provided with the distribution.
+  
+  * Neither the name of Adobe Systems Incorporated nor the names of its 
+    contributors may be used to endorse or promote products derived from 
+    this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+package com.adobe.utils
+{
+	
+	/**
+	* 	Class that contains static utility methods for manipulating Strings.
+	* 
+	* 	@langversion ActionScript 3.0
+	*	@playerversion Flash 9.0
+	*	@tiptext
+	*/		
+	public class StringUtil
+	{
+
+		
+		/**
+		*	Does a case insensitive compare or two strings and returns true if
+		*	they are equal.
+		* 
+		*	@param s1 The first string to compare.
+		*
+		*	@param s2 The second string to compare.
+		*
+		*	@returns A boolean value indicating whether the strings' values are 
+		*	equal in a case sensitive compare.	
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/			
+		public static function stringsAreEqual(s1:String, s2:String, 
+											caseSensitive:Boolean):Boolean
+		{
+			if(caseSensitive)
+			{
+				return (s1 == s2);
+			}
+			else
+			{
+				return (s1.toUpperCase() == s2.toUpperCase());
+			}
+		}
+		
+		/**
+		*	Removes whitespace from the front and the end of the specified
+		*	string.
+		* 
+		*	@param input The String whose beginning and ending whitespace will
+		*	will be removed.
+		*
+		*	@returns A String with whitespace removed from the begining and end	
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/			
+		public static function trim(input:String):String
+		{
+			return StringUtil.ltrim(StringUtil.rtrim(input));
+		}
+
+		/**
+		*	Removes whitespace from the front of the specified string.
+		* 
+		*	@param input The String whose beginning whitespace will will be removed.
+		*
+		*	@returns A String with whitespace removed from the begining	
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/	
+		public static function ltrim(input:String):String
+		{
+			var size:Number = input.length;
+			for(var i:Number = 0; i < size; i++)
+			{
+				if(input.charCodeAt(i) > 32)
+				{
+					return input.substring(i);
+				}
+			}
+			return "";
+		}
+
+		/**
+		*	Removes whitespace from the end of the specified string.
+		* 
+		*	@param input The String whose ending whitespace will will be removed.
+		*
+		*	@returns A String with whitespace removed from the end	
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/	
+		public static function rtrim(input:String):String
+		{
+			var size:Number = input.length;
+			for(var i:Number = size; i > 0; i--)
+			{
+				if(input.charCodeAt(i - 1) > 32)
+				{
+					return input.substring(0, i);
+				}
+			}
+
+			return "";
+		}
+
+		/**
+		*	Determines whether the specified string begins with the spcified prefix.
+		* 
+		*	@param input The string that the prefix will be checked against.
+		*
+		*	@param prefix The prefix that will be tested against the string.
+		*
+		*	@returns True if the string starts with the prefix, false if it does not.
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/	
+		public static function beginsWith(input:String, prefix:String):Boolean
+		{			
+			return (prefix == input.substring(0, prefix.length));
+		}	
+
+		/**
+		*	Determines whether the specified string ends with the spcified suffix.
+		* 
+		*	@param input The string that the suffic will be checked against.
+		*
+		*	@param prefix The suffic that will be tested against the string.
+		*
+		*	@returns True if the string ends with the suffix, false if it does not.
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/	
+		public static function endsWith(input:String, suffix:String):Boolean
+		{
+			return (suffix == input.substring(input.length - suffix.length));
+		}	
+
+		/**
+		*	Removes all instances of the remove string in the input string.
+		* 
+		*	@param input The string that will be checked for instances of remove
+		*	string
+		*
+		*	@param remove The string that will be removed from the input string.
+		*
+		*	@returns A String with the remove string removed.
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/	
+		public static function remove(input:String, remove:String):String
+		{
+			return StringUtil.replace(input, remove, "");
+		}
+		
+		/**
+		*	Replaces all instances of the replace string in the input string
+		*	with the replaceWith string.
+		* 
+		*	@param input The string that instances of replace string will be 
+		*	replaces with removeWith string.
+		*
+		*	@param replace The string that will be replaced by instances of 
+		*	the replaceWith string.
+		*
+		*	@param replaceWith The string that will replace instances of replace
+		*	string.
+		*
+		*	@returns A new String with the replace string replaced with the 
+		*	replaceWith string.
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/
+		public static function replace(input:String, replace:String, replaceWith:String):String
+		{
+			return input.split(replace).join(replaceWith);
+		}
+		
+		
+		/**
+		*	Specifies whether the specified string is either non-null, or contains
+		*  	characters (i.e. length is greater that 0)
+		* 
+		*	@param s The string which is being checked for a value
+		*
+		* 	@langversion ActionScript 3.0
+		*	@playerversion Flash 9.0
+		*	@tiptext
+		*/		
+		public static function stringHasValue(s:String):Boolean
+		{
+			//todo: this needs a unit test
+			return (s != null && s.length > 0);			
+		}
+	}
+}

data/src/com/adobe/utils/XMLUtil.as

@@ -0,0 +1,168 @@
+/*
+  Copyright (c) 2008, Adobe Systems Incorporated
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without 
+  modification, are permitted provided that the following conditions are
+  met:
+
+  * Redistributions of source code must retain the above copyright notice, 
+    this list of conditions and the following disclaimer.
+  
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the 
+    documentation and/or other materials provided with the distribution.
+  
+  * Neither the name of Adobe Systems Incorporated nor the names of its 
+    contributors may be used to endorse or promote products derived from 
+    this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
+  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+package com.adobe.utils
+{
+
+	public class XMLUtil
+	{
+		/**
+		 * Constant representing a text node type returned from XML.nodeKind.
+		 * 
+		 * @see XML.nodeKind()
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */
+		public static const TEXT:String = "text";
+		
+		/**
+		 * Constant representing a comment node type returned from XML.nodeKind.
+		 * 
+		 * @see XML.nodeKind()
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */		
+		public static const COMMENT:String = "comment";
+		
+		/**
+		 * Constant representing a processing instruction type returned from XML.nodeKind.
+		 * 
+		 * @see XML.nodeKind()
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */		
+		public static const PROCESSING_INSTRUCTION:String = "processing-instruction";
+		
+		/**
+		 * Constant representing an attribute type returned from XML.nodeKind.
+		 * 
+		 * @see XML.nodeKind()
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */		
+		public static const ATTRIBUTE:String = "attribute";
+		
+		/**
+		 * Constant representing a element type returned from XML.nodeKind.
+		 * 
+		 * @see XML.nodeKind()
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */		
+		public static const ELEMENT:String = "element";
+		
+		/**
+		 * Checks whether the specified string is valid and well formed XML.
+		 * 
+		 * @param data The string that is being checked to see if it is valid XML.
+		 * 
+		 * @return A Boolean value indicating whether the specified string is
+		 * valid XML.
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */
+		public static function isValidXML(data:String):Boolean
+		{
+			var xml:XML;
+			
+			try
+			{
+				xml = new XML(data);
+			}
+			catch(e:Error)
+			{
+				return false;
+			}
+			
+			if(xml.nodeKind() != XMLUtil.ELEMENT)
+			{
+				return false;
+			}
+			
+			return true;
+		}
+		
+		/**
+		 * Returns the next sibling of the specified node relative to the node's parent.
+		 * 
+		 * @param x The node whose next sibling will be returned.
+		 * 
+		 * @return The next sibling of the node. null if the node does not have 
+		 * a sibling after it, or if the node has no parent.
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */		
+		public static function getNextSibling(x:XML):XML
+		{	
+			return XMLUtil.getSiblingByIndex(x, 1);
+		}
+		
+		/**
+		 * Returns the sibling before the specified node relative to the node's parent.
+		 * 
+		 * @param x The node whose sibling before it will be returned.
+		 * 
+		 * @return The sibling before the node. null if the node does not have 
+		 * a sibling before it, or if the node has no parent.
+		 * 
+		 * @langversion ActionScript 3.0
+		 * @playerversion Flash 9.0
+		 */			
+		public static function getPreviousSibling(x:XML):XML
+		{	
+			return XMLUtil.getSiblingByIndex(x, -1);
+		}		
+		
+		protected static function getSiblingByIndex(x:XML, count:int):XML	
+		{
+			var out:XML;
+			
+			try
+			{
+				out = x.parent().children()[x.childIndex() + count];	
+			} 		
+			catch(e:Error)
+			{
+				return null;
+			}
+			
+			return out;			
+		}
+	}
+}