com.metamatrix.api.core.message
Class DefaultMessage

java.lang.Object
  com.metamatrix.api.core.message.DefaultMessage

All Implemented Interfaces:

Message, MessageTypes

public class DefaultMessage
extends java.lang.Object
implements Message, MessageTypes

The default implementation of Message. The presence of each of the three properties (text, type, or target) is optional. A few pre-defined message types have been defined for which messages can be created using one of several static create methods. In addition, a "null" message may be created that does not allow for any associated text or target. Attempts to set either the text or a target on a null message will throw an IllegalStateException.

Warnings:

• Since this class's hash code is dependent upon modifiable properties, instances of this class should not be modified when stored within a hashing collection.
• Instances of this class are not thread-safe.

  Since:

  3.0

  Field Summary

  Fields inherited from interface com.metamatrix.api.core.message.MessageTypes

  ERROR_MESSAGE, NOTIFICATION_MESSAGE, NULL_MESSAGE, WARNING_MESSAGE

  Constructor Summary

  DefaultMessage()
  Creates a new null message (with no text or target).

  DefaultMessage(Message message)
  Creates a new message using the properties of the specified message.

  DefaultMessage(java.lang.String text)
  Creates a new notification message containing the specified text and no target.

  DefaultMessage(java.lang.String text, int type)
  Creates a new message of the specified type containing the specified text and no target.

  DefaultMessage(java.lang.String text, int type, java.lang.Object target)
  Creates a new message of the specified type containing the specified text and target.

  Method Summary

  void	clear() Clears the content of this message, which simply sets the message type to be null and clears the text and target.
  protected void	constructDefaultMessage(java.lang.String text, int type, java.lang.Object target) Initializes all of this message's properties using the specified values.
  static Message	createErrorMessage(java.lang.String text) Creates a new error message containing the specified text and no target.
  static Message	createErrorMessage(java.lang.String text, java.lang.Object target) Creates a new error message containing the specified text and target.
  static Message	createNotificationMessage(java.lang.String text) Creates a new notification message containing the specified text and no target.
  static Message	createNotificationMessage(java.lang.String text, java.lang.Object target) Creates a new notification message containing the specified text and target.
  static Message	createWarningMessage(java.lang.String text) Creates a new warning message containing the specified text and no target.
  static Message	createWarningMessage(java.lang.String text, java.lang.Object target) Creates a new warning message containing the specified text and target.
  boolean	equals(java.lang.Object object) Overridden to indicate messages are equal as long as their properties (text, type, and target) are equal.
  java.lang.Object	getTarget() Gets the target object to which this message applies.
  java.lang.String	getText() Gets the text describing this message.
  int	getType() Gets the message type.
  int	hashCode() Return the hash code for this object.
  void	set(java.lang.String text) Sets the message text to the specified value, the type to a notification message, and the target to null.
  void	set(java.lang.String text, int type) Sets the message text and type to the specified values, and the target to null.
  void	set(java.lang.String text, int type, java.lang.Object target) Sets all of this message's properties using the specified values.
  void	setMessage(Message message) Sets all of this message's properties using the property values from the specified message.
  void	setTarget(java.lang.Object target) Sets the message target.
  void	setText(java.lang.String text) Sets the message text.
  void	setType(int type) Sets the message type.
  java.lang.String	toString() Return the message text.

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  DefaultMessage

  public DefaultMessage()

  Creates a new null message (with no text or target).

  Since:

  3.0

  DefaultMessage

  public DefaultMessage(java.lang.String text)

  Creates a new notification message containing the specified text and no target.

  Parameters:

  text - The message text

  Since:

  3.0

  DefaultMessage

  public DefaultMessage(java.lang.String text,
                        int type)

  Creates a new message of the specified type containing the specified text and no target.

  Parameters:

  text - The message text

  type - The message type

  Since:

  3.0

  DefaultMessage

  public DefaultMessage(java.lang.String text,
                        int type,
                        java.lang.Object target)

  Creates a new message of the specified type containing the specified text and target.

  Parameters:

  text - The message text

  type - The message type

  target - The message target

  Since:

  3.0

  DefaultMessage

  public DefaultMessage(Message message)

  Creates a new message using the properties of the specified message.

  Parameters:

  message - An instance of Message

  Since:

  3.0

  Method Detail

  createErrorMessage

  public static Message createErrorMessage(java.lang.String text)

  Creates a new error message containing the specified text and no target.

  Parameters:

  text - The message text

  Returns:

  the error message; never null

  createErrorMessage

  public static Message createErrorMessage(java.lang.String text,
                                           java.lang.Object target)

  Creates a new error message containing the specified text and target.

  Parameters:

  text - The message text

  target - The message target

  Returns:

  the error message; never null

  createNotificationMessage

  public static Message createNotificationMessage(java.lang.String text)

  Creates a new notification message containing the specified text and no target.

  Parameters:

  text - The message text

  Returns:

  the error message; never null

  createNotificationMessage

  public static Message createNotificationMessage(java.lang.String text,
                                                  java.lang.Object target)

  Creates a new notification message containing the specified text and target.

  Parameters:

  text - The message text

  target - The message target

  Returns:

  the error message; never null

  createWarningMessage

  public static Message createWarningMessage(java.lang.String text)

  Creates a new warning message containing the specified text and no target.

  Parameters:

  text - The message text

  Returns:

  the error message; never null

  createWarningMessage

  public static Message createWarningMessage(java.lang.String text,
                                             java.lang.Object target)

  Creates a new warning message containing the specified text and target.

  Parameters:

  text - The message text

  target - The message target

  Returns:

  the error message; never null

  clear

  public void clear()

  Clears the content of this message, which simply sets the message type to be null and clears the text and target.

  constructDefaultMessage

  protected void constructDefaultMessage(java.lang.String text,
                                         int type,
                                         java.lang.Object target)

  Initializes all of this message's properties using the specified values.

  Parameters:

  text - The message text

  type - The message type

  target - The message target

  equals

  public boolean equals(java.lang.Object object)

  Overridden to indicate messages are equal as long as their properties (text, type, and target) are equal.

  Overrides:

  equals in class java.lang.Object

  Parameters:

  object - the Object to be compared to this object

  Returns:

  true if the specified object is considered equivalent to this object, or false otherwise

  getTarget

  public java.lang.Object getTarget()

  Gets the target object to which this message applies.

  Specified by:

  getTarget in interface Message

  Returns:

  The target object if set, otherwise null

  getText

  public java.lang.String getText()

  Gets the text describing this message.

  Specified by:

  getText in interface Message

  Returns:

  The message text if set, otherwise null

  getType

  public int getType()

  Gets the message type. This is a context-sensitive value, defined by the application or obtained from one of the built-in types.

  Specified by:

  getType in interface Message

  Returns:

  The message type if set, otherwise NULL_MESSAGE

  hashCode

  public int hashCode()

  Return the hash code for this object. This method is overridden to return the same hashCode for messages that are equal. Note that since the hash code is dependent upon modifiable properties, instances of this class should not be modified when stored within a hashing collection.

  Overrides:

  hashCode in class java.lang.Object

  Returns:

  the hash code value

  set

  public void set(java.lang.String text)

  Sets the message text to the specified value, the type to a notification message, and the target to null.

  Parameters:

  text - The message text

  set

  public void set(java.lang.String text,
                  int type)

  Sets the message text and type to the specified values, and the target to null.

  Parameters:

  text - The message text

  type - The message type

  set

  public void set(java.lang.String text,
                  int type,
                  java.lang.Object target)

  Sets all of this message's properties using the specified values.

  Parameters:

  text - The message text

  type - The message type; may be any value, although use of MessageTypes constants are encouraged.

  target - The message target

  setMessage

  public void setMessage(Message message)

  Sets all of this message's properties using the property values from the specified message.

  Parameters:

  message - An instance of Message

  setTarget

  public void setTarget(java.lang.Object target)

  Sets the message target.

  Parameters:

  target - The message target

  Throws:

  java.lang.IllegalStateException - If the message type is NULL_MESSAGE.

  setText

  public void setText(java.lang.String text)

  Sets the message text.

  Parameters:

  text - The message text

  Throws:

  java.lang.IllegalStateException - If the message type is NULL_MESSAGE.

  setType

  public void setType(int type)

  Sets the message type. Clears the text and target properties if type is NULL_MESSAGE.

  Parameters:

  type - The message type; may be any value, although use of MessageTypes constants are encouraged.

  toString

  public java.lang.String toString()

  Return the message text.

  Overrides:

  toString in class java.lang.Object

  Returns:

  the String representation of this message, which is the message text.