CompositeMessageParser (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.CompositeMessageParser

```
public class CompositeMessageParser
extends java.lang.Object
```
Used to retrieve individual message parts from AMPS composite messages, which are messages where the data contains a number of parts and 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. CompositeMessageParser makes it easy to retrieve the parts of a composite message from the composite message payload.

Constructor Summary

Constructors
Constructor and Description
`CompositeMessageParser()` Creates a new CompositeMessageParser, with 0 valid parts.
`CompositeMessageParser(Field body_)` Creates a new CompositeMessageParser and parses the provided message body.
`CompositeMessageParser(Message message_)` Creates a new CompositeMessageParser and parses a message's body.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Field`	`getPart(int index_, Field field_)` Returns a part from a composite message body.
`java.lang.String`	`getString(int index_)` Returns a part from a composite message body.
`java.lang.String`	`getString(int index_, java.nio.charset.Charset charset)` Returns a part from a composite message body.
`int`	`parse(Field body_)` Parses a composite message's body.
`int`	`parse(Message message_)` Parses a composite message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CompositeMessageParser
```
public CompositeMessageParser()
```
    Creates a new CompositeMessageParser, with 0 valid parts.
  - CompositeMessageParser
```
public CompositeMessageParser(Field body_)
```
    Creates a new CompositeMessageParser and parses the provided message body.
    
    Parameters:
    
    body_ - The composite body (returned from Message.getDataRaw()).
  - CompositeMessageParser
```
public CompositeMessageParser(Message message_)
```
    Creates a new CompositeMessageParser and parses a message's body.
    
    Parameters:
    
    message_ - The message containing a composite body.
- Method Detail
  - parse
```
public final int parse(Message message_)
```
    Parses a composite message.
    
    Parameters:
    
    message_ - The message with a composite body.
    
    Returns:
    
    The number of message parts found in message_
  - parse
```
public final int parse(Field body_)
```
    Parses a composite message's body.
    
    Parameters:
    
    body_ - The composite body (returned from Message.getDataRaw()).
    
    Returns:
    
    The number of message parts found in body_
  - getString
```
public java.lang.String getString(int index_)
```
    Returns a part from a composite message body.
    
    Parameters:
    
    index_ - The part index to retrieve (0-based index)
    
    Returns:
    
    The data of this body part, decoded as UTF-8.
  - getString
```
public java.lang.String getString(int index_,
                                  java.nio.charset.Charset charset)
```
    Returns a part from a composite message body.
    
    Parameters:
    
    index_ - The part index to retrieve (0-based index)
    
    charset - The Charset to decode this body with.
    
    Returns:
    
    The data of this body part.
  - getPart
```
public Field getPart(int index_,
                     Field field_)
```
    Returns a part from a composite message body.
    
    Parameters:
    
    index_ - The part index to retrieve (0-based index)
    
    field_ - The Field to update with the buffer, index, and length of this part.
    
    Returns:
    
    The field passed as field_.

Class CompositeMessageParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompositeMessageParser

CompositeMessageParser

CompositeMessageParser

Method Detail

parse

parse

getString

getString

getPart