com.ibm.ras
Class RASObject

java.lang.Object
  |
  +--com.ibm.ras.RASObject

All Implemented Interfaces:

java.lang.Cloneable, RASConstants, RASIObject, java.io.Serializable

Direct Known Subclasses:

RASMaskChangeGenerator

public class RASObject

extends java.lang.Object

implements java.lang.Cloneable, RASConstants, RASIObject

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:

• The name of the object
• A description of the object

See Also:

Serialized Form

Fields inherited from interface com.ibm.ras.RASConstants

KEY_CLASS_NAME, KEY_CLIENT, KEY_COMPONENT, KEY_DATE_FORMAT, KEY_DEFAULT_HANDLERS, KEY_DEFAULT_MESSAGE_HANDLERS, KEY_DEFAULT_TRACE_HANDLERS, KEY_DESCRIPTION, KEY_ENCODING, KEY_EXCEPTION, KEY_EXCEPTION_TRACE, KEY_FILE_NAME, KEY_FORMATTER_NAMES, KEY_GROUP, KEY_HANDLER_NAMES, KEY_HEX_DATA, KEY_IS_CIRCULAR, KEY_IS_LOGGING, KEY_IS_SYNC, KEY_LOGGER, KEY_LOGGING_CLASS, KEY_LOGGING_METHOD, KEY_MAX_FILE_SIZE, KEY_MAX_FILES, KEY_MAX_QUEUE_SIZE, KEY_MESSAGE_EVENT_CLASSES, KEY_MESSAGE_FILE, KEY_MESSAGE_MASK, KEY_NAME, KEY_ORGANIZATION, KEY_PRODUCT, KEY_RETRY_INTERVAL, KEY_SEPARATOR, KEY_SERVER, KEY_SOCKET_PORT, KEY_SOCKET_SERVER, KEY_SUPPRESSED_KEYS, KEY_THREAD_ID, KEY_TIME_FORMAT, KEY_TRACE_EVENT_CLASSES, KEY_TRACE_MASK, RAS_VERSION

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.lang.Object	clone() Creates a new RASObject.
java.util.Hashtable	getConfig() Gets the configuration of this object.
java.lang.String	getDescription() Gets the description of this object.
java.lang.String	getGroup() Gets the name of the RASManager group with which this object is associated.
java.lang.String	getName() Gets the name by which this object is known.
protected void	init() Initializes this object, setting default values.
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, finalize, 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

clone

public java.lang.Object clone()

Creates a new RASObject.

Overrides:

clone in class java.lang.Object

Returns:

A copy of the current object.

init

protected void init()

Initializes this object, setting default values.

getConfig

public java.util.Hashtable getConfig()

Gets the configuration of this object.

Specified by:

getConfig in interface RASIObject

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.

className

The name of the this class.

group

The RAS group of which this object is a member.

All values are Strings. Extensions to this object may add additional keys. The className and group keys are kept only to maintain the integrity of the configuration. They are used by the RAS Manager.

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.

Specified by:

setConfig in interface RASIObject

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.

className

The name of the this class.

group

The RAS group of which this object is a member.

All values are Strings. If a key is not found, an internal default for that element is set instead. Extensions to this object may use additional keys. The className and group keys are kept only to maintain the integrity of the configuration. They are used by the RAS Manager.

getName

public java.lang.String getName()

Gets the name by which this object is known.

Specified by:

getName in interface RASIObject

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.

Specified by:

setName in interface RASIObject

Parameters:

name - The name of this object.

getDescription

public java.lang.String getDescription()

Gets the description of this object.

Specified by:

getDescription in interface RASIObject

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.

Specified by:

setDescription in interface RASIObject

Parameters:

desc - The description of this object.

getGroup

public java.lang.String getGroup()

Gets the name of the RASManager group with which this object is associated. This method is only used by the RAS Manager.

Specified by:

getGroup in interface RASIObject

Returns:

The group name or an empty string if this object is not associated with a group.