org.javarosa.core.services.transport.payload

Class MultiMessagePayload

java.lang.Object

org.javarosa.core.services.transport.payload.MultiMessagePayload

All Implemented Interfaces:

IDataPayload, Externalizable

public class MultiMessagePayload
extends Object
implements IDataPayload

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
MultiMessagePayload() Note: Only useful for serialization.

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IDataPayloadVisitor<T> visitor) Visitor pattern accept method.
void	addPayload(IDataPayload payload) Adds a payload that should be sent as part of this payload.
long	getLength()
String	getPayloadId()
List<IDataPayload>	getPayloads()
InputStream	getPayloadStream() Gets the stream for this payload.
int	getPayloadType()
int	getTransportId()
void	readExternal(DataInputStream in, PrototypeFactory pf)
void	writeExternal(DataOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiMessagePayload

public MultiMessagePayload()

Note: Only useful for serialization.

Method Detail

addPayload

public void addPayload(IDataPayload payload)

Adds a payload that should be sent as part of this payload.

Parameters:

payload - A payload that will be transmitted after all previously added payloads.

getPayloads

public List<IDataPayload> getPayloads()

Returns:

A vector object containing each IDataPayload in this payload.

getPayloadStream

public InputStream getPayloadStream()
                             throws IOException

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.

Throws:

IOException

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.

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.

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

getLength

public long getLength()

Specified by:

getLength in interface IDataPayload