Package 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, java.lang.Comparable<MonitorId>

public final class MonitorId
extends EField
implements java.lang.Comparable<MonitorId>, 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 an eBus object instance PersistentStatusMessage and TransientStatusMessage notifications.

Author:

Charles Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MonitorId.Builder	Builder class used to create an MonitorId field.

Field Summary

Fields

Modifier and Type	Field	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.

Method Summary

Modifier and Type	Method	Description
static MonitorId.Builder	builder()	Returns a new instance of a MonitorId message field builder.
int	compareTo(MonitorId mId)
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.

Method Detail

compareTo

public int compareTo(MonitorId mId)

Specified by:

compareTo in interface java.lang.Comparable<MonitorId>

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 eBus object instance PersistentStatusMessage and TransientStatusMessage notifications.

Overrides:

toString in class java.lang.Object

Returns:

the textual representation of this monitor identifier.

builder

public static MonitorId.Builder builder()

Returns a new instance of a MonitorId message field builder.

Returns:

message field builder instance.