org.jboss.aerogear.android.pipe

Class MarshallingConfig

java.lang.Object

org.jboss.aerogear.android.pipe.MarshallingConfig

public class MarshallingConfig
extends Object

This class holds configuration data used by requestBuilders and response parsers to manage data.

Constructor Summary

Constructors

Constructor and Description
MarshallingConfig()

Method Summary

Modifier and Type	Method and Description
String	getDataRoot() DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server.
Charset	getEncoding() Encoding is the data encoding of the http body.
void	setDataRoot(String dataRoot) DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server.
void	setEncoding(Charset encoding) Encoding is the data encoding of the http body.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarshallingConfig

public MarshallingConfig()

Method Detail

getEncoding

public Charset getEncoding()

Encoding is the data encoding of the http body. Default is "UTF-8"

Returns:

the current encoding.

setEncoding

public void setEncoding(Charset encoding)

Encoding is the data encoding of the http body. Default is "UTF-8"

Parameters:

encoding - a new encoding to set

Throws:

IllegalArgumentException - if encoding is null

getDataRoot

public String getDataRoot()

DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server. For example:

 {
 "speakers": {
      "data": [
          {"speakerName":"John Doe", "speakerid":42},
          {"speakerName":"Jesse James", "speakerid":5309},
      ]
  }
 }
 

A DataRoot of "speakers.data" would make the pipe pass a List using the array of speakers to the onSuccess method of callback.

Returns:

the current DataRoot

setDataRoot

public void setDataRoot(String dataRoot)

DataRoot refers to the dotted location of the result we are interested in from the JSON response from the server. For example:

 {
 "speakers": {
      "data": [
          {"speakerName":"John Doe", "speakerid":42},
          {"speakerName":"Jesse James", "speakerid":5309},
      ]
  }
 }
 

A DataRoot of "speakers.data" would make the pipe pass a List using the array of speakers to the onSuccess method of callback.

Parameters:

dataRoot - the root element that the response data will be found under.