MessageType< MessageArgumentsType extends MessageArguments > Class Template Reference

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

Inheritance diagram for MessageType< MessageArgumentsType extends MessageArguments >:

Public Member Functions
	MessageType (MessageRouting routing, Class< MessageArgumentsType > messageArgumentClass)
	Creates a new message type without a name.
	MessageType (String name, MessageRouting routing, Class< MessageArgumentsType > messageArgumentClass)
	Creates a new message type.
boolean	equals (Object object)
Metaclass	getArgumentsMetaclass ()
	Gets the metaclass of the message arguments class associated with the message type.
String	getName ()
	Gets the fully qualified name of the message type in the form "Class.MessageType".
long	getNative ()
	Gets a pointer to the backing C++ instance.
MessageRouting	getRouting ()
	Gets the message routing of the message type.
MessageTypeWrapper	getWrapper ()
	Gets a wrapper for a MessageType object.
int	hashCode ()
String	toString ()
	Gets the string presentation of the MessageType.

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 com.rightware.kanzi.AbstractMessageType.

Parameters

<MessageArgumentsType>

Associated message arguments class, which holds the property type definitions for the arguments of this message type. If you do not have a message arguments class, you can use the base class MessageArguments.

Constructor & Destructor Documentation

MessageType() [1/2]

MessageType	(	MessageRouting	routing,
		Class< MessageArgumentsType >	messageArgumentClass )

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

routing	Type of message routing to use with this message type.
messageArgumentClass	Class of the associated message-argument type.

MessageType() [2/2]

MessageType	(	String	name,
		MessageRouting	routing,
		Class< MessageArgumentsType >	messageArgumentClass )

Creates a new message type.

Parameters

name	Fully qualified name of the message type.
routing	Type of message routing to use with this message type.
messageArgumentClass	Class of the associated message-argument type.

Member Function Documentation

getArgumentsMetaclass()

Metaclass getArgumentsMetaclass

(

)

Gets the metaclass of the message arguments class associated with the message type.

Returns

Metaclass of message arguments class associated with the message type.

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.

getNative()

long getNative

(

)

Gets a pointer to the backing C++ instance.

Returns

A pointer to the backing C++ instance. Type: const AbstractMessageTypeDescriptor*.

getRouting()

MessageRouting getRouting

(

)

Gets the message routing of the message type.

Returns

MessageRouting mode of the message type.

getWrapper()

MessageTypeWrapper getWrapper

(

)

Gets a wrapper for a MessageType object.

Returns

A MessageTypeWrapper object pointing to a MessageType object.

toString()

String toString

(

)

Gets the string presentation of the MessageType.

Returns

String presentation of the MessageType.