| Package | org.as3collections.queues |
| Class | public class IndexQueue |
| Inheritance | IndexQueue  SortedQueue LinearQueue AbstractQueue AbstractArrayCollection Object |
org.as3coreaddendum.system.comparators.IndexComparator object to sort the elements.
All elements must implement the org.as3coreaddendum.system.IIndexable interface, otherwise a org.as3coreaddendum.errors.ClassCastError is thrown.
This queue also adds an event listener on elements to org.as3coreaddendum.events.IndexEvent (if elements implement flash.events.IEventDispatcher).
Thus this queue keeps itself automatically sorted if its elements dispatch a org.as3coreaddendum.events.IndexEvent when its index changes.
See also
| Property | Defined By | ||
|---|---|---|---|
 | allEquatable : Boolean [read-only]
Indicates whether all elements in this collection implement the interface org.as3coreaddendum.system.IEquatable. | AbstractArrayCollection | |
| comparator : IComparator [override]
IndexQueue does not allow changing its comparator object. | IndexQueue | ||
| options : uint [override]
IndexQueue does not allow changing its options. | IndexQueue | ||
| Method | Defined By | ||
|---|---|---|---|
IndexQueue(source:Array = null)
Constructor, creates a new IndexQueue object. | IndexQueue | ||
add(element:*):Boolean [override]
Inserts the specified element into this queue if it is possible to do so immediately without violating restrictions. | IndexQueue | ||
| addAll(collection:ICollection):Boolean
Adds all of the elements in the specified collection to this collection (optional operation). | AbstractArrayCollection | |
| clear():void [override]
Removes all of the elements from this queue. | LinearQueue | |
clone():* [override]
Creates and return a new IndexQueue object containing all elements in this queue (in the same order). | IndexQueue | ||
| contains(o:*):Boolean
Returns true if this collection contains the specified object. | AbstractArrayCollection | |
| containsAll(collection:ICollection):Boolean
Returns true if this collection contains all of the elements in the specified collection. | AbstractArrayCollection | |
| dequeue():*
Retrieves and removes the head of this queue. | AbstractQueue | |
| element():*
Retrieves, but does not remove, the head of this queue. | AbstractQueue | |
| equals(other:*):Boolean [override]
Performs an arbitrary, specific evaluation of equality between this object and the other object. | SortedQueue | |
| isEmpty():Boolean
Returns true if this collection contains no elements. | AbstractArrayCollection | |
| [override]
Returns an iterator over a set of elements. | LinearQueue | |
offer(element:*):Boolean [override]
Inserts the specified element into this queue if it is possible to do so immediately without violating restrictions. | IndexQueue | ||
| peek():* [override]
Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty. | LinearQueue | |
| poll():* [override]
Retrieves and removes the head of this queue, or returns null if this queue is empty. | SortedQueue | |
| remove(o:*):Boolean [override]
Removes a single instance (only one occurrence) of the specified object from this queue, if it is present. | SortedQueue | |
| removeAll(collection:ICollection):Boolean [override]
Removes all of this queue's elements that are also contained in the specified collection. | SortedQueue | |
| retainAll(collection:ICollection):Boolean
Retains only the elements in this collection that are contained in the specified collection (optional operation). | AbstractArrayCollection | |
| size():int
Returns the number of elements in this collection. | AbstractArrayCollection | |
| sort(compare:Function = null, options:uint = 0):Array
Sorts the objects within this class. | SortedQueue | |
| sortOn(fieldName:*, options:* = null):Array
Sorts the elements in an array according to one or more fields in the array. | SortedQueue | |
| toArray():Array
Returns an array containing all of the elements in this collection. | AbstractArrayCollection | |
| toString():String
Returns the string representation of this instance. | AbstractArrayCollection | |
| comparator | property |
Hide Inherited Public Properties
Show Inherited Public Propertiescomparator:IComparator[override]
IndexQueue does not allow changing its comparator object.
IndexQueue was designed to be used exclusively with its default comparator object.
If you want to change the comparator object using this setter, consider using SortedQueue class instead.
If this setter is used an IllegalOperationError is thrown.
public function get comparator():IComparator public function set comparator(value:IComparator):void| options | property |
options:uint[override]
IndexQueue does not allow changing its options.
IndexQueue was designed to be used exclusively with its default options.
If you want to change the options using this setter, consider using SortedQueue class instead.
If this setter is used an IllegalOperationError is thrown.
public function get options():uint public function set options(value:uint):void| IndexQueue | () | Constructor |
public function IndexQueue(source:Array = null)
Constructor, creates a new IndexQueue object.
source:Array (default = null) |
org.as3coreaddendum.errors:ClassCastError — if one or more elements in the source argument do not implement the org.as3coreaddendum.system.IIndexable interface.
|
| add | () | method |
override public function add(element:*):Boolean
Inserts the specified element into this queue if it is possible to do so immediately without violating restrictions.
This method differs from offer only in that it throws an error if the element cannot be inserted.
This implementation returns the result of offer unless the element cannot be inserted.
This implementation only allow elements that implements the org.as3coreaddendum.system.IIndexable interface.
A org.as3coreaddendum.errors.ClassCastError is thrown if the element does not implements this interface.
Parameters
element:* |
Boolean — true if this queue changed as a result of the call.
|
ArgumentError — if the specified element is null.
| |
org.as3coreaddendum.errors:ClassCastError — if the element does not implements the org.as3coreaddendum.system.IIndexable interface.
| |
flash.errors:IllegalOperationError — if the specified element cannot be inserted.
|
| clone | () | method |
override public function clone():*
Creates and return a new IndexQueue object containing all elements in this queue (in the same order).
* — a new IndexQueue object containing all elements in this queue (in the same order).
|
| offer | () | method |
override public function offer(element:*):Boolean
Inserts the specified element into this queue if it is possible to do so immediately without violating restrictions.
When using a restricted queue (like TypedQueue and UniqueQueue), this method is generally preferable to add, which can fail to insert an element only by throwing an error.
This implementation only allow elements that implements the org.as3coreaddendum.system.IIndexable interface.
If the element does not implements this interface the method returns false.
Before returning, the queue is reordered.
Parameters
element:* — the element to add.
|
Boolean — true if the element was added to this queue, else false.
|
package test
{
import org.as3coreaddendum.system.IIndexable;
public class TestIndex extends EventDispatcher implements IIndexable
{
private var _name:String;
private var _index:int;
public function get index(): int { return _index; }
public function set index(value : int) : void
{
_index = value;
dispatchEvent(new IndexEvent(IndexEvent.CHANGED, _index));
}
public function TestIndex(name:String, index:int)
{
_name = name;
_index = index;
}
public function toString(): String
{
return "[TestIndex " + _name + "]";
}
}
}
import org.as3collections.ISortedQueue;
import org.as3collections.queues.IndexQueue;
import test.TestIndex;
var queue1:ISortedQueue = new IndexQueue();
var o0:TestIndex = new TestIndex("o0", 0);
var o1:TestIndex = new TestIndex("o1", 1);
var o2:TestIndex = new TestIndex("o2", 2);
var o3:TestIndex = new TestIndex("o3", 3);
queue1.offer(o1) // true
queue1 // [[TestIndex o1]]
queue1.size() // 1
queue1.offer(o2) // true
queue1 // [[TestIndex o1],[TestIndex o2]]
queue1.size() // 2
queue1.offer(o1) // true
queue1 // [[TestIndex o1],[TestIndex o1],[TestIndex o2]]
queue1.offer(o0) // true
queue1 // [[TestIndex o0],[TestIndex o1],[TestIndex o1],[TestIndex o2]]
queue1.offer(o3) // true
queue1 // [[TestIndex o0],[TestIndex o1],[TestIndex o1],[TestIndex o2],[TestIndex o3]]
queue1.offer(1) // false
queue1 // [[TestIndex o0],[TestIndex o1],[TestIndex o1],[TestIndex o2],[TestIndex o3]]
queue1.add(1) // ClassCastError: The element must implement the 'org.as3coreaddendum.system.IIndexable' interface. Type received: int