com.newaer.sdk.proximity

Class NAMessage

java.lang.Object

com.newaer.sdk.proximity.NAMessage

All Implemented Interfaces:

Comparable<NAMessage>

Direct Known Subclasses:

NAMessageImpl

public abstract class NAMessage
extends Object

Representation of a message to be sent to another device.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NAMessage() Only subclass construction.

Method Summary

Modifier and Type	Method and Description
int	compareTo(com.newaer.sdk.proximity.NAObject another)
boolean	equals(Object another)
abstract void	finish() Blocks until the sending of the message is complete.
abstract byte[]	getData()
abstract String	getDestinationDeviceId()
abstract String	getId() Returns the identifier for this object within the platform.
abstract String	getName() Returns the name for this object within the platform.
abstract NAMessage	getReply()
abstract String	getSenderDeviceId()
int	hashCode()
abstract boolean	isFinished() Returns true if finish() would not block.
abstract void	send() Queues the message for sending.
abstract void	setData(byte[] data) Sets the data for this message.
abstract void	setName(Context context, String name) Change the name for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NAMessage

protected NAMessage()

Only subclass construction.

Method Detail

getDestinationDeviceId

public abstract String getDestinationDeviceId()

Returns:

the ID of the device which received/will receive this message.

getSenderDeviceId

public abstract String getSenderDeviceId()

Returns:

the ID of the device which sent this message.

setData

public abstract void setData(byte[] data)

Sets the data for this message.

Parameters:

data - the data to sendMessage.

Throws:

IllegalStateException - if sendMessage() has already been called.

IllegalArgumentException - if data.length > 256

getData

public abstract byte[] getData()

Returns:

the data included in this message.

send

public abstract void send()

Queues the message for sending. Further modification via set methods is not allowed.

Throws:

UnsupportedOperationException - if the device type doesn't support messaging.

finish

public abstract void finish()

Blocks until the sending of the message is complete.

isFinished

public abstract boolean isFinished()

Returns true if finish() would not block.

getReply

public abstract NAMessage getReply()

Returns:

a new message which can be sent as a reply.

getId

public abstract String getId()

Returns the identifier for this object within the platform.

This identifier is unique on a per object type basis.

Returns:

the identifier for the object.

getName

public abstract String getName()

Returns the name for this object within the platform.

Returns:

the name for the object.

setName

public abstract void setName(Context context,
                             String name)

Change the name for this object.

Parameters:

context - the context to work in

name - the new name for this object.

compareTo

public int compareTo(com.newaer.sdk.proximity.NAObject another)

Specified by:

compareTo in interface Comparable<T extends com.newaer.sdk.proximity.NAObject>

equals

public boolean equals(Object another)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object