Packageorg.spicefactory.parsley.core.messaging.impl
Classpublic class DefaultMessageSettings
InheritanceDefaultMessageSettings Inheritance Object
Implements MessageSettings

Default implementation of the MessageSettings interface.


Public Properties
 PropertyDefined By
  commandFactories : CommandFactoryRegistry
[read-only] The registry for command factories.
DefaultMessageSettings
  defaultReceiverScope : String
The default scope to use for message receivers and observers.
DefaultMessageSettings
  unhandledError : ErrorPolicy
The policy to apply for unhandled errors.
DefaultMessageSettings
Public Methods
 MethodDefined By
  
addCommandFactory(type:Class, factory:CommandFactory):void
Adds a factory that creates Command instances for all command methods that have the specified return type.
DefaultMessageSettings
  
addErrorHandler(target:MessageErrorHandler):void
Adds an error handler that will be applied to all routers created with these settings.
DefaultMessageSettings
  
addParent(parent:MessageSettings):void
Adds a parent for looking up values not set in this instance.
DefaultMessageSettings
  
getErrorHandlers(status:LookupStatus = null):Array
Returns all error handlers that were registered for these settings.
DefaultMessageSettings
Property Detail
commandFactoriesproperty
commandFactories:CommandFactoryRegistry  [read-only]

The registry for command factories.


Implementation
    public function get commandFactories():CommandFactoryRegistry
defaultReceiverScopeproperty 
defaultReceiverScope:String

The default scope to use for message receivers and observers. If not specified the global scope will be used. In a modular application it is not uncommon that most message receivers are only interested in local messages. Switching the default allows to avoid specifying the local scope explicitly on all metadata tags.


Implementation
    public function get defaultReceiverScope():String
    public function set defaultReceiverScope(value:String):void
unhandledErrorproperty 
unhandledError:ErrorPolicy

The policy to apply for unhandled errors. An unhandled error is an error thrown by a message handler where no matching error handler was registered for.


Implementation
    public function get unhandledError():ErrorPolicy
    public function set unhandledError(value:ErrorPolicy):void
Method Detail
addCommandFactory()method
public function addCommandFactory(type:Class, factory:CommandFactory):void

Adds a factory that creates Command instances for all command methods that have the specified return type.

Parameters

type:Class — the return type of the command methods the specified factory is responsible for
 
factory:CommandFactory — the factory to add

addErrorHandler()method 
public function addErrorHandler(target:MessageErrorHandler):void

Adds an error handler that will be applied to all routers created with these settings.

Parameters

target:MessageErrorHandler — the error handler to add

addParent()method 
public function addParent(parent:MessageSettings):void

Adds a parent for looking up values not set in this instance.

Parameters

parent:MessageSettings — parent settings instance

getErrorHandlers()method 
public function getErrorHandlers(status:LookupStatus = null):Array

Returns all error handlers that were registered for these settings. This Array is read-only, modifications do not have any effect on the registered error handlers. Use addErrorHandler to register a new handler.

Parameters

status:LookupStatus (default = null) — optional paramater to avoid duplicate lookups, for internal use only

Returns
Array — all view error handlers added to these settings




Sat Apr 2 2011, 11:49 PM +01:00