|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A handler is the pluggable piece of a command that handles execution. Each command can have zero or more handlers associated with it (in general), of which only one will be active at any given moment in time. When the command is asked to execute, it will simply pass that request on to its active handler, if any.
This interface is not intended to be extended by clients.
IHandler
Method Summary | |
---|---|
void |
addHandlerListener(IHandlerListener handlerListener)
Deprecated. Registers an instance of IHandlerListener to listen for
changes to properties of this instance. |
void |
dispose()
Deprecated. Disposes of this handler. |
Object |
execute(Map parameterValuesByName)
Deprecated. Executes with the map of parameter values by name. |
Map |
getAttributeValuesByName()
Deprecated. Returns the map of attribute values by name. |
void |
removeHandlerListener(IHandlerListener handlerListener)
Deprecated. Unregisters an instance of IPropertyListener listening for
changes to properties of this instance. |
Method Detail |
public void addHandlerListener(IHandlerListener handlerListener)
IHandlerListener
to listen for
changes to properties of this instance.
handlerListener
- the instance to register. Must not be null
. If
an attempt is made to register an instance which is already
registered with this instance, no operation is performed.public void dispose()
public Object execute(Map parameterValuesByName) throws ExecutionException
parameterValuesByName
- the map of parameter values by name. Reserved for future use,
must be null
.
null
.
ExecutionException
- if an exception occurred during execution.public Map getAttributeValuesByName()
Notification is sent to all registered listeners if this property changes.
null
. If this map is not
empty, its collection of keys is guaranteed to only contain
instances of String
.public void removeHandlerListener(IHandlerListener handlerListener)
IPropertyListener
listening for
changes to properties of this instance.
handlerListener
- the instance to unregister. Must not be null
.
If an attempt is made to unregister an instance which is not
already registered with this instance, no operation is
performed.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.