Kanzi Framework  3.9.0
Java API
MessageType Class Reference

An instance of a MessageType represents a single message type in the Kanzi message system. More...

Inheritance diagram for MessageType:
[legend]

Classes

class  Iterator
 

Public Member Functions

 MessageType (MessageRouting routing)
 Creates a new message type without a name. More...
 
 MessageType (String name, MessageRouting routing)
 Creates a new message type. More...
 
boolean equals (Object object)
 
String getName ()
 Gets the fully qualified name of the message type in the form "Class.MessageType". More...
 
MessageRouting getRouting ()
 Gets the message routing of the message type. More...
 
String toString ()
 Gets the string presentation of the MessageType. More...
 

Detailed Description

An instance of a MessageType represents a single message type in the Kanzi message system.

A message type exists throughout the lifetime of an application.

To work with the existing message types, use AbstractMessageType.

Constructor & Destructor Documentation

◆ MessageType() [1/2]

Creates a new message type without a name.

The name is assigned by metadata registration. The name of the message type will have "Message." prefix. Followed by the metaclass' name the message type is being added to, and finally the name of the field that is owning the message type. If the field's name has a "Message" suffix, it gets trimmed from the name.

Parameters
routingType of message routing to use with this message type.

◆ MessageType() [2/2]

MessageType ( String  name,
MessageRouting  routing 
)

Creates a new message type.

Parameters
nameFully qualified name of the message type.
routingType of message routing to use with this message type.

Member Function Documentation

◆ getName()

String getName ( )

Gets the fully qualified name of the message type in the form "Class.MessageType".

Returns
The fully qualified name of the message type.

◆ getRouting()

MessageRouting getRouting ( )

Gets the message routing of the message type.

Returns
MessageRouting mode of the message type.

◆ toString()

String toString ( )

Gets the string presentation of the MessageType.

Returns
String presentation of the MessageType.