org.mediawiki.api.json

Class RequestBuilder

java.lang.Object

org.mediawiki.api.json.RequestBuilder

public class RequestBuilder
extends java.lang.Object

Fluent interface to easily build up an API request from params.

Method Summary

Methods

Modifier and Type	Method and Description
ApiResult	get() Sets up a GET request using the parameters so far specified.
java.util.Map<java.lang.String,java.lang.String>	getParams()
RequestBuilder	param(java.lang.String key, java.lang.String value) Add a parameter to the current request.
ApiResult	post() Sets up a POST request using the parameters so far specified.

Methods inherited from class java.lang.Object

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

Method Detail

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Returns:

A copy of the current set of parameters for this request

param

public RequestBuilder param(java.lang.String key,
                   java.lang.String value)

Add a parameter to the current request.

Parameters:

key - Parameter's name

value - Parameter's value

Returns:

The `this` object, so you can chain params together

get

public ApiResult get()
              throws ApiException

Sets up a GET request using the parameters so far specified. Use ApiResult.asArray() or ApiResult.asObject() to actually start the network request and get the response.

Returns:

An ApiResult object which can be used to get the result of this query.

Throws:

ApiException - Thrown in the case of a network error.

post

public ApiResult post()
               throws ApiException

Sets up a POST request using the parameters so far specified. The network operation is performed immediately. Use ApiResult.asArray() or ApiResult.asObject() to get the response.

Returns:

An ApiResult object which can be used to get the result of this query.

Throws:

ApiException - Thrown in the case of a network error.