Packagecom.yworks.bridge.util
Classpublic class AbstractCollection
InheritanceAbstractCollection Inheritance YObject Inheritance Object
Implements Collection
Subclasses AbstractList, AbstractSet

AbstractCollection is an abstract implementation of the Collection interface. This implementation does not support adding. A subclass must implement the abstract methods iterator() and size().


Public Properties
 PropertyDefined By
  empty : Boolean
[read-only] Returns true if the collection has no element, otherwise false.
AbstractCollection
  length : int
[read-only] Answers the number of elements in this Collection.
AbstractCollection
Public Methods
 MethodDefined By
  
AbstractCollection(init:Boolean = true)
Constructs a new instance of this AbstractCollection.
AbstractCollection
  
addAll(collection:Collection):Boolean
Adds the objects in the specified Collection to this Collection.
AbstractCollection
  
addItem(object:Object):Boolean
If the specified element is not contained within this collection, and addition of this element succeeds, then true will be returned.
AbstractCollection
  
clear():void
Removes all the elements in this collection.
AbstractCollection
  
clone():Object
AbstractCollection
  
containsAll(collection:Collection):Boolean
Searches this Collection for all objects in the specified Collection.
AbstractCollection
  
containsItem(object:Object):Boolean
Searches this Collection for the specified object.
AbstractCollection
 Inherited
equals(o:Object):Boolean
YObject
  
getClass():Class
[override]
AbstractCollection
 Inherited
hashCode():int
YObject
  
iterator():Iterator
Answers an Iterator on the elements of this Collection.
AbstractCollection
  
removeAll(collection:Collection):Boolean
Removes all occurrences in this Collection of each object in the specified Collection.
AbstractCollection
  
removeItem(object:Object):Boolean
Removes the first occurrence of the specified object from this Collection.
AbstractCollection
  
retainAll(collection:Collection):Boolean
Removes all objects from this Collection that are not contained in the specified Collection.
AbstractCollection
  
toArray():Vector.<Object>
Answers a new array containing all elements contained in this Collection.
AbstractCollection
  
toArray2(contents:Vector.<Object>):Vector.<Object>
Answers an array containing all elements contained in this Collection.
AbstractCollection
  
toString():String
Answers the string representation of this Collection.
AbstractCollection
Protected Methods
 MethodDefined By
  
cloneImpl(o:Object):void
AbstractCollection
  
initAbstractCollection():void
AbstractCollection
Property Detail
emptyproperty
empty:Boolean  [read-only]

Returns true if the collection has no element, otherwise false.


Implementation
    public function get empty():Boolean
lengthproperty 
length:int  [read-only]

Answers the number of elements in this Collection.


Implementation
    public function get length():int
Constructor Detail
AbstractCollection()Constructor
public function AbstractCollection(init:Boolean = true)

Constructs a new instance of this AbstractCollection.

Parameters
init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.
Method Detail
addAll()method
public function addAll(collection:Collection):Boolean

Adds the objects in the specified Collection to this Collection.

Parameters

collection:Collection — the Collection of objects

Returns
Boolean — true if this Collection is modified, false otherwise

Throws
flash.errors:IllegalOperationError — when adding to this Collection is not supported
 
ReferenceError — if null is used to invoke this method
addItem()method 
public function addItem(object:Object):Boolean

If the specified element is not contained within this collection, and addition of this element succeeds, then true will be returned. If the specified element is already contained within this collection, or duplication is not permitted, false will be returned. Different implementations may add specific limitations on this method to filter permitted elements. For example, in some implementation, null element may be denied, and NullPointerException will be thrown out. These limitations should be explicitly documented by specific collection implementation. Add operation is not supported in this implementation, and UnsupportedOperationException will always be thrown out.

Parameters

object:Object — the element to be added.

Returns
Boolean — true if the collection is changed successfully after invoking this method. Otherwise, false.

Throws
flash.errors:IllegalOperationError — if add operation is not supported by this class.
 
ReferenceError — if null is used to invoke this method, and null is not permitted by this collection.
 
TypeError — if the class type of the specified element is not compatible with the permitted class type.
 
IllegalArgumentException — if limitations of this collection prevent the specified element from being added
clear()method 
public function clear():void

