com::cosylab::acs::maci::MessageType Class Reference

Collaboration diagram for com::cosylab::acs::maci::MessageType:

[legend]

List of all members.

Public Member Functions
String	getName ()
String	getDescription ()
String	toString ()
Static Public Attributes
static final MessageType	MSG_ERROR = new MessageType("MSG_ERROR", "Error message.")
static final MessageType	MSG_INFORMATION = new MessageType("MSG_INFORMATION", "Informational message.")
Protected Member Functions
	MessageType (String name, String description)
Private Attributes
String	name
String	description

---

Detailed Description

Type of the message. Can be either MSG_ERROR or MSG_INFORMATION.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

Version:

@VERSION@

---

Constructor & Destructor Documentation

com::cosylab::acs::maci::MessageType::MessageType	(	String	name,
		String	description
	)			[inline, protected]

Creates a new message type with its name and description. Contructor is protected to deny creation of unsupported types

Parameters:

	name	name of the type, non-null
	description	description of the type, non-null

---

Member Function Documentation

String com::cosylab::acs::maci::MessageType::getDescription

(

)

[inline]

Returns the description of the type.

Returns:

String description of the type

References description.

String com::cosylab::acs::maci::MessageType::getName

(

)

[inline]

Returns the name of the type.

Returns:

String name of the type

References name.

String com::cosylab::acs::maci::MessageType::toString

(

)

[inline]

Returns a single-line rendition of this instance into text.

Returns:

internal state of this instance

References description, and name.

---

Member Data Documentation

String com::cosylab::acs::maci::MessageType::description [private]

The description of the type.

Referenced by getDescription(), and toString().

final MessageType com::cosylab::acs::maci::MessageType::MSG_ERROR = new MessageType("MSG_ERROR", "Error message.") [static]

Error message.

Referenced by com::cosylab::acs::maci::plug::ClientProxyImpl::message(), and com::cosylab::acs::maci::plug::ClientProxyImpl::taggedmessage().

final MessageType com::cosylab::acs::maci::MessageType::MSG_INFORMATION = new MessageType("MSG_INFORMATION", "Informational message.") [static]

Informational message.

Referenced by com::cosylab::acs::maci::plug::ClientProxyImpl::message(), and com::cosylab::acs::maci::plug::ClientProxyImpl::taggedmessage().

String com::cosylab::acs::maci::MessageType::name [private]

The name of the type (e.g. MSG_ERROR).

Referenced by getName(), and toString().

---

The documentation for this class was generated from the following file:

• MessageType.java