Packageorg.springextensions.actionscript.ioc.factory.xml
SVN browsingIXMLObjectFactory.as
FisheyeIXMLObjectFactory.as
Interfacepublic interface IXMLObjectFactory extends IConfigurableListableObjectFactory, IConfigurableObjectFactory, IObjectFactory, IDependencyInjector, flash.events.IEventDispatcher, IListableObjectFactory, IObjectDefinitionRegistry

Interface to be implemented by object factories that load their object definitions from XML files.

Authors: Christophe Herreman, Erik Westra
Version: $Revision: 21 $, $Date: 2008-11-01 22:58:42 +0100 (za, 01 nov 2008) $, $Author: dmurat $
Since: 0.1



Documentation reference: instantiating a container


Public Properties
 PropertyDefined by
 InheritedapplicationDomain : ApplicationDomain
IObjectFactory
  configLocations : Array
[read-only] Returns an Array of configuration locations.
IXMLObjectFactory
 InheritedexplicitSingletonNames : Array
Returns the names of the explicit singleton objects registered in the factory.
IObjectFactory
  loadedProperties : Array
[read-only] Return an Array of Properties instances.
IXMLObjectFactory
 InheritednumObjectDefinitions : uint
The number of object definitions in this registry.
IObjectDefinitionRegistry
 InheritednumObjectPostProcessors : int
Returns the number of object post processors.
IConfigurableObjectFactory
 InheritedobjectDefinitionNames : Array
The names of the registered object definitions.
IObjectDefinitionRegistry
 InheritedobjectDefinitions : Object
Optional parent factory that can be used to create objects that can't be created by the current instance.
IObjectFactory
 Inheritedproperties : Properties
IObjectFactory
 InheritedtypeConverter : ITypeConverter
The current type converter implementation
IConfigurableObjectFactory
Public Methods
 MethodDefined by
  
addConfig(config:XML):void
Use this method to add xml versions of configurations
IXMLObjectFactory
  
addConfigLocation(configLocation:String):void
Use this method to add aditional configuration locations.
IXMLObjectFactory
  
addEmbeddedConfig(config:Class):void
Adds an embedded config.
IXMLObjectFactory
 Inherited
addObjectPostProcessor(objectPostProcessor:IObjectPostProcessor):void
Adds an object postprocessor to this object factory.
IConfigurableObjectFactory
 Inherited
addReferenceResolver(referenceResolver:IReferenceResolver):void
This method adds a reference resolver that will be used to resolve property references.
IObjectFactory
 Inherited
canCreate(objectName:String):Boolean
Determines if the object factory is able to create the object with the given name.
IObjectFactory
 Inherited
clearObjectFromInternalCache(name:String):Object
Removes an object from the internal object definition cache.
IObjectFactory
 Inherited
containsObject(objectName:String):Boolean
Determines if the object factory contains a definition with the given name.
IObjectFactory
 Inherited
containsObjectDefinition(objectName:String):Boolean
Determines if an object definition with the given name exists
IObjectDefinitionRegistry
 Inherited
createInstance(clazz:Class, constructorArguments:Array = null):*
Creates an instance of the specified Class, wires the instance and returns it.
IObjectFactory
 Inherited
getClassForInstance(object:Object):Class
IObjectFactory
 Inherited
getClassForName(className:String):Class
IObjectFactory
 Inherited
getObject(name:String, constructorArguments:Array = null):*
Will retrieve an object by it's name/id If the definition is a singleton it will be retrieved from cache if possible.
IObjectFactory
 Inherited
Returns the object definition registered with the given name.
IObjectDefinitionRegistry
 Inherited
getObjectNamesForType(type:Class):Array
Returns the names of all object definitions and explicit singletons in this factory that are of the given type.
IListableObjectFactory
 Inherited
getObjectsOfType(type:Class):Object
Returns all object definitions and explicit singletons that are of the given type.
IListableObjectFactory
 Inherited
getType(objectName:String):Class
Returns the type that is defined on the object definition.
IObjectFactory
 Inherited
isFactoryObject(objectName:String):Boolean
Determines if an object is a IFactoryObject implementation.
IConfigurableObjectFactory
 Inherited
isPrototype(objectName:String):Boolean
Determines if the definition with the given name is a prototype.
IObjectFactory
 Inherited
isSingleton(objectName:String):Boolean
Determines if the definition with the given name is a singleton.
IObjectFactory
  
load():void
Instructs the object factory to start loading the available configuration(s)
IXMLObjectFactory
 Inherited
Instantiates all definitions that are defined as singleton and are not lazy.
IConfigurableListableObjectFactory
 Inherited
registerCustomEditor(requiredType:Class, propertyEditor:IPropertyEditor):void
Registers a custom property editor.
IConfigurableObjectFactory
 Inherited
registerObjectDefinition(objectName:String, objectDefinition:IObjectDefinition):void
Registers the given objectDefinition under the given name.
IObjectDefinitionRegistry
 Inherited
removeObjectDefinition(objectName:String):void
Removes the definition with the given name from the registry
IObjectDefinitionRegistry
 Inherited
resolveReference(property:Object):Object
Resolves a property in an object definition.
IObjectFactory
 Inherited
wire(object:*, objectDefinition:IObjectDefinition, objectName:String = null):void
IDependencyInjector
Property detail
configLocationsproperty
configLocations:Array  [read-only]

Returns an Array of configuration locations.

Implementation
    public function get configLocations():Array
loadedPropertiesproperty 
loadedProperties:Array  [read-only]

Return an Array of Properties instances.

Implementation
    public function get loadedProperties():Array
Method detail
addConfig()method
public function addConfig(config:XML):void

Use this method to add xml versions of configurations

Parameters
config:XML — The xml configuration to add
addConfigLocation()method 
public function addConfigLocation(configLocation:String):void

Use this method to add aditional configuration locations.

Parameters
configLocation:String — The location to add. This is the path to the configuration xml file
addEmbeddedConfig()method 
public function addEmbeddedConfig(config:Class):void

Adds an embedded config.

Parameters
config:Class
load()method 
public function load():void

Instructs the object factory to start loading the available configuration(s)