Removes all the elements in this collection. This collection will be cleared up after this operation. The operation iterates over the collection, removes every element using Iterator.remove method. UnsupportedOperationException will be thrown out if the iterator returned by this collection does not implement the remove method and the collection is not zero length.


Throws
flash.errors:IllegalOperationError — if this operation is not implemented.
clone()method 
public function clone():Object

Returns
Object
cloneImpl()method 
protected function cloneImpl(o:Object):void

Parameters

o:Object

containsAll()method 
public function containsAll(collection:Collection):Boolean

Searches this Collection for all objects in the specified Collection.

Parameters

collection:Collection — the Collection of objects

Returns
Boolean — true if all objects in the specified Collection are elements of this Collection, false otherwise

Throws
ReferenceError — if null is used to invoke this method
containsItem()method 
public function containsItem(object:Object):Boolean

Searches this Collection for the specified object.

Parameters

object:Object — the object to search for

Returns
Boolean — true if object is an element of this Collection, false otherwise
getClass()method 
override public function getClass():Class

Returns
Class
initAbstractCollection()method 
protected final function initAbstractCollection():void

iterator()method 
public function iterator():Iterator

Answers an Iterator on the elements of this Collection. A subclass must implement the abstract methods iterator() and size().

Returns
Iterator — an Iterator on the elements of this Collection

See also

com.yworks.bridge.util.Iterator
removeAll()method 
public function removeAll(collection:Collection):Boolean

Removes all occurrences in this Collection of each object in the specified Collection. This operation traverses over the collection itself, to verify whether each element is contained in the specified collection. The object will be removed from the collection itself using the iterator's remove method if it is contained in the specified collection. This collection will throw an UnsupportedOperationException if the iterator returned does not implement remove method, and the element in the specified collection is contained in this collection.

Parameters

collection:Collection — the Collection of objects to remove

Returns
Boolean — true if this Collection is modified, false otherwise

Throws
flash.errors:IllegalOperationError — when removing from this Collection is not supported
 
ReferenceError — if null is used to invoke this method
removeItem()method 
public function removeItem(object:Object):Boolean

Removes the first occurrence of the specified object from this Collection. This operation traverses over the collection, looking for the specified object. Once the object is found, the object will be removed from the collection using the iterator's remove method. This collection will throw an UnsupportedOperationException if the iterator returned does not implement remove method, and the specified object is in this collection.

Parameters

object:Object — the object to remove

Returns
Boolean — true if this Collection is modified, false otherwise

Throws
flash.errors:IllegalOperationError — when removing from this Collection is not supported
retainAll()method 
public function retainAll(collection:Collection):Boolean

Removes all objects from this Collection that are not contained in the specified Collection. This operation traverses over the collection itself, to verify whether any element is contained in the specified collection. The object will be removed from the collection itself using the iterator's remove method if it is not contained in the specified collection. This collection will throw an UnsupportedOperationException if the iterator returned does not implement remove method, and the collection itself does contain elements which do not exist in the specified collection.

Parameters

collection:Collection — the Collection of objects to retain

Returns
Boolean — true if this Collection is modified, false otherwise

Throws
flash.errors:IllegalOperationError — when removing from this Collection is not supported
 
ReferenceError — if null is used to invoke this method
toArray()method 
public function toArray():Vector.<Object>

Answers a new array containing all elements contained in this Collection. All the elements in the array will not be referenced by the collection. The elements in the returned array will be sorted to the same order as those returned by the iterator of this collection itself if the collection guarantees the order.

Returns
Vector.<Object> — an array of the elements from this Collection
toArray2()method 
public function toArray2(contents:Vector.<Object>):Vector.<Object>

Answers an array containing all elements contained in this Collection. If the specified array is large enough to hold the elements, the specified array is used, otherwise an array of the same type is created. If the specified array is used and is larger than this Collection, the array element following the collection elements is set to null.

Parameters

contents:Vector.<Object> — the array

Returns
Vector.<Object> — an array of the elements from this Collection

Throws
Error — when the type of an element in this Collection cannot be stored in the type of the specified array
 
ReferenceError — if null is used to invoke this method
toString()method 
public function toString():String

Answers the string representation of this Collection. The presentation has a specific format. It is enclosed by square brackets ("[]"). Elements are separated by ', ' (comma and space).

Returns
String — the string representation of this Collection




Wed Oct 7 2015, 04:43 PM +02:00