Packagecom.bourre.ioc.bean
Classpublic class BeanFactory
ImplementsLocator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Bean factory manager.



Public Methods
 MethodDefined by
  
add(d:Dictionary):void
Adds all ressources contained in the passed-in dictionnary into this locator instance.
BeanFactory
  
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
BeanFactory
  
addListener(listener:BeanFactoryListener):Boolean
Adds the passed-in listener as listener for all events dispatched by this event broadcaster.
BeanFactory
  
clear():void
Clears factory
BeanFactory
  
[static] Returns unique factory instance.
BeanFactory
  
getKey(bean:Object):String
Returns registered key for passes-in bean object.
BeanFactory
  
getKeys():Array
Returns all registered keys on an Array.
BeanFactory
  
getValues():Array
Returns all registered values on an Array.
BeanFactory
  
isBeanRegistered(bean:Object):Boolean
Returns true if passed-in bean is registered in factory.
BeanFactory
  
isRegistered(key:String):Boolean
Returns true if passed-in key is registered in factory.
BeanFactory
  
locate(key:String):Object
Searchs and returns value registered with passed-in key.
BeanFactory
  
register(key:String, bean:Object):Boolean
Registers new key / bean pair into factory.
BeanFactory
  
release():void
[static] Releases factory.
BeanFactory
  
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
BeanFactory
  
Removes the passed-in listener object from this event broadcaster.
BeanFactory
  
toString():String
Returns string representation.
BeanFactory
  
unregister(key:String):Boolean
Unregisters key from factory.
BeanFactory
  
unregisterBean(bean:Object):Boolean
Unregisters bean from factory.
BeanFactory
Events
 EventSummaryDefined by
   Dispatched when a bean is registered.BeanFactory
   Dispatched when a bean is unregistered.BeanFactory
Method detail
add()method
public function add(d:Dictionary):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds all ressources contained in the passed-in dictionnary into this locator instance. If there is keys used both in the locator and in the dictionnary an exception is thrown.

Parameters
d:Dictionary — dictionnary instance which contains ressources to be added
addEventListener()method 
public function addEventListener(type:String, listener:Object, ... rest):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds an event listener for the specified event type. There is two behaviors for the addEventListener function :

  1. The passed-in listener is an object : The object is added as listener only for the specified event, the object must have a function with the same name than type or at least a handleEvent function.
  2. The passed-in listener is a function : A Delegate object is created and then added as listener for the event type. There is no restriction on the name of the function. If the rest is not empty, all elements in it is used as additional arguments into the delegate object.

Parameters
type:String — name of the event for which register the listener
 
listener:Object — object or function which will receive this event
 
... rest — additional arguments for the function listener

Returns
Booleantrue if the function have been succesfully added as listener fot the passed-in event

Throws
UnsupportedOperationException — If the listener is an object which have neither a function with the same name than the event type nor a function called handleEvent
addListener()method 
public function addListener(listener:BeanFactoryListener):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds the passed-in listener as listener for all events dispatched by this event broadcaster. The function returns true if the listener have been added at the end of the call. If the listener is already registered in this event broadcaster the function returns false.

Note : The addListener function doesn't accept functions as listener, functions could only register for a single event.

Parameters
listener:BeanFactoryListener — the listener object to add as global listener

Returns
Booleantrue if the listener have been added during this call

Throws
IllegalArgumentException — If the passed-in listener listener doesn't match the listener type supported by this event broadcaster
 
IllegalArgumentException — If the passed-in listener is a function
clear()method 
public function clear():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Clears factory

getInstance()method 
public static function getInstance():BeanFactory

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns unique factory instance.

Returns
BeanFactory
getKey()method 
public function getKey(bean:Object):String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns registered key for passes-in bean object.

Parameters
bean:Object — Bean object to search

Returns
String
getKeys()method 
public function getKeys():Array

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns all registered keys on an Array.

Returns
Array
getValues()method 
public function getValues():Array

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns all registered values on an Array.

Returns
Array
isBeanRegistered()method 
public function isBeanRegistered(bean:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if passed-in bean is registered in factory.

Parameters
bean:Object

Returns
Boolean
isRegistered()method 
public function isRegistered(key:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if passed-in key is registered in factory.

Parameters
key:String

Returns
Boolean
locate()method 
public function locate(key:String):Object

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Searchs and returns value registered with passed-in key.

Parameters
key:String — Registered key to search

Returns
Object

Throws
NoSuchElementException — key is not registered in factory
register()method 
public function register(key:String, bean:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Registers new key / bean pair into factory.

Parameters
key:String — Key to register
 
bean:Object — Value to record

Returns
Boolean

Throws
IllegalArgumentException — key or bean are already registered in factory
release()method 
public static function release():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Releases factory.

Factory is not cleared.

removeEventListener()method 
public function removeEventListener(type:String, listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener for listening the specified event. The listener could be either an object or a function.

Parameters
type:String — name of the event for which unregister the listener
 
listener:Object — object or function to be unregistered

Returns
Booleantrue if the listener have been successfully removed as listener for the passed-in event
removeListener()method 
public function removeListener(listener:BeanFactoryListener):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener object from this event broadcaster. The object is removed as listener for all events the broadcaster may dispatch.

Parameters
listener:BeanFactoryListener — the listener object to remove from this event broadcaster object

Returns
Booleantrue if the object have been successfully removed from this event broadcaster

Throws
IllegalArgumentException — If the passed-in listener is a function
toString()method 
public function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns string representation.

Returns
String
unregister()method 
public function unregister(key:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Unregisters key from factory.

Parameters
key:String — Key to unregister

Returns
Boolean
unregisterBean()method 
public function unregisterBean(bean:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Unregisters bean from factory.

Key is unregistered too.

Parameters
bean:Object — Value to unregister

Returns
Boolean
Event detail
onRegisterBeanevent 
Event object type: com.bourre.ioc.bean.BeanEvent
BeanEvent.type property = com.bourre.ioc.bean.BeanEvent.onRegisterBeanEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a bean is registered.

Defines the value of the type property of the event object for a onRegisterBean event.

onUnregisterBeanevent  
Event object type: com.bourre.ioc.bean.BeanEvent
BeanEvent.type property = com.bourre.ioc.bean.BeanEvent.onUnregisterBeanEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a bean is unregistered.

Defines the value of the type property of the event object for a onUnregisterBean event.