com.digi.xbee.api.models

Class UserDataRelayMessage

java.lang.Object

com.digi.xbee.api.models.UserDataRelayMessage

public class UserDataRelayMessage
extends Object

This class represents a User Data Relay message containing the source interface and the content (data) of the message.

Since:

1.3.0

Constructor Summary

Constructors

Constructor and Description
UserDataRelayMessage(XBeeLocalInterface localInterface, byte[] data) Class constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Returns a byte array containing the data of the message.
String	getDataString() Returns the data of the message in string format.
XBeeLocalInterface	getSourceInterface() Returns the source interface that sent this message.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserDataRelayMessage

public UserDataRelayMessage(XBeeLocalInterface localInterface,
                            byte[] data)

Class constructor. Instantiates a new object of type UserDataRelayMessage with the given parameters.

Parameters:

localInterface - The source XBee local interface.

data - Byte array containing the data of the message.

Throws:

NullPointerException - if localInterface == null.

See Also:

XBeeLocalInterface

Method Detail

getData

public byte[] getData()

Returns a byte array containing the data of the message.

Returns:

A byte array containing the data of the message or null if the message does not have any data.

getDataString

public String getDataString()

Returns the data of the message in string format.

Returns:

The data of the message in string format or null if the message does not have any data.

getSourceInterface

public XBeeLocalInterface getSourceInterface()

Returns the source interface that sent this message.

Returns:

The source interface that sent this message.

See Also:

XBeeLocalInterface