info.bliki.api.query

Class RequestBuilder

java.lang.Object

info.bliki.api.query.RequestBuilder

Direct Known Subclasses:

Edit, OpenSearch, Parse, Query, Sitematrix

public class RequestBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
RequestBuilder() Constructor sets the following default values: output format to 'xml' action to 'query'

Method Summary

Modifier and Type	Method and Description
RequestBuilder	action(String action) What action you would like to perform One value: sitematrix, opensearch, login, logout, query, expandtemplates, parse, feedwatchlist, help, paraminfo, purge, rollback, delete, undelete, protect, block, unblock, move, edit, emailuser, watch, patrol Default: help
void	clear()
boolean	containsKey(String arg0)
boolean	containsValue(String arg0)
static RequestBuilder	create()
Set<Map.Entry<String,String>>	entrySet()
boolean	equals(Object arg0)
RequestBuilder	format(String format) The format of the output One value: json, jsonfm, php, phpfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm, rawfm, txt, txtfm, dbg, dbgfm Default: xmlfm
String	get(String arg0)
org.apache.http.NameValuePair[]	getParameters()
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
RequestBuilder	maxage(int maxage) Set the max-age header to this many seconds.
RequestBuilder	maxlag(int maxlag) Maximum lag
String	put(String arg0, String arg1)
void	putAll(Map<? extends String,? extends String> arg0)
RequestBuilder	putPipedString(String parameter, int... pipedValues)
RequestBuilder	putPipedString(String parameter, String... pipedValues)
String	remove(String arg0)
RequestBuilder	requestid() Request ID to distinguish requests.
int	size()
RequestBuilder	smaxage(int smaxage) Set the s-maxage header to this many seconds.
static String	toPipedString(int... pipedValues)
static String	toPipedString(String... pipedValues) Utility method to convert an array of strings into a piped separated/formatted string
String	toString()
Collection<String>	values()
RequestBuilder	version(String version) When showing help, include version for each module

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestBuilder

public RequestBuilder()

Constructor sets the following default values:

1. output format to 'xml'
2. action to 'query'

Method Detail

clear

public void clear()

containsKey

public boolean containsKey(String arg0)

containsValue

public boolean containsValue(String arg0)

entrySet

public Set<Map.Entry<String,String>> entrySet()

equals

public boolean equals(Object arg0)

Overrides:

equals in class Object

get

public String get(String arg0)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

keySet

public Set<String> keySet()

put

public String put(String arg0,
                  String arg1)

putAll

public void putAll(Map<? extends String,? extends String> arg0)

remove

public String remove(String arg0)

size

public int size()

values

public Collection<String> values()

create

public static RequestBuilder create()

format

public RequestBuilder format(String format)

The format of the output One value: json, jsonfm, php, phpfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm, rawfm, txt, txtfm, dbg, dbgfm Default: xmlfm

Parameters:

lType -

Returns:

action

public RequestBuilder action(String action)

What action you would like to perform One value: sitematrix, opensearch, login, logout, query, expandtemplates, parse, feedwatchlist, help, paraminfo, purge, rollback, delete, undelete, protect, block, unblock, move, edit, emailuser, watch, patrol Default: help

Parameters:

lType -

Returns:

version

public RequestBuilder version(String version)

When showing help, include version for each module

Parameters:

lType -

Returns:

maxlag

public RequestBuilder maxlag(int maxlag)

Maximum lag

Parameters:

maxlag -

Returns:

smaxage

public RequestBuilder smaxage(int smaxage)

Set the s-maxage header to this many seconds. Errors are never cached Default: 0

Parameters:

smaxage -

Returns:

maxage

public RequestBuilder maxage(int maxage)

Set the max-age header to this many seconds. Errors are never cached Default: 0

Parameters:

maxage -

Returns:

requestid

public RequestBuilder requestid()

Request ID to distinguish requests. This will just be output back to you

Parameters:

requestid -

Returns:

putPipedString

public RequestBuilder putPipedString(String parameter,
                                     String... pipedValues)

putPipedString

public RequestBuilder putPipedString(String parameter,
                                     int... pipedValues)

toPipedString

public static String toPipedString(String... pipedValues)

Utility method to convert an array of strings into a piped separated/formatted string

Parameters:

pipedValues -

Returns:

toPipedString

public static String toPipedString(int... pipedValues)

toString

public String toString()

Overrides:

toString in class Object

getParameters

public org.apache.http.NameValuePair[] getParameters()