org.springextensions.actionscript.context.support.AbstractApplicationContext

Package	org.springextensions.actionscript.context.support
SVN browsing	AbstractApplicationContext.as
Fisheye	AbstractApplicationContext.as
Class	public class AbstractApplicationContext
Inheritance	AbstractApplicationContext DefaultListableObjectFactory AbstractObjectFactory flash.events.EventDispatcher
Implements	IConfigurableApplicationContext
Subclasses	MXMLApplicationContext, XMLApplicationContext

The XMLApplicationContext is the object factory used in ActionScript projects, in Flex projects you want to use the FlexXMLApplicationContext class.

Important: the schemaLocation within the application context xml file (in the example http://www.springactionscript.org/schema/objects/spring-actionscript-objects-1.0.xsd) should contain the version of spring actionscript you are using.

Using the XMLApplicationContext

The following example retrieves an object from the application context

  public class MyApplication {
      private var _xmlApplicationContext:XMLApplicationContext;
      public function MyApplication() {
   _xmlApplicationContext = new XMLApplicationContext("applicationContext.xml");
   _xmlApplicationContext.addEventListener(Event.COMPLETE, _applicationContextCompleteHandler);
   _xmlApplicationContext.load();
    }
      private function _applicationContextCompleteHandler(e:Event):void {
   var someObject:SomeObject = _xmlApplicationContext.getObject("someObject");
    }
  }

The applicationContext.xml could look something like this:

A simple application context xml file

An applicationcontext.xml file with one object defined

  <?xml version="1.0" encoding="utf-8"?>
  <objects xmlns="http://www.springactionscript.org/objects"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.springactionscript.org/schema/objects/spring-actionscript-objects-1.0.xsd"
  >
    <object id="someObject" class="package.SomeClass" />
    </objects>

Object post processors

In order to manipulate instantiated objects before (or after) they are created you can use object post processors. Post processors can be defined like this:

  <object class="org.springextensions.actionscript.factory.config.SpecialObjectPostProcessor" />

The XMLApplicationContext will automatically add them if they implement the IObjectPostProcessor interface.

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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		allowObjectDefinitionOverriding : Boolean Set whether it should be allowed to override object definitions by registering a different definition with the same name, automatically replacing the former.	DefaultListableObjectFactory
		applicationDomain : ApplicationDomain	AbstractObjectFactory
		autowireProcessor : IAutowireProcessor	AbstractObjectFactory
		explicitSingletonNames : Array The names of the explicit singletons registered in this factory.	AbstractObjectFactory
		hasDestructionAwareObjectPostProcessors : Boolean	AbstractObjectFactory
		isDisposed : Boolean	AbstractObjectFactory
		numObjectDefinitions : uint The number of object definitions in this registry.	DefaultListableObjectFactory
		numObjectPostProcessors : int Returns the number of object post processors.	AbstractObjectFactory
		objectDefinitionNames : Array The names of the registered object definitions.	DefaultListableObjectFactory
		objectDefinitions : Object	AbstractObjectFactory
		objectFactoryPostProcessors : Array [read-only]	AbstractApplicationContext
		objectPostProcessors : Array	AbstractObjectFactory
		parent : IObjectFactory Optional parent factory that can be used to create objects that can't be created by the current instance.	AbstractObjectFactory
		parentContext : IApplicationContext [read-only] Returns the parent application context or `null` if no parent is set.	AbstractApplicationContext
		properties : Properties	AbstractObjectFactory
		typeConverter : ITypeConverter The current type converter implementation	AbstractObjectFactory
		useParentObjectFactoryPostProcessors : Boolean	AbstractApplicationContext

	Property	Defined by
		earlySingletonCache : Object Cache of early cached singletons for circular references	AbstractObjectFactory
		explicitSingletonCache : Object Cache of singleton objects registered without object definition	AbstractObjectFactory
		referenceResolvers : Array Reference resolvers used when creating objects	AbstractObjectFactory
		singletonCache : Object Cache of created singleton objects via an object definition	AbstractObjectFactory

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		AbstractApplicationContext(parent:IApplicationContext = null) Creates a new AbstractApplicationContext	AbstractApplicationContext
		addObjectFactoryPostProcessor(objectFactoryPostProcessor:IObjectFactoryPostProcessor, index:int = -1):void Adds an `IObjectFactoryPostProcessor` instance to the current `XMLApplicationContext`	AbstractApplicationContext
		addObjectPostProcessor(objectPostProcessor:IObjectPostProcessor):void If the specified `IObjectPostProcessor` implements `IApplicationDomainAware` the current `AbstractObjectFactory.applicationDomain` will be injected. Adds the specified `IObjectPostProcessor` to the current object factory.	AbstractObjectFactory
		addReferenceResolver(referenceResolver:IReferenceResolver):void This method adds a reference resolver that will be used to resolve property references.	AbstractObjectFactory
		canCreate(objectName:String):Boolean Determines if the object factory is able to create the object with the given name.	AbstractObjectFactory
		clearObjectFromExplicitInternalCache(name:String):Object	AbstractObjectFactory
		clearObjectFromInternalCache(name:String):Object Removes an object from the internal object definition cache.	AbstractObjectFactory
		containsObject(objectName:String):Boolean Determines if the object factory contains a definition with the given name.	AbstractObjectFactory
		containsObjectDefinition(objectName:String):Boolean Determines if an object definition with the given name exists	DefaultListableObjectFactory
		createInstance(clazz:Class, constructorArguments:Array = null):* Creates an instance of the specified `Class`, wires the instance and returns it.	AbstractObjectFactory
		dispose():void	AbstractApplicationContext
		getClassForInstance(object:Object):Class	AbstractObjectFactory
		getClassForName(className:String):Class	AbstractObjectFactory
		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.	AbstractObjectFactory
		getObjectDefinition(objectName:String):IObjectDefinition Returns the object definition registered with the given name.	DefaultListableObjectFactory
		getObjectDefinitionsOfType(type:Class):Array Returns the object definitions in this registry that are of the specified `Class`.	DefaultListableObjectFactory
		getObjectNamesForType(type:Class):Array Returns the names of all object definitions and explicit singletons in this factory that are of the given type.	DefaultListableObjectFactory
		getObjectPostProcessors(objectPostProcessorClass:Class):Array Retrieves the object processors of the specified `Class`.	AbstractObjectFactory
		getObjectsOfType(type:Class):Object Returns all object definitions and explicit singletons that are of the given type.	DefaultListableObjectFactory
		getType(objectName:String):Class Returns the type that is defined on the object definition.	AbstractObjectFactory
		getUsedTypes():Array Returns a unique list of all `Classes` that are used by the `IObjectDefinitions` in the current `IObjectDefinitionRegistry`.	DefaultListableObjectFactory
		isFactoryObject(objectName:String):Boolean Determines if an object is a IFactoryObject implementation.	AbstractObjectFactory
		isPrototype(objectName:String):Boolean Determines if the definition with the given name is a prototype.	AbstractObjectFactory
		isSingleton(objectName:String):Boolean Determines if the definition with the given name is a singleton.	AbstractObjectFactory
		load():void	AbstractApplicationContext
		preInstantiateSingletons():void Checks if the objectdefinition is an implementation of `IFactoryObject`, if so the factory will be pre-instantiated, not the result of the factory. Instantiates all definitions that are defined as singleton and are not lazy.	DefaultListableObjectFactory
		registerCustomEditor(requiredType:Class, propertyEditor:IPropertyEditor):void Registers a custom property editor.	AbstractObjectFactory
		registerObjectDefinition(objectName:String, objectDefinition:IObjectDefinition):void Registers the given objectDefinition under the given name.	DefaultListableObjectFactory
		registerSingleton(name:String, object:Object):void	AbstractApplicationContext
		removeObjectDefinition(objectName:String):void Removes the definition with the given name from the registry	DefaultListableObjectFactory
		removeObjectPostProcessor(objectPostProcessor:IObjectPostProcessor):void Removes the specified `IObjectPostProcessor` from the current object factory.	AbstractObjectFactory
		resolveReference(property:Object):Object Resolves a property in an object definition.	AbstractObjectFactory
		wire(object:*, objectDefinition:IObjectDefinition = null, objectName:String = null):void	AbstractObjectFactory

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		buildObject(name:String, constructorArguments:Array = null):* Builds an object for the given name and returns it.	AbstractObjectFactory
		clearFromCache(cache:Object, name:String):Object	AbstractObjectFactory
		createObjectViaInstanceFactoryMethod(objectName:String, methodName:String, args:Array = null):*	AbstractObjectFactory
		createObjectViaStaticFactoryMethod(clazz:Class, applicationDomain:ApplicationDomain, factoryMethodName:String, args:Array = null):*	AbstractObjectFactory
		doLoad():void Does the actual loading after the application context has been prepared.	AbstractApplicationContext
		init():void	AbstractObjectFactory
		invokeObjectFactoryPostProcessors():void Invokes all object factory post processors.	AbstractApplicationContext
		loadComplete():void	AbstractApplicationContext
		preInstantiateSingletonsWithObjectDefinition():void	DefaultListableObjectFactory
		prepareApplicationContext():void Hook method defined in XmlObjectFactory to add the `ApplicationContextAwareProcessor`.	AbstractApplicationContext
		registerObjectFactoryPostProcessors():void Looks for implementations of IObjectFactoryPostProcessor in the object definition of this context and add an instance of each one as a object factory post processor.	AbstractApplicationContext
		registerObjectPostProcessors():void Will search all object definitions for implementations of IObjectPostProcessor.	AbstractApplicationContext
		wireExplicitSingletons():void	DefaultListableObjectFactory

	Event	Summary	Defined by
		objectCreated	Dispatched after an object has been instantiated and wired by the current object factory	AbstractObjectFactory
		objectRetrieved	Dispatched right before an object is returned by the current object factory	AbstractObjectFactory

	Constant	Defined by
		OBJECT_FACTORY_PREFIX : String = "&" [static] Used to dereference an `IFactoryObject` instance and distinguish it from objects created by the `IFactoryObject`.	AbstractObjectFactory
		THIS : String = "this" [static]	AbstractObjectFactory

Property detail

objectFactoryPostProcessors

property

objectFactoryPostProcessors:Array [read-only]Implementation
public function get objectFactoryPostProcessors():Array

parentContext

property

parentContext:IApplicationContext [read-only]

Returns the parent application context or null if no parent is set.

Implementation
public function get parentContext():IApplicationContext

useParentObjectFactoryPostProcessors

property

useParentObjectFactoryPostProcessors:Boolean  [read-write]Implementation
    public function get useParentObjectFactoryPostProcessors():Boolean
    public function set useParentObjectFactoryPostProcessors(value:Boolean):void

Constructor detail

AbstractApplicationContext

()

constructor

public function AbstractApplicationContext(parent:IApplicationContext = null)

Creates a new AbstractApplicationContext

Parameters

parent:IApplicationContext (default = null)

Method detail

addObjectFactoryPostProcessor

()

method

public function addObjectFactoryPostProcessor(objectFactoryPostProcessor:IObjectFactoryPostProcessor, index:int = -1):void

Adds an IObjectFactoryPostProcessor instance to the current XMLApplicationContext

Parameters

	`objectFactoryPostProcessor:IObjectFactoryPostProcessor` — An `IObjectFactoryPostProcessor` instance which is allowed to read the configuration metadata and potentially change it before the container has actually instantiated any other objects.

	`index:int` (default = `-1`) — An optional index for the objectFactoryPostProcessor list that the specified `IObjectFactoryPostProcessor` will be inserted at

dispose

()

method

public override function dispose():void

doLoad

()

method

protected function doLoad():void

Does the actual loading after the application context has been prepared. Subclasses should override this method without calling super.doLoad(), since the default behavior will trigger the loadComplete() method immediately. Subclasses should not forget to call loadComplete() after the (asynchronous) loading is done.

invokeObjectFactoryPostProcessors

()

method

protected function invokeObjectFactoryPostProcessors():void

Invokes all object factory post processors.

load

()

method

public function load():void

loadComplete

()

method

protected function loadComplete():void

prepareApplicationContext

()

method

protected function prepareApplicationContext():void

Hook method defined in XmlObjectFactory to add the ApplicationContextAwareProcessor.

Spring Actionscript API documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class AbstractApplicationContext	Properties \| Methods \| Events \| Constants

	`name:String`

	`object:Object`