io.apimatic.core.types.http.response

Class Dynamic

java.lang.Object

io.apimatic.core.types.http.response.Dynamic

All Implemented Interfaces:

io.apimatic.coreinterfaces.http.response.DynamicType

public class Dynamic
extends Object
implements io.apimatic.coreinterfaces.http.response.DynamicType

Represents dynamic response returned by an API call. Allows user to lazily parse the response as a primitive or a more complex type using parse().

Constructor Summary

Constructors

Constructor and Description
Dynamic(io.apimatic.coreinterfaces.http.response.Response responseBody) Instantiate class.

Method Summary

Modifier and Type	Method and Description
io.apimatic.coreinterfaces.http.HttpHeaders	getHeaders() Get response headers for the HTTP response.
InputStream	getRawBody() Get the raw stream for the response body.
<T> T	parse(Class<T> cls) Parse response as instance of class cls.
boolean	parseAsBoolean() Parse response as boolean.
byte	parseAsByte() Parse response as boolean.
char	parseAsCharacter() Parse response as character.
Map<String,Object>	parseAsDictionary() Parse response as a map of keys and values.
double	parseAsDouble() Parse response as double.
float	parseAsFloat() Parse response as float.
int	parseAsInteger() Parse response as integer.
long	parseAsLong() Parse response as long.
short	parseAsShort() Parse response as short.
String	parseAsString() Parse response as string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Dynamic

public Dynamic(io.apimatic.coreinterfaces.http.response.Response responseBody)

Instantiate class.

Parameters:

responseBody - The object of HttpResponse.

Method Detail

parse

public <T> T parse(Class<T> cls)
            throws ParseException

Parse response as instance of class cls.

Specified by:

parse in interface io.apimatic.coreinterfaces.http.response.DynamicType

Type Parameters:

T - The type of class to be parsed.

Parameters:

cls - Class to be parsed.

Returns:

Object of type T.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsBoolean

public boolean parseAsBoolean()
                       throws ParseException

Parse response as boolean.

Specified by:

parseAsBoolean in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsByte

public byte parseAsByte()
                 throws ParseException

Parse response as boolean.

Specified by:

parseAsByte in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsCharacter

public char parseAsCharacter()
                      throws ParseException

Parse response as character.

Specified by:

parseAsCharacter in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsFloat

public float parseAsFloat()
                   throws ParseException

Parse response as float.

Specified by:

parseAsFloat in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsInteger

public int parseAsInteger()
                   throws ParseException

Parse response as integer.

Specified by:

parseAsInteger in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsLong

public long parseAsLong()
                 throws ParseException

Parse response as long.

Specified by:

parseAsLong in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occurred

parseAsShort

public short parseAsShort()
                   throws ParseException

Parse response as short.

Specified by:

parseAsShort in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsDouble

public double parseAsDouble()
                     throws ParseException

Parse response as double.

Specified by:

parseAsDouble in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsString

public String parseAsString()
                     throws ParseException

Parse response as string.

Specified by:

parseAsString in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed value.

Throws:

ParseException - Signals if a parse exception occurred.

parseAsDictionary

public Map<String,Object> parseAsDictionary()
                                     throws ParseException

Parse response as a map of keys and values.

Specified by:

parseAsDictionary in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Parsed map.

Throws:

ParseException - Signals if a parse exception occurred.

getRawBody

public InputStream getRawBody()

Get the raw stream for the response body.

Specified by:

getRawBody in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Raw body.

getHeaders

public io.apimatic.coreinterfaces.http.HttpHeaders getHeaders()

Get response headers for the HTTP response.

Specified by:

getHeaders in interface io.apimatic.coreinterfaces.http.response.DynamicType

Returns:

Headers.