com.ibm.ras
Interface RASIFormatter

All Superinterfaces:

RASIObject, java.io.Serializable

public interface RASIFormatter

extends RASIObject

RASIFormatter defines the methods that must be implemented to format RAS events.

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.
boolean	isDefault() Determines if this is a "default formatter," created by a RASHandler to format the RAS events generated by this toolkit.
void	removeEventClass(java.lang.String name) Removes the name of a RASIEvent class from the list of classes which this formatter can process.
void	setDefault(boolean flag) Sets a flag that indicates whether this object is a "default formatter," attached automatically by a RASHandler.

Methods inherited from interface com.ibm.ras.RASIObject

getConfig, getDescription, getGroup, getName, setConfig, setDescription, setName

Method Detail

setDefault

public void setDefault(boolean flag)

Sets a flag that indicates whether this object is a "default formatter," attached automatically by a RASHandler.

Note: The RASHandler creates default message and trace formatters when it is created. It will set this flag true to prevent the RASManager from deleting these formatters.

Parameters:

flag - true when this is a default formatter and false otherwise.

isDefault

public boolean isDefault()

Determines if this is a "default formatter," created by a RASHandler to format the RAS events generated by this toolkit.

Returns:

true if this is a default formatter and false otherwise.

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.