io.siddhi.doc.gen.extensions.githubclient

Class ContentsResponse<T>

java.lang.Object

io.siddhi.doc.gen.extensions.githubclient.ContentsResponse<T>

Type Parameters:

T - the type of the valid content body

Direct Known Subclasses:

HtmlContentsResponse

public abstract class ContentsResponse<T>
extends Object

The ContentsResponse class represents an abstract view of the Github Contents API response. If the response is valid it will contain an instance of T type class representing response body. If the response is invalid it will contain an instance of JSONObject class representing the error.

Method Summary

Modifier and Type	Method and Description
abstract T	getContent()
ContentsBodyReader	getContentsBodyReader()
org.json.JSONObject	getError() Because of all API error responses are in JSON format the getError method always returns an instance of org.json.JSONObject.
List<String>	getHeader(String name)
int	getStatus()

Methods inherited from class java.lang.Object

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

Method Detail

getContent

public abstract T getContent()
                      throws IOException

Returns:

the body of the response

Throws:

IOException - if error occurs while parsing the response body as a type T instance

getHeader

public List<String> getHeader(String name)

getContentsBodyReader

public ContentsBodyReader getContentsBodyReader()

Returns:

the ContentsBodyReader instance

getError

public org.json.JSONObject getError()
                             throws IOException

Because of all API error responses are in JSON format the getError method always returns an instance of org.json.JSONObject.

Returns:

the error message as a JSONObject

Throws:

IOException - if error occurs while parsing the response body as a JSONObject

getStatus

public int getStatus()

Returns:

the HTTP status code in the response.