io.keen.client.android

Class AndroidJsonHandler

java.lang.Object

io.keen.client.android.AndroidJsonHandler

All Implemented Interfaces:

io.keen.client.java.KeenJsonHandler

public class AndroidJsonHandler
extends java.lang.Object
implements io.keen.client.java.KeenJsonHandler

Implementation of the KeenJsonHandler interface using the built-in Android JSON library (JSONObject).

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AndroidJsonHandler.JsonObjectManager Interface wrapping usage of JSONObjects.

Constructor Summary

Constructors

Constructor and Description
AndroidJsonHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	readJson(java.io.Reader reader)
protected void	setJsonObjectManager(AndroidJsonHandler.JsonObjectManager jsonObjectManager) Sets the AndroidJsonHandler.JsonObjectManager instance to use.
void	setWrapNestedMapsAndCollections(boolean value) Sets whether or not this handler should wrap nested maps and collections explicitly.
void	writeJson(java.io.Writer writer, java.util.Map<java.lang.String,?> value)

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidJsonHandler

public AndroidJsonHandler()

Method Detail

readJson

public java.util.Map<java.lang.String,java.lang.Object> readJson(java.io.Reader reader)
                                                          throws java.io.IOException

Specified by:

readJson in interface io.keen.client.java.KeenJsonHandler

Throws:

java.io.IOException

writeJson

public void writeJson(java.io.Writer writer,
             java.util.Map<java.lang.String,?> value)
               throws java.io.IOException

Specified by:

writeJson in interface io.keen.client.java.KeenJsonHandler

Throws:

java.io.IOException

setWrapNestedMapsAndCollections

public void setWrapNestedMapsAndCollections(boolean value)

Sets whether or not this handler should wrap nested maps and collections explicitly. If set to false, maps will be passed directly to JSONObject's constructor without any modification. Wrapping is necessary on older versions of Android due to a bug in the org.json implementation. For details, see: https://code.google.com/p/android/issues/detail?id=55114 In general, clients of the SDK should never change the default for this value unless they have done extensive testing and understand the risks.

Parameters:

value - true to enable wrapping, false to disable it.

setJsonObjectManager

protected void setJsonObjectManager(AndroidJsonHandler.JsonObjectManager jsonObjectManager)

Sets the AndroidJsonHandler.JsonObjectManager instance to use. By default this class will simply use the normal Android JSONObject methods, but this method may be used to provide a different implementation, such as a stubbed/mocked implementation for unit testing.

Parameters:

jsonObjectManager - The AndroidJsonHandler.JsonObjectManager instance to use.