+Show TOC
×Hide TOC

IndexedList

Kind of class:	class
Inherits from:	none
Implements:	IIndexedCollection
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.data.collections.IndexedList
File last modified:	Wednesday, 31 October 2007, 07:35:29

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (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.mozilla.org/MPL/MPL-1.1.html
 * 
 * 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.
 */
 
 /**
 * @author Francis Bourre
 * @version 1.0
 */

import com.bourre.core.HashCodeFactory;
import com.bourre.data.collections.IIndexedCollection;
import com.bourre.log.PixlibStringifier;

class com.bourre.data.collections.IndexedList
    implements IIndexedCollection
{
    private var _o:Object;
    private var _n:Number;
    
    /**
     * List storing indexed objects<br><br>
     * <strong>Usage :</strong> <em>var a:IndexedList = new IndexedList();</em>
     */
    public function IndexedList()
    {
        init();
    }
    
    /**
     * Clear all list values.<br><br>
     * <strong>Usage :</strong> <em>var a.init();</em>
     */
    public function init() : Void
    {
        _o = new Object();
        _n = 0;
    }
    
    /**
     * Get index number of an object.<br><br>
     * <strong>Usage :</strong> <em>var n:Number = a.getIndex(o);</em>
     * @param o Object to check.
     * @return Number Returns -1 if the object isn't referenced in the list.
     */
    public function getIndex(o) : Number 
    {
        var n:Number = HashCodeFactory.getKey(o);
        return (_o[n] != undefined) ? n : -1;
    }
    
    /**
     * Test if one object is referenced in the list.<br><br>
     * <strong>Usage :</strong> <em>var b:Boolean = a.objectExists(o);</em>
     * @param o Object to check.
     * @return Boolean.
     */
    public function objectExists(o) : Boolean 
    {    
        return getIndex(o) != -1;
    }
    
    /**
     * Add object.<br><br>
     * <strong>Usage :</strong> <em>a.push(o);</em>
     * @param o Object to add.
     * @return Boolean that indicates if the object has been successfully added == wasn't already there.
     */
    public function push(o) : Boolean
    {
        if (!objectExists(o)) 
        {
            var n:Number = HashCodeFactory.getKey(o);
            if (n != undefined) 
            {
                _o[n] = o;
                _n++;
                return true;
            } else return false;
        } else return false;
    }

    /**
     * Remove object.<br><br>
     * <strong>Usage :</strong> <em>a.remove(o);</em>
     * @param o Object to remove.
     * @return Boolean that indicates if the object has been found and was removed.
     */
    public function remove(o) : Boolean 
    {
        if (objectExists(o)) 
        {
            delete _o[ HashCodeFactory.getKey(o) ];
            _n --;
            return true;
        } else return false;
    }
    
    /**
     * Check if Array's empty.<br><br>
     * <strong>Usage :</strong> <em>var b:Boolean = a.isEmpty();</em>
     * @return Boolean.
     */
    public function isEmpty() : Boolean
    {
        return _n < 1;
    }
    
    /**
     * Get array copy of the list content.<br><br>
     * @return Boolean.
     */
    public function getElements() : Array
    {
        var a:Array = new Array();
        for (var p:String in _o) a.push(_o[p]);
        return a;
    }
    
    /**
     * Returns the string representation of this instance.
     * @return the string representation of this instance
     */
    public function toString() : String 
    {
        return PixlibStringifier.stringify( this );
    }
}

Summary

Constructor

IndexedList

Instance methods

init
getIndex
objectExists
push
remove
isEmpty
getElements
toString

Constructor

IndexedList

function IndexedList (

)

List storing indexed objects

Usage : var a:IndexedList = new IndexedList();

Instance methods

getElements

function getElements (

) : Array

Get array copy of the list content.

Returns:

Boolean.

Specified by:

IIndexedCollection.getElements

getIndex

function getIndex (

) : Number

Get index number of an object.

Usage : var n:Number = a.getIndex(o);

Parameters:

Object to check.

Returns:

Number Returns -1 if the object isn't referenced in the list.

Specified by:

IIndexedCollection.getIndex

init

function init (

) : Void

Clear all list values.

Usage : var a.init();

Specified by:

IIndexedCollection.init

isEmpty

function isEmpty (

) : Boolean

Check if Array's empty.

Usage : var b:Boolean = a.isEmpty();

Returns:

Boolean.

Specified by:

IIndexedCollection.isEmpty

objectExists

function objectExists (

) : Boolean

Test if one object is referenced in the list.

Usage : var b:Boolean = a.objectExists(o);

Parameters:

Object to check.

Returns:

Boolean.

Specified by:

IIndexedCollection.objectExists

push

function push (

) : Boolean

Add object.

Usage : a.push(o);

Parameters:

Object to add.

Returns:

Boolean that indicates if the object has been successfully added == wasn't already there.

Specified by:

IIndexedCollection.push

remove

function remove (

) : Boolean

Remove object.

Usage : a.remove(o);

Parameters:

Object to remove.

Returns:

Boolean that indicates if the object has been found and was removed.

Specified by:

IIndexedCollection.remove

toString

function toString (

) : String

Returns the string representation of this instance.

Returns:

the string representation of this instance