Packagerobotlegs.bender.extensions.sarsIntegration.api
Classpublic class StarlingCollection
InheritanceStarlingCollection Inheritance Object

The StarlingCollection class represents collection of Starling instances which will be used in SARS extension.

This class will adds support to have multiple instances of Starling available in Robotlegs application. All Starling instances when added to collection must have defined name which will actually be used as named injection of Starling view.



Public Properties
 PropertyDefined By
  items : Dictionary
[read-only] Get Starling instances in collection.
StarlingCollection
  length : uint
[read-only] Number of items in collection.
StarlingCollection
Public Methods
 MethodDefined By
  
addItem(starling:Starling, name:String):uint
Add Starling instance to collection.
StarlingCollection
  
getItem(name:String):Starling
Get Starling instance by name.
StarlingCollection
  
removeItem(name:String):Starling
Remove Starling item from collection by its name.
StarlingCollection
Property Detail
itemsproperty
items:Dictionary  [read-only]

Get Starling instances in collection.


Implementation
    public function get items():Dictionary
lengthproperty 
length:uint  [read-only]

Number of items in collection.


Implementation
    public function get length():uint
Method Detail
addItem()method
public function addItem(starling:Starling, name:String):uint

Add Starling instance to collection.

Instance will be added to dictionary with key as name provided. When using this collection with SARS, Starling views will be mapped to injector and differentiated by named injection. Name will be exact same as one provieded when adding instance to this collection.

Parameters

starling:Starling — Starling instace to add to collection.
 
name:String — Name by which Starling instance will be remembered.

Returns
uint — Return number of instances in collection.
getItem()method 
public function getItem(name:String):Starling

Get Starling instance by name.

Parameters

name:String — Name provided when Starling instance was added to collection.

Returns
Starling — Returns Starling instance it it was found, or null otherwise.
removeItem()method 
public function removeItem(name:String):Starling

Remove Starling item from collection by its name.

Parameters

name:String — Name by which Starling instance was added to collection.

Returns
Starling — Returns Starling instance which was removed if it is found, or if not found by that name, returns null.