public class

Message

extends Object
java.lang.Object
   ↳ com.esri.core.symbol.advanced.Message

Class Overview

A Message contains properties which can be processed by a MessageProcessor. Apart from the message ID, all other properties are name-value pairs which should be recognizable to the target message processor.

Summary

Public Constructors
Message()
Initializes a Message object.
Message(JsonParser parser)
Initializes a Message object from an JsonParser object.
Message(Message other)
Initializes a Message object from another message.
Public Methods
void addProperties(Map<String, Object> properties)
Adds the properties as a Map.
String getID()
Gets the message ID.
Map<String, Object> getProperties()
Gets the properties as a Map.
Object getProperty(String name)
Returns the property value of the specified property name.
void setID(String id)
Sets the message ID.
void setProperties(Map<String, Object> properties)
Sets the properties as a Map.
void setProperty(String name, Object value)
Sets the property with the specified name-value pair.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Message ()

Initializes a Message object.

public Message (JsonParser parser)

Initializes a Message object from an JsonParser object.

Parameters
parser JsonParser: JsonParser object which represents a message in JSON format.

public Message (Message other)

Initializes a Message object from another message.

Parameters
other Message: the other message.

Public Methods

public void addProperties (Map<String, Object> properties)

Adds the properties as a Map. The new properties are added into the old properties.

Parameters
properties Map: the properties to add.

public String getID ()

Gets the message ID.

Returns
String the message ID string.

public Map<String, Object> getProperties ()

Gets the properties as a Map.

Returns
Map<String, Object> the property map.

public Object getProperty (String name)

Returns the property value of the specified property name.

Parameters
name String: property name.
Returns
Object property value.

public void setID (String id)

Sets the message ID.

Parameters
id String: the id to set

public void setProperties (Map<String, Object> properties)

Sets the properties as a Map. The old properties are replaced.

Parameters
properties Map: the properties to set

public void setProperty (String name, Object value)

Sets the property with the specified name-value pair. If the property already exists, the old value is replaced.

Parameters
name String: property name.
value Object: property value.

public String toString ()

Returns
String