net.sf.eBusx.monitor

Class MonitorId

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EField

net.sf.eBusx.monitor.MonitorId

All Implemented Interfaces:

java.io.Serializable

public final class MonitorId
extends EField
implements java.io.Serializable

A passive, immutable class for storing a monitored object's type name, instance name and its assigned unique, 4-byte integer identifier. The toString() return value serves as the subject for the Monitorable instance PersistentStatusMessage and TransientStatusMessage notifications.

Author:

Charles Rapp

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	id The object's assigned integer identifier.
java.lang.String	instanceName The monitored object's name.
java.lang.String	typeName The monitored object's type.

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Constructor Summary

Constructors

Constructor and Description
MonitorId(java.lang.String typeName, java.lang.String instanceName, int id) Creates a new MonitorId instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Returns true if o is a non-null MonitorId instance with the same integer identifier; otherwise, returns false.
int	hashCode() Returns the unique, 4-byte, signed monitor identifier.
java.lang.String	toString() Returns "<type name>.<instance name>".

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

typeName

public final java.lang.String typeName

The monitored object's type.

instanceName

public final java.lang.String instanceName

The monitored object's name. Should be unique within the type and process.

id

public final int id

The object's assigned integer identifier.

Constructor Detail

MonitorId

public MonitorId(java.lang.String typeName,
                 java.lang.String instanceName,
                 int id)

Creates a new MonitorId instance.

Parameters:

typeName - the object type name.

instanceName - the object name. Should be unique within the process for the given type name.

id - the assigned unique identifier. Unique within the process.

Method Detail

equals

public boolean equals(java.lang.Object o)

Returns true if o is a non-null MonitorId instance with the same integer identifier; otherwise, returns false.

Overrides:

equals in class java.lang.Object

Parameters:

o - comparison object.

Returns:

true if o equals this MonitorId instance and false otherwise.

hashCode

public int hashCode()

Returns the unique, 4-byte, signed monitor identifier.

Overrides:

hashCode in class java.lang.Object

Returns:

the unique, 4-byte, signed monitor identifier.

toString

public java.lang.String toString()

Returns "<type name>.<instance name>". This return values is the subject for a registered Monitorable instance PersistentStatusMessage and TransientStatusMessage notifications.

Overrides:

toString in class java.lang.Object

Returns:

the textual representation of this monitor identifier.