com.ibm.ras
Interface RASIFormatter
-
- All Superinterfaces:
- RASIObject, java.io.Serializable
Deprecated.As of WAS 6.0, recommend using java.util.logging
public interface RASIFormatter extends RASIObject
RASIFormatter
defines the methods that must be implemented to format RAS events.
-
-
Method Summary
Methods Modifier and Type Method and Description void
addEventClass(java.lang.String name)
Deprecated.Adds the name of aRASIEvent
class which this formatter can process.java.lang.String
format(RASIEvent event)
Deprecated.Formats the RAS event.java.util.Enumeration
getEventClasses()
Deprecated.Gets the set ofRASIEvent
classes which this formatter can process.boolean
isDefault()
Deprecated.Determines if this is a "default formatter," created by aRASHandler
to format the RAS events generated by this toolkit.void
removeEventClass(java.lang.String name)
Deprecated.Removes the name of aRASIEvent
class from the list of classes which this formatter can process.void
setDefault(boolean flag)
Deprecated.Sets a flag that indicates whether this object is a "default formatter," attached automatically by aRASHandler
.-
Methods inherited from interface com.ibm.ras.RASIObject
getConfig, getDescription, getGroup, getName, setConfig, setDescription, setName
-
-
-
-
Method Detail
-
setDefault
void setDefault(boolean flag)
Deprecated.Sets a flag that indicates whether this object is a "default formatter," attached automatically by aRASHandler
.Note: The
RASHandler
creates default message and trace formatters when it is created. It will set this flag true to prevent theRASManager
from deleting these formatters.- Parameters:
flag
-true
when this is a default formatter andfalse
otherwise.
-
isDefault
boolean isDefault()
Deprecated.Determines if this is a "default formatter," created by aRASHandler
to format the RAS events generated by this toolkit.- Returns:
true
if this is a default formatter andfalse
otherwise.
-
addEventClass
void addEventClass(java.lang.String name)
Deprecated.Adds the name of aRASIEvent
class which this formatter can process. If the event class isnull
or is already registered, this method does nothing.- Parameters:
name
- The event class name.
-
removeEventClass
void removeEventClass(java.lang.String name)
Deprecated.Removes the name of aRASIEvent
class from the list of classes which this formatter can process. If the event class isnull
or is not registered, this method does nothing.- Parameters:
name
- The event class name.
-
getEventClasses
java.util.Enumeration getEventClasses()
Deprecated.Gets the set ofRASIEvent
classes which this formatter can process.- Returns:
- An
Enumeration
of RAS event class names. If no event classes are registered, theEnumeration
is empty.
-
format
java.lang.String format(RASIEvent event)
Deprecated.Formats the RAS event.- Parameters:
event
- The event to format.- Returns:
- The formatted event.
-
-