com.ibm.ras
Class RASObject

java.lang.Object
  |
  +--com.ibm.ras.RASObject
Direct Known Subclasses:
RASFormatter, RASGroup, RASHandler, RASLogger

public class RASObject
extends java.lang.Object

RASObject defines the methods which are common to the RASLogger, RASHandler and RASFormatter classes. It should not be necessary to create an instance of this class directly.

The elements common to loggers and handlers include:

See Also:
RASLogger, RASHandler, RASFormatter

Constructor Summary
RASObject()
          Creates a RASObject.
RASObject(java.lang.String name)
          Creates a RASObject.
RASObject(java.lang.String name, java.lang.String desc)
          Creates a RASObject.
 
Method Summary
 java.util.Hashtable getConfig()
          Gets the configuration of this object.
 java.lang.String getDescription()
          Gets the description of this object.
 java.lang.String getName()
          Gets the name by which this object is known.
 void setConfig(java.util.Hashtable ht)
          Sets the configuration of this object.
 void setDescription(java.lang.String desc)
          Sets the description of this object.
 void setName(java.lang.String name)
          Sets the name by which this object is known.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RASObject

public RASObject()
Creates a RASObject. The name and description of this object are empty strings.

RASObject

public RASObject(java.lang.String name)
Creates a RASObject. The description of this object is an empty string.
Parameters:
name - The name of this object.

RASObject

public RASObject(java.lang.String name,
                 java.lang.String desc)
Creates a RASObject.
Parameters:
name - The name of this object.
desc - The description of this object.
Method Detail

getConfig

public java.util.Hashtable getConfig()
Gets the configuration of this object.
Returns:
A Hashtable containing the configuration. This object inserts the following key/value pairs into the configuration:
         "name"        The name of the object.
         "description" The description of the object.
         
All values are Strings. Extensions to this object may add additional keys.

setConfig

public void setConfig(java.util.Hashtable ht)
Sets the configuration of this object. This method is used by a RASManager to initialize a RAS object. It should not be necessary for an application to use this method.
Parameters:
ht - A Hashtable containing the configuration. This object searches for the following keys:
            "name"        The name of the object.
            "description" The description of the object.
            
All values are Strings. If a key is not found, that configuration element is not updated. Extensions to this object may use additional keys.

getName

public java.lang.String getName()
Gets the name by which this object is known.
Returns:
The name of this object, or an empty string ("") if the name has not been set.

setName

public void setName(java.lang.String name)
Sets the name by which this object is known. If the name is null, the current name is not changed.
Parameters:
name - The name of this object.

getDescription

public java.lang.String getDescription()
Gets the description of this object.
Returns:
The description of this object, or an empty string ("") if the description has not been set.

setDescription

public void setDescription(java.lang.String desc)
Sets the description of this object. If the description is null, the current description is not changed.
Parameters:
desc - The description of this object.