io.apimatic.coreinterfaces.http.response

Interface DynamicType

public interface DynamicType

Represents dynamic response returned by an API call.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

parse

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

Parse response as instance of class cls.

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 occured

parseAsBoolean

boolean parseAsBoolean()
                throws ParseException

Parse response as boolean.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsByte

byte parseAsByte()
          throws ParseException

Parse response as boolean.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsCharacter

char parseAsCharacter()
               throws ParseException

Parse response as character.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsFloat

float parseAsFloat()
            throws ParseException

Parse response as float.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsInteger

int parseAsInteger()
            throws ParseException

Parse response as integer.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsLong

long parseAsLong()
          throws ParseException

Parse response as long.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsShort

short parseAsShort()
            throws ParseException

Parse response as short.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsDouble

double parseAsDouble()
              throws ParseException

Parse response as double.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsString

String parseAsString()
              throws ParseException

Parse response as string.

Returns:

Parsed value

Throws:

ParseException - Signals if a parse exception occured

parseAsDictionary

Map<String,Object> parseAsDictionary()
                              throws ParseException

Parse response as a map of keys and values.

Returns:

Parsed map

Throws:

ParseException - Signals if a parse exception occured

getRawBody

InputStream getRawBody()

Get the raw stream for the response body.

Returns:

Raw body

getHeaders

HttpHeaders getHeaders()

Get response headers for the HTTP response.

Returns:

Headers