org.javarosa.core.services.transport.payload

Class ByteArrayPayload

java.lang.Object

org.javarosa.core.services.transport.payload.ByteArrayPayload

All Implemented Interfaces:

IDataPayload, Externalizable

public class ByteArrayPayload
extends Object
implements IDataPayload

A ByteArrayPayload is a simple payload consisting of a byte array.

Author:

Clayton Sims

Field Summary

Fields inherited from interface org.javarosa.core.services.transport.payload.IDataPayload

PAYLOAD_TYPE_HEADER, PAYLOAD_TYPE_JPG, PAYLOAD_TYPE_MULTI, PAYLOAD_TYPE_SMS, PAYLOAD_TYPE_TEXT, PAYLOAD_TYPE_XML

Constructor Summary

Constructors

Constructor and Description
ByteArrayPayload() Note: Only useful for serialization.
ByteArrayPayload(byte[] payload)
ByteArrayPayload(byte[] payload, String id, int type)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IDataPayloadVisitor<T> visitor) Visitor pattern accept method.
long	getLength()
byte[]	getPayloadBytes()
String	getPayloadId()
InputStream	getPayloadStream() Gets the stream for this payload.
int	getPayloadType()
int	getTransportId()
void	readExternal(DataInputStream in, PrototypeFactory pf)
String	toString()
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ByteArrayPayload

public ByteArrayPayload()

Note: Only useful for serialization.

ByteArrayPayload

public ByteArrayPayload(byte[] payload,
                        String id,
                        int type)

Parameters:

payload - The byte array for this payload.

id - An optional id identifying the payload

type - The type of data for this byte array

ByteArrayPayload

public ByteArrayPayload(byte[] payload)

Parameters:

payload - The byte array for this payload.

Method Detail

getPayloadStream

public InputStream getPayloadStream()

Description copied from interface: IDataPayload

Gets the stream for this payload.

Specified by:

getPayloadStream in interface IDataPayload

Returns:

A stream for the data in this payload.

readExternal

public void readExternal(DataInputStream in,
                         PrototypeFactory pf)
                  throws IOException,
                         DeserializationException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

DeserializationException

writeExternal

public void writeExternal(DataOutputStream out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

accept

public <T> T accept(IDataPayloadVisitor<T> visitor)

Description copied from interface: IDataPayload

Visitor pattern accept method.

Specified by:

accept in interface IDataPayload

Parameters:

visitor - The visitor to visit this payload.

getPayloadBytes

public byte[] getPayloadBytes()

getPayloadId

public String getPayloadId()

Specified by:

getPayloadId in interface IDataPayload

Returns:

A string identifying the contents of the payload

getPayloadType

public int getPayloadType()

Specified by:

getPayloadType in interface IDataPayload

Returns:

The type of the data encapsulated by this payload.

getLength

public long getLength()

Specified by:

getLength in interface IDataPayload

getTransportId

public int getTransportId()

Specified by:

getTransportId in interface IDataPayload

Returns:

A unique Id for the transport manager to use to be able to identify the status of transmissions related to this payload

toString

public String toString()

Overrides:

toString in class Object