public abstract class AbstractStatusHandler extends Object
Status handlers are part of the status handling facility. The facility is responsible for handling errors and other important issues in Eclipse based applications. The handlers are responsible for presenting this errors by logging or showing error dialogs.
All status handlers extends
org.eclipse.ui.statushandlers.AbstractStatusHandler
. Each
handler implements handle(StatusAdapter status, int style)
.
This method handles statuses due to handling style. The style indicates how
status handler should handle a status.
For acceptable styles check StatusManager
.
Handlers shoudn't be used directly but through the StatusManager
. It
chooses which handler should be used for handling. There are two ways for
adding handlers to the handling flow. First using extension point
org.eclipse.ui.statusHandlers
, second by the workbench
advisor and its method WorkbenchAdvisor.getWorkbenchErrorHandler()
.
If a handler is associated with a product, it is used instead of this defined
in advisor.
A status handler has the id and a set of parameters. The handler can use them
during handling. If the handler is added as an extension, both are set during
initialization of the handler using elements and attributes of
statusHandler
element.
Constructor and Description |
---|
AbstractStatusHandler() |
Modifier and Type | Method and Description |
---|---|
String |
getId()
Returns the id of the handler.
|
Object |
getParam(Object key)
Returns the value of the handler's parameter identified by the given key,
or
null if this handler has no such parameter. |
Map |
getParams()
Returns all parameters of the handler.
|
abstract void |
handle(StatusAdapter statusAdapter,
int style)
Handles
StatusAdapter objects based on the set style. |
void |
setId(String id)
Sets the id for the handler.
|
void |
setParams(Map params)
Sets the parameters for the handler.
|
boolean |
supportsNotification(int type)
This methods indicates if particular notification type is supported and
if
StatusManager.fireNotification(int, StatusAdapter[]) will be
called after the event occurs. |
public abstract void handle(StatusAdapter statusAdapter, int style)
StatusAdapter
objects based on the set style.statusAdapter
- the status adapter. May not be null
.style
- style constant. Acceptable values are defined in
StatusManager
and can be combined with logical OR.StatusManager.BLOCK
,
StatusManager.NONE
,
StatusManager.SHOW
,
StatusManager.LOG
public Map getParams()
public Object getParam(Object key)
null
if this handler has no such parameter.key
- the name of the propertynull
if this
handler has no such parameterpublic void setParams(Map params)
org.eclipse.ui.statushandlers extension
, the parameters are set
during initialization of the handler using parameter
elements from statusHandler
element.params
- the parameters to setpublic String getId()
public void setId(String id)
id
attribute of statusHandler
element.id
- the id to setpublic boolean supportsNotification(int type)
StatusManager.fireNotification(int, StatusAdapter[])
will be
called after the event occurs. Only known notification types should be
accepted, whereas unknown types should be always rejected.type
- - a notification type that should be checked.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.