Packageorg.springextensions.actionscript.ioc
SVN browsingObjectDefinition.as
FisheyeObjectDefinition.as
Classpublic class ObjectDefinition
ImplementsIObjectDefinition, org.as3commons.lang.IEquals

Describes an object that can be created by an ObjectFactory.



Documentation reference: the objects


Public Properties
 PropertyDefined by
  autoWireMode : AutowireMode
Defines the way an object will be autowired (configured).
ObjectDefinition
  className : String
The classname of the object that the current IObjectDefinition describes.
ObjectDefinition
  constructorArguments : Array
An array of arguments that will be passed to the constructor of the object.
ObjectDefinition
  dependencyCheck : DependencyCheckMode
Determines if and how the object properties dependencies should be checked.
ObjectDefinition
  dependsOn : Array
Returns the object names that this object depends on.
ObjectDefinition
  destroyMethod : String
ObjectDefinition
  factoryMethod : String
The name of method responsible for the creation of the object.
ObjectDefinition
  factoryObjectName : String
The name of the factory object responsible for the creation of the object.
ObjectDefinition
  initMethod : String
The name of a method on the class defined by the className property that will be called immediately after the object has been configured.
ObjectDefinition
  isAutoWireCandidate : Boolean
True if this object can be used as a value used by the container when it autowires an object by type.
ObjectDefinition
  isLazyInit : Boolean
True if the object does not need to be eagerly pre-instantiated by the container.
ObjectDefinition
  isSingleton : Boolean
True if only one instance of this object needs to be created by the container, i.e.
ObjectDefinition
  methodInvocations : Array
Defines the method invocations executed after an object from this definition is created.
ObjectDefinition
  primary : Boolean
True if this object needs to be used as the primary autowire candidate when the container is autowiring by type.
ObjectDefinition
  properties : Object
An anonymous object whose property values will be injected into the created object, the property names on this object are the same as on the created object.
ObjectDefinition
  scope : ObjectDefinitionScope
Defines the scope of the object, the object is either a singleton, a prototype or a stage object.
ObjectDefinition
  skipMetadata : Boolean
Determines whether the autowire processor will examine the class metadata.
ObjectDefinition
  skipPostProcessors : Boolean
Determines whether the object factory will send the created object through its list of IObjectProcessors.
ObjectDefinition
Public Methods
 MethodDefined by
  
ObjectDefinition(className:String = null)
Creates a new ObjectDefinition instance.
ObjectDefinition
  
equals(object:Object):Boolean
ObjectDefinition
  
toString():String
ObjectDefinition
Protected Methods
 MethodDefined by
  
initObjectDefinition(className:String):void
ObjectDefinition
Property detail
autoWireModeproperty
autoWireMode:AutowireMode  [read-write]

Defines the way an object will be autowired (configured).

The default value is AutowireMode.NO.

Implementation
    public function get autoWireMode():AutowireMode
    public function set autoWireMode(value:AutowireMode):void
classNameproperty 
className:String  [read-write]

The classname of the object that the current IObjectDefinition describes.

Implementation
    public function get className():String
    public function set className(value:String):void
constructorArgumentsproperty 
constructorArguments:Array  [read-write]

An array of arguments that will be passed to the constructor of the object.

Implementation
    public function get constructorArguments():Array
    public function set constructorArguments(value:Array):void
dependencyCheckproperty 
dependencyCheck:DependencyCheckMode  [read-write]

Determines if and how the object properties dependencies should be checked.

The default value is <code>ObjectDefinitionDependencyCheck.NONE</code>.

Implementation
    public function get dependencyCheck():DependencyCheckMode
    public function set dependencyCheck(value:DependencyCheckMode):void
dependsOnproperty 
dependsOn:Array  [read-write]

Returns the object names that this object depends on.

Implementation
    public function get dependsOn():Array
    public function set dependsOn(value:Array):void
destroyMethodproperty 
destroyMethod:String  [read-write]Implementation
    public function get destroyMethod():String
    public function set destroyMethod(value:String):void
factoryMethodproperty 
factoryMethod:String  [read-write]

The name of method responsible for the creation of the object. This is either a static method of class defined by the className property or the name of a method on the object defined by the factoryObjectName property.

Implementation
    public function get factoryMethod():String
    public function set factoryMethod(value:String):void
factoryObjectNameproperty 
factoryObjectName:String  [read-write]

The name of the factory object responsible for the creation of the object.

Implementation
    public function get factoryObjectName():String
    public function set factoryObjectName(value:String):void
initMethodproperty 
initMethod:String  [read-write]

The name of a method on the class defined by the className property that will be called immediately after the object has been configured.

Implementation
    public function get initMethod():String
    public function set initMethod(value:String):void
isAutoWireCandidateproperty 
isAutoWireCandidate:Boolean  [read-write]

True if this object can be used as a value used by the container when it autowires an object by type.

The default value is true.

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

True if the object does not need to be eagerly pre-instantiated by the container. I.e. the object will be created after the first call to the getObject() method.

The default value is false.

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

True if only one instance of this object needs to be created by the container, i.e. every subsequent call to the getObject() method will return the same instance.

The default value is true.

Implementation
    public function get isSingleton():Boolean
    public function set isSingleton(value:Boolean):void
methodInvocationsproperty 
methodInvocations:Array  [read-write]

Defines the method invocations executed after an object from this definition is created.

Implementation
    public function get methodInvocations():Array
    public function set methodInvocations(value:Array):void
primaryproperty 
primary:Boolean  [read-write]

True if this object needs to be used as the primary autowire candidate when the container is autowiring by type. This means that if multiple objects are found of the same type, the object marked as 'primary' will become the autowire candidate.

The default value is false.

Implementation
    public function get primary():Boolean
    public function set primary(value:Boolean):void
propertiesproperty 
properties:Object  [read-write]

An anonymous object whose property values will be injected into the created object, the property names on this object are the same as on the created object.

Implementation
    public function get properties():Object
    public function set properties(value:Object):void
scopeproperty 
scope:ObjectDefinitionScope  [read-write]

Defines the scope of the object, the object is either a singleton, a prototype or a stage object.

The default value is ObjectDefinitionScope.SINGLETON.

Implementation
    public function get scope():ObjectDefinitionScope
    public function set scope(value:ObjectDefinitionScope):void
skipMetadataproperty 
skipMetadata:Boolean  [read-write]

Determines whether the autowire processor will examine the class metadata.

The default value is false.

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

Determines whether the object factory will send the created object through its list of IObjectProcessors.

Implementation
    public function get skipPostProcessors():Boolean
    public function set skipPostProcessors(value:Boolean):void
Constructor detail
ObjectDefinition()constructor
public function ObjectDefinition(className:String = null)

Creates a new ObjectDefinition instance.

Parameters
className:String (default = null) — The fully qualified class name for the object that this definition describes
Method detail
equals()method
public function equals(object:Object):Boolean

Parameters
object:Object

Returns
Boolean
initObjectDefinition()method 
protected function initObjectDefinition(className:String):voidParameters
className:String
toString()method 
public function toString():String

Returns
String