org.mediawiki.api.json

Class ApiResult

java.lang.Object

org.mediawiki.api.json.ApiResult

public class ApiResult
extends java.lang.Object

Encapsulates the result of performing an API call. The network request is made *only* when asArray() or asObject() is called.

Method Summary

Methods

Modifier and Type	Method and Description
org.json.JSONArray	asArray() Start the network request & return the response as a JSON Array.
org.json.JSONObject	asObject() Start the network request & return the response as a JSON Object.
void	cancel() Disconnect the request if it is in progress.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders() Get the Map of headers returned for the response.

Methods inherited from class java.lang.Object

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

Method Detail

cancel

public void cancel()

Disconnect the request if it is in progress.

asArray

public org.json.JSONArray asArray()
                           throws ApiException

Start the network request & return the response as a JSON Array. Locally cache the result too, so multiple calls to this method will succeeed. Use this when a JSON Array is returned by the API. So far, only action=opensearch.

Returns:

A JSONArray object with the results of the API query.

Throws:

ApiException - Thrown in the case of any error(s). Check the inner exception for details.

asObject

public org.json.JSONObject asObject()
                             throws ApiException

Start the network request & return the response as a JSON Object. Locally cache the result too, so multiple calls to this method will succeeed.

Returns:

A JSONObject object with the results of the API query.

Throws:

ApiException - Thrown in the case of any error(s). Check the inner exception for details.

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
                                                                            throws java.lang.NullPointerException

Get the Map of headers returned for the response. Note that this must be called after asArray or asObject.

Returns:

Map>

Throws:

java.lang.NullPointerException