com.box.restclientv2.responseparsers

Class DefaultBoxJSONResponseParser

java.lang.Object

com.box.restclientv2.responseparsers.DefaultBoxJSONResponseParser

All Implemented Interfaces:

IBoxResponseParser

Direct Known Subclasses:

BoxObjectResponseParser, ErrorResponseParser

public class DefaultBoxJSONResponseParser
extends Object
implements IBoxResponseParser

This class is a wrapper class in order for Jackson JSON processor to parse response JSON into the wrapped objects.

Constructor Summary

Constructors

Constructor and Description
DefaultBoxJSONResponseParser(Class objectClass, IBoxJSONParser parser) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Class	getObjectClass() Class of the wrapped object.
IBoxJSONParser	getParser()
Object	parse(IBoxResponse response) By default, this only parses the JSON part into object.
protected Object	parseInputStream(InputStream in) Parse input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBoxJSONResponseParser

public DefaultBoxJSONResponseParser(Class objectClass,
                            IBoxJSONParser parser)

Constructor.

Parameters:

objectClass - class of the wrapped object. Response from API will be parsed into this object, caller needs to make sure this class has fields with same names as the JSON part of API response. If class contains more fields than the JSON, those fields will be left null. If the class contains less fields than the JSON, the parsing will error out.

objectMapper - ObjectMapper to be used when parsing.

Method Detail

getParser

public IBoxJSONParser getParser()

getObjectClass

public Class getObjectClass()

Class of the wrapped object.

Returns:

class of the wrapped object.

parse

public Object parse(IBoxResponse response)
             throws BoxRestException

By default, this only parses the JSON part into object. In case caller needs more information(i.e. information from headers) into this object, caller can extend this class and implement the extraParses(HttpResponse httpResponse) method

Specified by:

parse in interface IBoxResponseParser

Parameters:

response - API response.

Returns:

Throws:

BoxRestException

parseInputStream

protected Object parseInputStream(InputStream in)
                           throws BoxRestException,
                                  BoxJSONException

Parse input stream.

Parameters:

in - input stream.

Throws:

BoxRestException

BoxJSONException