javax.wireless.messaging
Interface TextMessage

All Superinterfaces:

Message

public interface TextMessage

extends Message

An interface representing a text message. This is a subinterface of Messagewhich contains methods to get and set the text payload. The setPayloadTextmethod sets the value of the payload in the data container without any checking whether the value is valid in any way. Methods for manipulating the address portion of the message are inherited from Message.

Object instances implementing this interface are just containers for the data that is passed in.

Character Encoding Considerations

Text messages using this interface deal with String s encoded in Java. The underlying implementation will convert the String s into a suitable encoding for the messaging protocol in question. Different protocols recognize different character sets. To ensure that characters are transmitted correctly across the network, an application should use the character set(s) recognized by the protocol. If an application is unaware of the protocol, or uses a character set that the protocol does not recognize, then some characters might be transmitted incorrectly.

Method Summary

java.lang.String	getPayloadText() Returns the message payload data as a String.
void	setPayloadText(java.lang.String data) Sets the payload data of this message.

Methods inherited from interface javax.wireless.messaging.Message

getAddress, getTimestamp, setAddress

Method Detail

getPayloadText

public java.lang.String getPayloadText()

Returns the message payload data as a String.

Returns:

the payload of this message, or null if the payload for the message is not set

See Also:

setPayloadText(java.lang.String)

setPayloadText

public void setPayloadText(java.lang.String data)

Sets the payload data of this message. The payload data may be null.

Parameters:

data - payload data as a String

See Also:

getPayloadText()