info.bliki.api.query
Class RequestBuilder

java.lang.Object
  extended by info.bliki.api.query.RequestBuilder
Direct Known Subclasses:
Edit, OpenSearch, Parse, Query, Sitematrix

public class RequestBuilder
extends java.lang.Object


Constructor Summary
RequestBuilder()
          Constructor sets the following default values: output format to 'xml' action to 'query'
 
Method Summary
 RequestBuilder action(java.lang.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(java.lang.String arg0)
           
 boolean containsValue(java.lang.String arg0)
           
static RequestBuilder create()
           
 java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()
           
 boolean equals(java.lang.Object arg0)
           
 RequestBuilder format(java.lang.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
 java.lang.String get(java.lang.String arg0)
           
 org.apache.commons.httpclient.NameValuePair[] getParameters()
           
 int hashCode()
           
 boolean isEmpty()
           
 java.util.Set<java.lang.String> keySet()
           
 RequestBuilder maxage(int maxage)
          Set the max-age header to this many seconds.
 RequestBuilder maxlag(int maxlag)
          Maximum lag
 java.lang.String put(java.lang.String arg0, java.lang.String arg1)
           
 void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> arg0)
           
 RequestBuilder putPipedString(java.lang.String parameter, int... pipedValues)
           
 RequestBuilder putPipedString(java.lang.String parameter, java.lang.String... pipedValues)
           
 java.lang.String remove(java.lang.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 java.lang.String toPipedString(int... pipedValues)
           
static java.lang.String toPipedString(java.lang.String... pipedValues)
          Utility method to convert an array of strings into a piped separated/formatted string
 java.lang.String toString()
           
 java.util.Collection<java.lang.String> values()
           
 RequestBuilder version(java.lang.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(java.lang.String arg0)

containsValue

public boolean containsValue(java.lang.String arg0)

entrySet

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

equals

public boolean equals(java.lang.Object arg0)
Overrides:
equals in class java.lang.Object

get

public java.lang.String get(java.lang.String arg0)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

keySet

public java.util.Set<java.lang.String> keySet()

put

public java.lang.String put(java.lang.String arg0,
                            java.lang.String arg1)

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> arg0)

remove

public java.lang.String remove(java.lang.String arg0)

size

public int size()

values

public java.util.Collection<java.lang.String> values()

create

public static RequestBuilder create()

format

public RequestBuilder format(java.lang.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(java.lang.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(java.lang.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(java.lang.String parameter,
                                     java.lang.String... pipedValues)

putPipedString

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

toPipedString

public static java.lang.String toPipedString(java.lang.String... pipedValues)
Utility method to convert an array of strings into a piped separated/formatted string

Parameters:
pipedValues -
Returns:

toPipedString

public static java.lang.String toPipedString(int... pipedValues)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getParameters

public org.apache.commons.httpclient.NameValuePair[] getParameters()


Copyright © 2012 Java Wikipedia API (Bliki engine). All Rights Reserved.