com.ibm.ras
Interface RASIFormatter
- All Known Implementing Classes:
- RASFormatter
- public abstract interface RASIFormatter
- extends RASIObject
RASIFormatter
defines the methods that must be implemented
to format RAS events. Within the RAS Toolkit, RASIFormatter
is implemented by the RASFormatter
class.
- See Also:
RASFormatter
Method Summary |
void |
addEventClass(java.lang.String name)
Adds the name of a RASIEvent class which this formatter
can process. |
java.lang.String |
format(RASIEvent event)
Formats the RAS event. |
java.util.Enumeration |
getEventClasses()
Gets the set of RASIEvent classes which this formatter
can process. |
void |
removeEventClass(java.lang.String name)
Removes the name of a RASIEvent class from the list of
classes which this formatter can process. |
addEventClass
public void addEventClass(java.lang.String name)
- Adds the name of a
RASIEvent
class which this formatter
can process. If the event class is null
or is already
registered, this method does nothing.
- Parameters:
name
- The event class name.
removeEventClass
public void removeEventClass(java.lang.String name)
- Removes the name of a
RASIEvent
class from the list of
classes which this formatter can process. If the event class is
null
or is not registered, this method does nothing.
- Parameters:
name
- The event class name.
getEventClasses
public java.util.Enumeration getEventClasses()
- Gets the set of
RASIEvent
classes which this formatter
can process.
- Returns:
- An
Enumeration
of RAS event class names. If
no event classes are registered, the Enumeration
is empty.
format
public java.lang.String format(RASIEvent event)
- Formats the RAS event.
- Parameters:
event
- The event to format.- Returns:
- The formatted event.