com.crankuptheamps.client

Class CompositeMessageBuilder

java.lang.Object

com.crankuptheamps.client.CompositeMessageBuilder

public class CompositeMessageBuilder
extends java.lang.Object

Used to create payloads for AMPS composite messages, which are messages with a number of parts where each part is a complete message of a specific message type. For example, a composite message type of "composite-json-binary" may be declared on the server that combines a set of JSON headers with an opaque binary payload. CompositeMessageBuilder makes it easy to assemble this payload.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	_bytes
int	_position

Constructor Summary

Constructors

Constructor and Description
CompositeMessageBuilder() Create a new, empty CompositeMessageBuilder.
CompositeMessageBuilder(int initialCapacity_) Create a new empty CompositeMessageBuilder.

Method Summary

Modifier and Type	Method and Description
CompositeMessageBuilder	append(byte[] data_, int offset_, int length_) Appends a byte array to this object.
CompositeMessageBuilder	append(java.lang.String data_) Appends a message part to this object.
CompositeMessageBuilder	clear() Clears this object.
void	setField(Field field_) Sets a Field with the contents of this object.

Methods inherited from class java.lang.Object

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

Field Detail

_bytes

public byte[] _bytes

_position

public int _position

Constructor Detail

CompositeMessageBuilder

public CompositeMessageBuilder()

Create a new, empty CompositeMessageBuilder.

CompositeMessageBuilder

public CompositeMessageBuilder(int initialCapacity_)

Create a new empty CompositeMessageBuilder.

Parameters:

initialCapacity_ - The default capacity in bytes for the serialized representation of a message. Ideal value is total message size in bytes + ( 4 * number of message parts).

Method Detail

clear

public CompositeMessageBuilder clear()

Clears this object. Does not release or resize internal buffer.

Returns:

This object

append

public CompositeMessageBuilder append(byte[] data_,
                                      int offset_,
                                      int length_)

Appends a byte array to this object.

Parameters:

data_ - The bytes of the data to append.

offset_ - The offset in data_ where your data begins.

length_ - The length of your data.

Returns:

This object

append

public CompositeMessageBuilder append(java.lang.String data_)

Appends a message part to this object.

Parameters:

data_ - The data to append.

Returns:

This object

setField

public void setField(Field field_)

Sets a Field with the contents of this object.

Parameters:

field_ - The Field to set.