Packageorg.pranaframework.ioc.factory.xml
Interfacepublic interface IXMLObjectFactory extends IConfigurableListableObjectFactory, IConfigurableObjectFactory, IObjectFactory, flash.events.IEventDispatcher, IListableObjectFactory, IObjectDefinitionRegistry
ImplementorsXMLObjectFactory

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



Public Properties
 PropertyDefined by
 InheritedallowObjectDefinitionOverriding : Boolean
Whether to allow re-registration of a different definition with the same name
IObjectDefinitionRegistry
  configLocations : Array
[read-only] Returns an array of configuration locations.
IXMLObjectFactory
 InheritednumObjectDefinitions : int
Returns the number of definitions present in the object definition registry
IListableObjectFactory
 InheritednumObjectPostProcessors : int
Returns the number of object post processors.
IConfigurableObjectFactory
 InheritedobjectDefinitionNames : Array
Returns an array containing all object definition names.
IListableObjectFactory
 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
 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
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
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 all object definitions names that implement the given type.
IListableObjectFactory
 Inherited
getObjectsOfType(type:Class):Dictionary
Returns all object definitions that implement 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, obectDefinition:IObjectDefinition):void
Will register the given objectDefinition with 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
Property detail
configLocationsproperty
configLocations:Array  [read-only]

Returns an array of configuration locations.

Implementation
    public function get configLocations():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
load()method 
public function load():void

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