ucar.unidata.idv.collab

Class CollabMsgType

java.lang.Object

ucar.unidata.idv.collab.CollabMsgType

public class CollabMsgType
extends java.lang.Object

Used by the CollabManager to define the different messages that may be sent

Version:

$Revision: 1.8 $Date: 2005/05/13 18:30:36 $

Author:

IDV development team

Method Summary

Modifier and Type	Method and Description
static CollabMsgType	createNoRelay(java.lang.String id, java.lang.String desc) Factory method to create a CollabMsgType that should not be relayed.
static CollabMsgType	createRelay(java.lang.String id, java.lang.String desc) Factory method to create a CollabMsgType that should be relayed.
boolean	equals(java.lang.Object other) Overwrite the equals
static CollabMsgType	find(java.lang.String typeId) Find the MsgType identified by the given type typeId.
boolean	getBlocked() Get the Blocked property.
boolean	getShouldRelay() Get the ShouldRelay property.
boolean	idEquals(java.lang.String otherId) Does this object's identifier equals the given id
void	setBlocked(boolean value) Set the Blocked property.
void	setShouldRelay(boolean value) Set the ShouldRelay property.
java.lang.String	toString() String representation of this type

Methods inherited from class java.lang.Object

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

Method Detail

createRelay

public static CollabMsgType createRelay(java.lang.String id,
                                        java.lang.String desc)

Factory method to create a CollabMsgType that should be relayed.

Parameters:

id - Id of the message type

desc - Its description

Returns:

The newly create message type

createNoRelay

public static CollabMsgType createNoRelay(java.lang.String id,
                                          java.lang.String desc)

Factory method to create a CollabMsgType that should not be relayed.

Parameters:

id - Id of the message type

desc - Its description

Returns:

The newly create message type

find

public static CollabMsgType find(java.lang.String typeId)

Find the MsgType identified by the given type typeId.

Parameters:

typeId - The

Returns:

The message type object or null

equals

public boolean equals(java.lang.Object other)

Overwrite the equals

Overrides:

equals in class java.lang.Object

Parameters:

other - Object to compare to

Returns:

Is equals to other

idEquals

public boolean idEquals(java.lang.String otherId)

Does this object's identifier equals the given id

Parameters:

otherId - Id to check equality on

Returns:

Is id equals

toString

public java.lang.String toString()

String representation of this type

Overrides:

toString in class java.lang.Object

Returns:

The toString of this object

setBlocked

public void setBlocked(boolean value)

Set the Blocked property. This temporarily halts the processing of messages of this type.

Parameters:

value - The new value for Blocked

getBlocked

public boolean getBlocked()

Get the Blocked property.

Returns:

The Blocked

setShouldRelay

public void setShouldRelay(boolean value)

Set the ShouldRelay property. Should messages of this type be relayed.

Parameters:

value - The new value for ShouldRelay

getShouldRelay

public boolean getShouldRelay()

Get the ShouldRelay property.

Returns:

The ShouldRelay