Packagecom.bourre.service
Classpublic class ServiceLocator
InheritanceServiceLocator Inheritance AbstractLocator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The ServiceLocator class is a locator for remoting Service object.

See also

Service


Protected Properties
 PropertyDefined by
 Inherited_m : HashMap
Map storing String keys associated with Object values.
AbstractLocator
Public Methods
 MethodDefined by
  
Creates new ServiceLocator instance.
ServiceLocator
 Inherited
add(d:Dictionary):void
Adds all ressources contained in the passed-in dictionnary into this locator instance.
AbstractLocator
 Inherited
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
AbstractLocator
  
addListener(listener:Object):Boolean
Adds the passed-in listener as listener for all events dispatched by this event broadcaster.
ServiceLocator
 Inherited
callMethodOnAllValues(methodName:String, ... args):void
Takes all values of a Locator and call on each value the method name passed as 1st argument.
AbstractLocator
 Inherited
getKeys():Array
Returns an Array view of the keys contained in this locator.
AbstractLocator
 Inherited
Returns the exclusive logger object owned by this locator.
AbstractLocator
  
getService(key:String):Service
Returns Service registered with passed-in key identifier.
ServiceLocator
 Inherited
getType():Class
Return the class type of elements in this container.
AbstractLocator
 Inherited
getValues():Array
Returns an Array view of the values contained in this locator.
AbstractLocator
 Inherited
isRegistered(name:String):Boolean
Returns true is there is a ressource associated with the passed-in key.
AbstractLocator
 Inherited
isTyped():Boolean
Returns true if this container perform a verification of the type of elements.
AbstractLocator
  
locate(key:String):Object
Returns the ressource associated with the passed-in key.
ServiceLocator
 Inherited
matchType(o:*):Boolean
Verify that the passed-in object type match the current container element's type.
AbstractLocator
 Inherited
processOnAllValues(f:Function, ... args):void
Takes all values of a Locator and pass them one by one as arguments to a method of an object.
AbstractLocator
 Inherited
register(name:String, o:Object):Boolean
Registers passed-in object with identifier name to this locator.
AbstractLocator
  
registerService(name:String, o:Object):Boolean
Registers passed-in object with identifier name to this locator.
ServiceLocator
  
Registers passed-in object with identifier name to this locator.
ServiceLocator
 Inherited
release():void
Clears all association between keys and objects registered for this locator.
AbstractLocator
 Inherited
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
AbstractLocator
  
removeListener(listener:Object):Boolean
Removes the passed-in listener object from this event broadcaster.
ServiceLocator
 Inherited
toString():String
Returns the string representation of this instance.
AbstractLocator
 Inherited
unregister(name:String):Boolean
Unregisters object registered with identifier name.
AbstractLocator
Protected Methods
 MethodDefined by
 Inherited
broadcastEvent(e:Event):void
Broadcast the passed-in event object to listeners according to the event's type.
AbstractLocator
 Inherited
Returns event Broadcaster owned by this locator.
AbstractLocator
  
onRegister(key:String = null, service:Object = null):void
Dispatches ServiceLocatorEvent event using passed-in arguments as event properties when a service is registered in locator.
ServiceLocator
  
onUnregister(key:String = null):void
Dispatches ServiceLocatorEvent event using passed-in arguments as event properties when a Constructor is unregistered from locator.
ServiceLocator
Events
 EventSummaryDefined by
   Dispatched when a constructor is registered.ServiceLocator
   Dispatched when a constructor is unregistered.ServiceLocator
Constructor detail
ServiceLocator()constructor
public function ServiceLocator()

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates new ServiceLocator instance.

Method detail
addListener()method
public function addListener(listener:Object):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:Object — the listener object to add as global listener

Returns
Booleantrue if the listener have been added during this call
getService()method 
public function getService(key:String):Service

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns Service registered with passed-in key identifier.

Parameters
key:String

Returns
Service
locate()method 
public override function locate(key:String):Object

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the ressource associated with the passed-in key. If there is no ressource identified by the passed-in key, the function will fail with an error. To avoid the throw of an exception when attempting to access to a ressource, take care to check the existence of the ressource before trying to access to it.

Parameters
key:String — identifier of the ressource to access

Returns
Object — the ressource associated with the passed-in key
onRegister()method 
protected override function onRegister(key:String = null, service:Object = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatches ServiceLocatorEvent event using passed-in arguments as event properties when a service is registered in locator.

Event type is ServiceLocatorEvent.onRegisterServiceEVENT

Parameters
key:String (default = null) — Name of the registered service
 
service:Object (default = null) — The registered service ( Service class or instance )

See also

onUnregister()method 
protected override function onUnregister(key:String = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatches ServiceLocatorEvent event using passed-in arguments as event properties when a Constructor is unregistered from locator.

Event type is ServiceLocatorEvent.onUnregisterServiceEVENT

Parameters
key:String (default = null) — Name of the registredred service

See also

registerService()method 
public function registerService(name:String, o:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Registers passed-in object with identifier name to this locator.

Parameters
name:String — Key identifier
 
o:Object — Object to store

Returns
Booleantrue if success
registerServiceClass()method 
public function registerServiceClass(name:String, o:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Registers passed-in object with identifier name to this locator.

Parameters
name:String — Key identifier
 
o:Object — Object to store

Returns
Booleantrue if success
removeListener()method 
public function removeListener(listener:Object):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:Object — the listener object to remove from this event broadcaster object

Returns
Booleantrue if the object have been successfully removed from this event broadcaster
Event detail
onRegisterServiceevent 
Event object type: com.bourre.ioc.assembler.constructor.ServiceLocatorEvent
ServiceLocatorEvent.type property = com.bourre.service.ServiceLocatorEvent.onRegisterServiceEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a constructor is registered.

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

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getServiceLocator() The locator
getService() The the service
onUnregisterServiceevent  
Event object type: com.bourre.ioc.assembler.constructor.ServiceLocatorEvent
ServiceLocatorEvent.type property = com.bourre.service.ServiceLocatorEvent.onUnregisterServiceEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a constructor is unregistered.

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

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getServiceLocator() The locator
getService() The the service