/*
 Copyright (c) 2006 - 2008  Eric J. Feminella  <eric@ericfeminella.com>
 All rights reserved.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.

 @internal
 */

package com.ericfeminella.collections
{
    import mx.collections.ArrayCollection;
    /**
     *
     * <code>Collection</code> is a convenience class which extends <code>ArrayCollection</code>
     * in order to provide access to an <code>Iterator</code> of the collection.
     *
     * @example A basic example is as follows:
     *
     * <listing version="3.0" >
     *
     * var collection:Collection = new Collection( [ "A", "B", "C"] );
     * var it:Iterator = collection.iterator;
     *
     * while ( it.hasNext() )
     * {
     *     trace( it.next(), it.position());
     * }
     *
     * //outputs:
     * //A
     * //B
     * //C
     *
     * </listing>
     *
     * @see com.ericfeminella.collections.Iterator
     *
     */
    public class Collection extends ArrayCollection implements Iterable
    {
        /**
         *
         * <code>Collection</code> constructor accepts an optional argument of
         * type <code>Array</code>
         *
         * @param underlying <code>Array</code> wrapped by the collection
         *
         */
        public function Collection(source:Array = null)
        {
            super( source );
        }

        /**
         *
         * Retrieves the <code>Iterator</code> object for the collection.
         *
         * @return <code>Iterator</code>
         *
         */
        public function get iterator() : Iterator
        {
            return new CollectionIterator( this );
        }

        /**
         *
         * Convenience factory method which creates an <code>ArrayList</code>
         * from an <code>Array</code>
         *
         * @param  <code>Array</code> from which an <code>ArrayList</code> is to be created
         * @return <code>ArrayList</code> referencing the underlying <code>Array</code>
         *
         */
        public static function createCollection(arrayCollection:ArrayCollection) : Collection
        {
            var collection:Collection = new Collection( arrayCollection.source );

            return collection;
        }
    }
}