| Package | org.spicefactory.parsley.messaging.tag |
| Class | public class MessageHandlerDecorator |
| Inheritance | MessageHandlerDecorator  MessageReceiverDecoratorBase Object |
| Implements | ObjectDefinitionDecorator |
| Subclasses | MessageHandlerDecoratorTag |
| Property | Defined By | ||
|---|---|---|---|
| messageProperties : Array
Optional list of names of properties of the message that should be used as method parameters
instead passing the message itself as a parameter. | MessageHandlerDecorator | ||
| method : String
The name of the method that wishes to handle the message. | MessageHandlerDecorator | ||
 | order : int = 2.147483647E9
The execution order for this receiver. | MessageReceiverDecoratorBase | |
| scope : String
The name of the scope this tag should be applied to. | MessageReceiverDecoratorBase | |
| selector : *
An optional selector value to be used in addition to selecting messages by type. | MessageReceiverDecoratorBase | |
| type : Class
The type of the messages the receiver wants to handle. | MessageReceiverDecoratorBase | |
| Method | Defined By | ||
|---|---|---|---|
decorate(builder:ObjectDefinitionBuilder):void
Method to be invoked by the container for each configuration tag it encounters for an object
that was added to the container. | MessageHandlerDecorator | ||
| messageProperties | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var messageProperties:ArrayOptional list of names of properties of the message that should be used as method parameters instead passing the message itself as a parameter.
| method | property |
public var method:StringThe name of the method that wishes to handle the message.
| decorate | () | method |
public function decorate(builder:ObjectDefinitionBuilder):voidMethod to be invoked by the container for each configuration tag it encounters for an object that was added to the container. It doesn't matter whether it is a builtin configuration tag or a custom extension tag, or whether it is a metadata tag, an MXML or XML tag. As long as the tag is mapped to a class that implements this interface the container will invoke it for each tag on each object.
The builder parameter getting passed to the decorator can be used to customize the ObjectDefinition that is currently getting processed. In most custom tag implementations you will peform tasks like specifying constructor arguments, property values, message receivers, custom lifecycle processors or instantiators.
A decorator is also allowed to register additional definitions through using builder.newBuilder.
Those additional definitions might describe collaborators that the processed definition will need
to operate for example. If you want to register collaborators that are globally accessible (or within a certain scope)
you may consider adding them to the ScopeExtensionRegistry in the GlobalFactoryRegistry instead.
Parameters
builder:ObjectDefinitionBuilder — the builder that can be used to modify the target definition
|