Wiki (Dexter Webapp 1.0.0 API)

java.lang.Object
- org.wikipedia.Wiki

All Implemented Interfaces:

Serializable
```
public class Wiki
extends Object
implements Serializable
```
This is a somewhat sketchy bot framework for editing MediaWiki wikis. Requires JDK 1.6 (6.0) or greater. Uses the MediaWiki API for most operations. It is recommended that the server runs the latest version of MediaWiki (1.20), otherwise some functions may not work.
Extended documentation is available here. All wikilinks are relative to the English Wikipedia and all timestamps are in your wiki's time zone.
Please file bug reports here (fast) or at the Google code bug tracker (slow).

Version:

0.27

Author:

MER-C and contributors

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Wiki.Gender` The list of options the user can specify for his/her gender.
`class`	`Wiki.LogEntry` A wrapper class for an entry in a wiki log, which represents an action performed on the wiki.
`class`	`Wiki.Revision` Represents a contribution and/or a revision to a page.
`class`	`Wiki.User` Subclass for wiki users.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_LOGS` Denotes all logs.
`static int`	`ALL_NAMESPACES` Denotes all namespaces.
`protected String`	`apiUrl`
`static int`	`ASSERT_BOT` Assert that we have a bot flag (i.e.
`static int`	`ASSERT_NO_MESSAGES` Assert that we have no new messages.
`static int`	`ASSERT_NONE` Use no assertions (i.e.
`protected String`	`base`
`static String`	`BLOCK_LOG` Denotes the block log.
`static int`	`CATEGORY_NAMESPACE` Denotes the namespace for category description pages.
`static int`	`CATEGORY_TALK_NAMESPACE` Denotes the namespace for talk pages regarding categories.
`static long`	`CURRENT_REVISION` In `Revision.diff()`, denotes the current revision.
`static String`	`DELETION_LOG` Denotes the deletion log.
`static int`	`FILE_NAMESPACE` Denotes the namespace for image/file description pages.
`static int`	`FILE_TALK_NAMESPACE` Denotes talk pages for image description pages.
`static String`	`FULL_PROTECTION` Denotes full protection (i.e.
`static int`	`HELP_NAMESPACE` Denotes the namespace for help pages, given the prefix "Help:".
`static int`	`HELP_TALK_NAMESPACE` Denotes the namespace for talk pages regarding help pages, given the prefix "Help talk:".
`static int`	`HIDE_ANON` In queries against the recent changes table, this would mean we don't fetch anonymous edits.
`static int`	`HIDE_BOT` In queries against the recent changes table, this would mean we don't fetch edits made by bots.
`static int`	`HIDE_MINOR` In queries against the recent changes table, this would mean we don't fetch minor edits.
`static int`	`HIDE_PATROLLED` In queries against the recent changes table, this would mean we don't fetch patrolled edits.
`static int`	`HIDE_SELF` In queries against the recent changes table, this would mean we don't fetch by the logged in user.
`static int`	`IMAGE_NAMESPACE` Deprecated. use FILE_NAMESPACE
`static int`	`IMAGE_TALK_NAMESPACE` Deprecated. use FILE_TALK_NAMESPACE
`static String`	`IMPORT_LOG` Denotes the page importation log.
`protected static Logger`	`logger`
`static int`	`MAIN_NAMESPACE` Denotes the main namespace, with no prefix.
`static int`	`MEDIA_NAMESPACE` Denotes the namespace of images and media, such that there is no description page.
`static int`	`MEDIAWIKI_NAMESPACE` Denotes the namespace for (wiki) system messages, given the prefix "MediaWiki:".
`static int`	`MEDIAWIKI_TALK_NAMESPACE` Denotes the namespace for talk pages relating to system messages, given the prefix "MediaWiki talk:".
`static String`	`MOVE_LOG` Denotes the move log.
`static long`	`NEXT_REVISION` In `Revision.diff()`, denotes the next revision.
`static String`	`NO_PROTECTION` Denotes a non-protected page.
`static String`	`PATROL_LOG` Denotes the edit patrol log.
`static long`	`PREVIOUS_REVISION` In `Revision.diff()`, denotes the previous revision.
`static int`	`PROJECT_NAMESPACE` Denotes the namespace for pages relating to the project, with prefix "Project:".
`static int`	`PROJECT_TALK_NAMESPACE` Denotes the namespace for talk pages relating to project pages, with prefix "Project talk:".
`static String`	`PROTECTION_LOG` Denotes the protection log.
`protected String`	`query`
`protected String`	`scriptPath`
`static String`	`SEMI_PROTECTION` Denotes semi-protection (i.e.
`static int`	`SPECIAL_NAMESPACE` Denotes the namespace of pages with the "Special:" prefix.
`static int`	`TALK_NAMESPACE` Denotes the namespace for talk pages relating to the main namespace, denoted by the prefix "Talk:".
`static int`	`TEMPLATE_NAMESPACE` Denotes the namespace for templates, given the prefix "Template:".
`static int`	`TEMPLATE_TALK_NAMESPACE` Denotes the namespace for talk pages regarding templates, given the prefix "Template talk:".
`static String`	`UPLOAD_LOG` Denotes the upload log.
`static String`	`USER_CREATION_LOG` Denotes the user creation log.
`static int`	`USER_NAMESPACE` Denotes the namespace for user pages, given the prefix "User:".
`static String`	`USER_RENAME_LOG` Denotes the user renaming log.
`static String`	`USER_RIGHTS_LOG` Denotes the user rights log.
`static int`	`USER_TALK_NAMESPACE` Denotes the namespace for user talk pages, given the prefix "User talk:".

Constructor Summary

Constructors
Constructor and Description
`Wiki()` Creates a new connection to the English Wikipedia.
`Wiki(String domain)` Creates a new connection to a wiki.
`Wiki(String domain, String scriptPath)` Creates a new connection to a wiki with $wgScriptpath set to `scriptPath`.

Method Summary

Methods
Modifier and Type	Method and Description
`String[]`	`allUsers(String start, int number)` Gets the specified number of users (as a String) starting at the given string, in alphabetical order.
`String[]`	`allUsers(String start, int number, String prefix)` Gets the specified number of users (as a String) starting at the given string, in alphabetical order.
`String[]`	`allUsersWithPrefix(String prefix)` Returns all usernames with the given prefix.
`protected String`	`calendarToTimestamp(Calendar c)` Turns a calendar into a timestamp of the format yyyymmddhhmmss.
`protected void`	`checkErrors(String line, String caller)` Checks for errors from standard read/write requests.
`protected boolean`	`checkRights(HashMap<String,Object> pageinfo, String action)` Checks whether the currently logged on user has sufficient rights to edit/move a protected page.
`protected void`	`constructNamespaceString(StringBuilder sb, String id, int... namespaces)` Convenience method for converting a namespace list into String form.
`Wiki.Revision[]`	`contribs(String user, int... ns)` Gets the contributions of a user in a particular namespace.
`Wiki.Revision[]`	`contribs(String user, String prefix, Calendar end, Calendar start, int... ns)` Gets the contributions for a user, an IP address or a range of IP addresses.
`protected String`	`convertTimestamp(String timestamp)` Converts a timestamp of the form used by the API (yyyy-mm-ddThh:mm:ssZ) to the form yyyymmddhhmmss, which can be fed into `timestampToCalendar()`.
`protected String`	`decode(String in)` Strips entity references like " from the supplied string.
`void`	`delete(String title, String reason)` Deletes a page.
`void`	`edit(String title, String text, String summary)` Edits a page by setting its text to the supplied value.
`void`	`edit(String title, String text, String summary, boolean minor, boolean bot, int section, Calendar basetime)` Edits a page by setting its text to the supplied value.
`void`	`edit(String title, String text, String summary, Calendar basetime)` Edits a page by setting its text to the supplied value.
`void`	`edit(String title, String text, String summary, int section)` Edits a page by setting its text to the supplied value.
`void`	`edit(String title, String text, String summary, int section, Calendar basetime)` Edits a page by setting its text to the supplied value.
`void`	`emailUser(Wiki.User user, String message, String subject, boolean emailme)` Sends an email message to a user in a similar manner to [[Special:Emailuser]].
`boolean`	`equals(Object obj)` Determines whether this wiki is equal to another object.
`boolean[]`	`exists(String... titles)` Determines whether a series of pages exist.
`String`	`export(String title)` Exports the current revision of this page.
`protected String`	`fetch(String url, String caller)` A generic URL content fetcher.
`int`	`getAssertionMode()` Gets the assertion mode.
`String[]`	`getCategories(String title)` Gets the list of categories a particular page is in.
`String[]`	`getCategoryMembers(String name, boolean subcat, int... ns)` Gets the members of a category.
`String[]`	`getCategoryMembers(String name, int... ns)` Gets the members of a category.
`int`	`getCurrentDatabaseLag()` Determines the current database replication lag.
`Wiki.User`	`getCurrentUser()` Gets the user we are currently logged in as.
`String`	`getDomain()` Gets the domain of the wiki, as supplied on construction.
`String[]`	`getDuplicates(String file)` Gets duplicates of this file.
`HashMap<String,Object>`	`getFileMetadata(String file)` Gets the file metadata for a file.
`Wiki.Revision`	`getFirstRevision(String title)` Gets the first revision of a page, or null if the page does not exist.
`byte[]`	`getImage(String title)` Fetches an image file and returns the image data in a `byte[]`.
`byte[]`	`getImage(String title, int width, int height)` Fetches a thumbnail of an image file and returns the image data in a `byte[]`.
`Wiki.LogEntry[]`	`getImageHistory(String title)` Returns the upload history of an image.
`String[]`	`getImagesOnPage(String title)` Gets the list of images used on a particular page.
`String[][]`	`getInterWikiBacklinks(String prefix)` Fetches all pages that use interwiki links to the specified wiki and the page on that wiki that is linked to.
`String[][]`	`getInterWikiBacklinks(String prefix, String title)` Fetches all pages that use interwiki links with a certain `prefix` and `title`.
`HashMap<String,String>`	`getInterWikiLinks(String title)` Gets the list of interwiki links a particular page has.
`Wiki.LogEntry[]`	`getIPBlockList(Calendar start, Calendar end)` Lists currently operating blocks that were made in the specified interval.
`Wiki.LogEntry[]`	`getIPBlockList(String user)` Looks up a particular user in the IP block list, i.e.
`protected Wiki.LogEntry[]`	`getIPBlockList(String user, Calendar start, Calendar end)` Fetches part of the list of currently operational blocks.
`String[]`	`getLinksOnPage(String title)` Gets the list of links used on a particular page.
`Wiki.LogEntry[]`	`getLogEntries(Calendar start, Calendar end)` Gets all log entries that occurred between the specified dates.
`Wiki.LogEntry[]`	`getLogEntries(Calendar start, Calendar end, int amount, String log, String action, Wiki.User user, String target, int namespace)` Gets the specified amount of log entries between the given times by the given user on the given target.
`Wiki.LogEntry[]`	`getLogEntries(int amount)` Gets the most recent set of log entries up to the given amount.
`Wiki.LogEntry[]`	`getLogEntries(int amount, String type, String action)` Gets the last how ever many log entries in the specified log.
`Wiki.LogEntry[]`	`getLogEntries(String target)` Gets the log entries representing actions that were performed on a specific target.
`Wiki.LogEntry[]`	`getLogEntries(Wiki.User user)` Gets log entries for a specific user.
`int`	`getMaxLag()` Gets the maxlag parameter.
`HashMap<String,Integer>`	`getNamespaces()` Gets the namespaces used by this wiki.
`byte[]`	`getOldImage(Wiki.LogEntry entry)` Gets an old image revision and returns the image data in a `byte[]`.
`Wiki.Revision[]`	`getPageHistory(String title)` Gets the entire revision history of a page.
`Wiki.Revision[]`	`getPageHistory(String title, Calendar start, Calendar end)` Gets the revision history of a page between two dates.
`HashMap`	`getPageInfo(String page)` Gets miscellaneous page info.
`HashMap[]`	`getPageInfo(String[] pages)` Gets miscellaneous page info.
`String`	`getPageText(String title)` Gets the raw wikicode for a page.
`String[]`	`getRawWatchlist()` Fetches the list of titles on the currently logged in user's watchlist.
`String[]`	`getRawWatchlist(boolean cache)` Fetches the list of titles on the currently logged in user's watchlist.
`String`	`getRenderedText(String title)` Gets the contents of a page, rendered in HTML (as opposed to wikitext).
`Wiki.Revision`	`getRevision(long oldid)` Gets a revision based on a given oldid.
`String`	`getScriptPath()` Detects the $wgScriptpath wiki variable and sets the bot framework up to use it.
`LinkedHashMap<String,String>`	`getSectionMap(String page)` Gets the list of sections on a particular page.
`String`	`getSectionText(String title, int number)` Gets the text of a specific section.
`HashMap<String,Integer>`	`getSiteStatistics()` Fetches some site statistics, namely the number of articles, pages, files, edits, users and admins.
`int`	`getStatusCheckInterval()` Gets the number of actions (edit, move, block, delete, etc) between status checks.
`String`	`getTalkPage(String title)` Returns the corresponding talk page to this page.
`String[]`	`getTemplates(String title, int... ns)` Gets the list of templates used on a particular page that are in a particular namespace(s).
`int`	`getThrottle()` Gets the editing throttle.
`Wiki.Revision`	`getTopRevision(String title)` Gets the most recent revision of a page, or null if the page does not exist.
`Wiki.LogEntry[]`	`getUploads(Wiki.User user)` Gets the uploads of a user.
`Wiki.LogEntry[]`	`getUploads(Wiki.User user, Calendar start, Calendar end)` Gets the uploads of a user between the specified times.
`Wiki.User`	`getUser(String username)` Gets the user with the given username.
`String`	`getUserAgent()` Gets the user agent HTTP header to be used for requests.
`int`	`hashCode()` Returns a hash code of this object.
`boolean`	`hasNewMessages()` Determines whether the current user has new messages.
`String[]`	`imageUsage(String image, int... ns)` Returns a list of pages in the specified namespaces which use the specified image.
`protected void`	`initVars()` Override/edit this if you need to change the API and human interface url configuration of the wiki.
`static String[]`	`intersection(String[] a, String[] b)` Determines the intersection of two lists of pages a and b.
`boolean`	`isMarkBot()` Are edits are marked as bot by default?
`boolean`	`isMarkMinor()` Are edits are marked as minor by default?
`boolean`	`isResolvingRedirects()` Checks whether API action=query dependencies automatically resolve redirects (default = false).
`boolean`	`isUsingCompressedRequests()` Checks whether we are using GZip compression for GET requests.
`boolean`	`isWatched(String title)` Determines whether a page is watched.
`ArrayList[]`	`linksearch(String pattern)` Searches the wiki for external links.
`ArrayList[]`	`linksearch(String pattern, String protocol, int... ns)` Searches the wiki for external links.
`String[]`	`listPages(String prefix, HashMap<String,Object> protectionstate, int namespace)` Lists pages with titles containing a certain prefix with a certain protection state and in a certain namespace.
`String[]`	`listPages(String prefix, HashMap<String,Object> protectionstate, int namespace, int minimum, int maximum)` Lists pages with titles containing a certain prefix with a certain protection state and in a certain namespace.
`protected void`	`log(Level level, String text, String method)` Logs a successful result.
`void`	`login(String username, char[] password)` Logs in to the wiki.
`void`	`login(String username, String password)`
`void`	`logout()` Logs out of the wiki.
`void`	`logoutServerSide()` Logs out of the wiki and destroys the session on the server.
`protected void`	`logurl(String url, String method)` Logs a url fetch.
`String[]`	`longPages(int cutoff)` List pages above a certain size in the main namespace.
`String[]`	`longPages(int cutoff, int namespace)` List pages above a certain size in any namespace.
`Calendar`	`makeCalendar()` Creates a Calendar object with the current time.
`void`	`move(String title, String newTitle, String reason)` Moves a page.
`void`	`move(String title, String newTitle, String reason, boolean noredirect, boolean movetalk, boolean movesubpages)` Moves a page.
`protected String`	`multipartPost(String url, Map<String,?> params, String caller)` Performs a multi-part HTTP POST.
`int`	`namespace(String title)` Returns the namespace a set of pages is in.
`int[]`	`namespace(String[] titles)` Returns the namespace a set of pages is in.
`String`	`namespaceIdentifier(int namespace)` For a given namespace denoted as an integer, fetch the corresponding identification string e.g.
`Wiki.Revision[]`	`newPages(int amount)` Fetches the `amount` most recently created pages in the main namespace.
`Wiki.Revision[]`	`newPages(int amount, int rcoptions)` Fetches the `amount` most recently created pages in the main namespace subject to the specified constraints.
`Wiki.Revision[]`	`newPages(int amount, int rcoptions, int... ns)` Fetches the `amount` most recently created pages in the specified namespace, subject to the specified constraints.
`void`	`newSection(String title, String subject, String text, boolean minor, boolean bot)` Creates a new section on the specified page.
`String`	`normalize(String s)` Convenience method for normalizing MediaWiki titles.
`String`	`parse(String markup)` Renders the specified wiki markup by passing it to the MediaWiki parser through the API.
`protected String`	`parseAndCleanup(String in)` Same as `parse()`, but also strips out unwanted crap.
`protected Wiki.LogEntry`	`parseLogEntry(String xml)` Parses xml generated by `getLogEntries()`, `getImageHistory()` and `getIPBlockList()` into LogEntry objects.
`protected Wiki.Revision`	`parseRevision(String xml, String title)` Parses stuff of the form `title="L.`
`protected void`	`populateNamespaceCache()` Populates the namespace cache.
`protected String`	`post(String url, String text, String caller)` Does a text-only HTTP POST.
`String[]`	`prefixIndex(String prefix)` Lists pages that start with a given prefix.
`void`	`prepend(String title, String stuff, String summary, boolean minor, boolean bot)` Prepends something to the given page.
`void`	`protect(String page, HashMap<String,Object> protectionstate)` Protects a page.
`void`	`purge(boolean links, String... titles)` Purges the server-side cache for various pages.
`String[]`	`queryPage(String page)` Fetches data from one of a set of miscellaneous special pages.
`String`	`random()` Fetches a random page in the main namespace.
`String`	`random(int... ns)` Fetches a random page in the specified namespace.
`Wiki.Revision[]`	`rangeContribs(String range)` Deprecated. doesn't support IPv6, and I am way too lazy to make it do so
`Wiki.Revision[]`	`recentChanges(int amount)` Fetches the `amount` most recent changes in the main namespace.
`Wiki.Revision[]`	`recentChanges(int amount, int... ns)` Fetches the `amount` most recent changes in the specified namespace.
`protected Wiki.Revision[]`	`recentChanges(int amount, int rcoptions, boolean newpages, int... ns)` Fetches the `amount` most recent changes in the specified namespace subject to the specified constraints.
`Wiki.Revision[]`	`recentChanges(int amount, int rcoptions, int... ns)` Fetches the `amount` most recent changes in the specified namespace subject to the specified constraints.
`static String[]`	`relativeComplement(String[] a, String[] b)` Determines the list of articles that are in a but not b, i.e.
`void`	`rollback(Wiki.Revision revision)` Reverts a series of edits on the same page by the same user quickly provided that they are the most recent revisions on that page.
`void`	`rollback(Wiki.Revision revision, boolean bot, String reason)` Reverts a series of edits on the same page by the same user quickly provided that they are the most recent revisions on that page.
`String[][]`	`search(String search, int... namespaces)` Performs a full text search of the wiki.
`void`	`setAssertionMode(int mode)` Sets the assertion mode.
`protected void`	`setCookies(URLConnection u)` Sets cookies to an unconnected URLConnection and enables gzip compression of returned text.
`void`	`setLogLevel(Level level)` Deprecated. `logger` is now protected, can call setLevel there
`void`	`setMarkBot(boolean markbot)` Sets whether edits are marked as bot by default (may be overridden specifically by edit()).
`void`	`setMarkMinor(boolean minor)` Sets whether edits are marked as minor by default (may be overridden specifically by edit()).
`void`	`setMaxLag(int lag)` Sets the maxlag parameter.
`void`	`setResolveRedirects(boolean b)` Sets whether API action=query dependencies automatically resolve redirects (default = false).
`void`	`setStatusCheckInterval(int interval)` Sets the number of actions (edit, move, block, delete, etc) between status checks.
`void`	`setThrottle(int throttle)` Sets the editing throttle.
`void`	`setUserAgent(String useragent)` Sets the user agent HTTP header to be used for requests.
`void`	`setUsingCompressedRequests(boolean zipped)` Enables/disables GZip compression for GET requests.
`String[]`	`shortPages(int cutoff)` List pages below a certain size in the main namespace.
`String[]`	`shortPages(int cutoff, int namespace)` List pages below a certain size in any namespace.
`protected void`	`statusCheck()` Performs a status check, including assertions.
`protected Calendar`	`timestampToCalendar(String timestamp)` Turns a timestamp of the format yyyymmddhhmmss into a Calendar object.
`String`	`toString()` Returns a string representation of this Wiki.
`void`	`undo(Wiki.Revision rev, Wiki.Revision to, String reason, boolean minor, boolean bot)` Undoes revisions, equivalent to the "undo" button in the GUI page history.
`void`	`unprotect(String page)` Completely unprotects a page.
`void`	`unwatch(String... titles)` Removes pages from the watchlist.
`void`	`upload(File file, String filename, String contents, String reason)` Uploads an image.
`boolean`	`userExists(String username)` Determines whether a specific user exists.
`String`	`version()` Gets the version of MediaWiki this wiki runs e.g.
`void`	`watch(String... titles)` Adds a page to the watchlist.
`protected void`	`watchInternal(boolean unwatch, String... titles)` Internal method for interfacing with the watchlist, since the API URLs for (un)watching are very similar.
`Wiki.Revision[]`	`watchlist()` Fetches the most recent changes to pages on your watchlist.
`Wiki.Revision[]`	`watchlist(boolean allrev, int... ns)` Fetches recent changes to pages on your watchlist.
`String[]`	`whatLinksHere(String title, boolean redirects, int... ns)` Returns a list of all pages linking to this page within the specified namespaces.
`String[]`	`whatLinksHere(String title, int... ns)` Returns a list of all pages linking to this page.
`String[]`	`whatTranscludesHere(String title, int... ns)` Returns a list of all pages transcluding to a page within the specified namespaces.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MEDIA_NAMESPACE
```
public static final int MEDIA_NAMESPACE
```
    Denotes the namespace of images and media, such that there is no description page. Uses the "Media:" prefix.
    
    Since:
    
    0.03
    
    See Also:
    FILE_NAMESPACE, Constant Field Values
  - SPECIAL_NAMESPACE
```
public static final int SPECIAL_NAMESPACE
```
    Denotes the namespace of pages with the "Special:" prefix. Note that many methods dealing with special pages may spew due to raw content not being available.
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - MAIN_NAMESPACE
```
public static final int MAIN_NAMESPACE
```
    Denotes the main namespace, with no prefix.
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - TALK_NAMESPACE
```
public static final int TALK_NAMESPACE
```
    Denotes the namespace for talk pages relating to the main namespace, denoted by the prefix "Talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - USER_NAMESPACE
```
public static final int USER_NAMESPACE
```
    Denotes the namespace for user pages, given the prefix "User:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - USER_TALK_NAMESPACE
```
public static final int USER_TALK_NAMESPACE
```
    Denotes the namespace for user talk pages, given the prefix "User talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - PROJECT_NAMESPACE
```
public static final int PROJECT_NAMESPACE
```
    Denotes the namespace for pages relating to the project, with prefix "Project:". It also goes by the name of whatever the project name was.
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - PROJECT_TALK_NAMESPACE
```
public static final int PROJECT_TALK_NAMESPACE
```
    Denotes the namespace for talk pages relating to project pages, with prefix "Project talk:". It also goes by the name of whatever the project name was, + "talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - FILE_NAMESPACE
```
public static final int FILE_NAMESPACE
```
    Denotes the namespace for image/file description pages. Has the prefix prefix "File:". Do not create these directly, use upload() instead. (This namespace used to have the prefix "Image:", hence the name.)
    
    Since:
    
    0.25
    
    See Also:
    MEDIA_NAMESPACE, Constant Field Values
  - FILE_TALK_NAMESPACE
```
public static final int FILE_TALK_NAMESPACE
```
    Denotes talk pages for image description pages. Has the prefix "File talk:".
    
    Since:
    
    0.25
    
    See Also:
    Constant Field Values
  - IMAGE_NAMESPACE
```
@Deprecated
public static final int IMAGE_NAMESPACE
```
    Deprecated. use FILE_NAMESPACE
    
    Denotes the namespace for image/file description pages. Has the prefix prefix "File:". Do not create these directly, use upload() instead. (This namespace used to have the prefix "Image:", hence the name.)
    
    Since:
    
    0.03
    
    See Also:
    MEDIA_NAMESPACE, Constant Field Values
  - IMAGE_TALK_NAMESPACE
```
@Deprecated
public static final int IMAGE_TALK_NAMESPACE
```
    Deprecated. use FILE_TALK_NAMESPACE
    
    Denotes talk pages for image description pages. Has the prefix "File talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - MEDIAWIKI_NAMESPACE
```
public static final int MEDIAWIKI_NAMESPACE
```
    Denotes the namespace for (wiki) system messages, given the prefix "MediaWiki:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - MEDIAWIKI_TALK_NAMESPACE
```
public static final int MEDIAWIKI_TALK_NAMESPACE
```
    Denotes the namespace for talk pages relating to system messages, given the prefix "MediaWiki talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - TEMPLATE_NAMESPACE
```
public static final int TEMPLATE_NAMESPACE
```
    Denotes the namespace for templates, given the prefix "Template:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - TEMPLATE_TALK_NAMESPACE
```
public static final int TEMPLATE_TALK_NAMESPACE
```
    Denotes the namespace for talk pages regarding templates, given the prefix "Template talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - HELP_NAMESPACE
```
public static final int HELP_NAMESPACE
```
    Denotes the namespace for help pages, given the prefix "Help:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - HELP_TALK_NAMESPACE
```
public static final int HELP_TALK_NAMESPACE
```
    Denotes the namespace for talk pages regarding help pages, given the prefix "Help talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - CATEGORY_NAMESPACE
```
public static final int CATEGORY_NAMESPACE
```
    Denotes the namespace for category description pages. Has the prefix "Category:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - CATEGORY_TALK_NAMESPACE
```
public static final int CATEGORY_TALK_NAMESPACE
```
    Denotes the namespace for talk pages regarding categories. Has the prefix "Category talk:".
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - ALL_NAMESPACES
```
public static final int ALL_NAMESPACES
```
    Denotes all namespaces.
    
    Since:
    
    0.03
    
    See Also:
    Constant Field Values
  - ALL_LOGS
```
public static final String ALL_LOGS
```
    Denotes all logs.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - USER_CREATION_LOG
```
public static final String USER_CREATION_LOG
```
    Denotes the user creation log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - UPLOAD_LOG
```
public static final String UPLOAD_LOG
```
    Denotes the upload log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - DELETION_LOG
```
public static final String DELETION_LOG
```
    Denotes the deletion log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - MOVE_LOG
```
public static final String MOVE_LOG
```
    Denotes the move log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - BLOCK_LOG
```
public static final String BLOCK_LOG
```
    Denotes the block log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - PROTECTION_LOG
```
public static final String PROTECTION_LOG
```
    Denotes the protection log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - USER_RIGHTS_LOG
```
public static final String USER_RIGHTS_LOG
```
    Denotes the user rights log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - USER_RENAME_LOG
```
public static final String USER_RENAME_LOG
```
    Denotes the user renaming log.
    
    Since:
    
    0.06
    
    See Also:
    Constant Field Values
  - IMPORT_LOG
```
public static final String IMPORT_LOG
```
    Denotes the page importation log.
    
    Since:
    
    0.08
    
    See Also:
    Constant Field Values
  - PATROL_LOG
```
public static final String PATROL_LOG
```
    Denotes the edit patrol log.
    
    Since:
    
    0.08
    
    See Also:
    Constant Field Values
  - NO_PROTECTION
```
public static final String NO_PROTECTION
```
    Denotes a non-protected page.
    
    Since:
    
    0.09
    
    See Also:
    Constant Field Values
  - SEMI_PROTECTION
```
public static final String SEMI_PROTECTION
```
    Denotes semi-protection (i.e. only autoconfirmed users can perform a particular action).
    
    Since:
    
    0.09
    
    See Also:
    Constant Field Values
  - FULL_PROTECTION
```
public static final String FULL_PROTECTION
```
    Denotes full protection (i.e. only admins can perfom a particular action).
    
    Since:
    
    0.09
    
    See Also:
    Constant Field Values
  - ASSERT_NONE
```
public static final int ASSERT_NONE
```
    Use no assertions (i.e. 0).
    
    Since:
    
    0.11
    
    See Also:
    setAssertionMode(int), Constant Field Values
  - ASSERT_BOT
```
public static final int ASSERT_BOT
```
    Assert that we have a bot flag (i.e. 2).
    
    Since:
    
    0.11
    
    See Also:
    setAssertionMode(int), Constant Field Values
  - ASSERT_NO_MESSAGES
```
public static final int ASSERT_NO_MESSAGES
```
    Assert that we have no new messages. Not defined in Assert Edit, but some bots have this.
    
    Since:
    
    0.11
    
    See Also:
    setAssertionMode(int), Constant Field Values
  - HIDE_ANON
```
public static final int HIDE_ANON
```
    In queries against the recent changes table, this would mean we don't fetch anonymous edits.
    
    Since:
    
    0.20
    
    See Also:
    Constant Field Values
  - HIDE_BOT
```
public static final int HIDE_BOT
```
    In queries against the recent changes table, this would mean we don't fetch edits made by bots.
    
    Since:
    
    0.20
    
    See Also:
    Constant Field Values
  - HIDE_SELF
```
public static final int HIDE_SELF
```
    In queries against the recent changes table, this would mean we don't fetch by the logged in user.
    
    Since:
    
    0.20
    
    See Also:
    Constant Field Values
  - HIDE_MINOR
```
public static final int HIDE_MINOR
```
    In queries against the recent changes table, this would mean we don't fetch minor edits.
    
    Since:
    
    0.20
    
    See Also:
    Constant Field Values
  - HIDE_PATROLLED
```
public static final int HIDE_PATROLLED
```
    In queries against the recent changes table, this would mean we don't fetch patrolled edits.
    
    Since:
    
    0.20
    
    See Also:
    Constant Field Values
  - NEXT_REVISION
```
public static final long NEXT_REVISION
```
    In Revision.diff(), denotes the next revision.
    
    Since:
    
    0.21
    
    See Also:
    Wiki.Revision.diff(org.wikipedia.Wiki.Revision), Constant Field Values
  - CURRENT_REVISION
```
public static final long CURRENT_REVISION
```
    In Revision.diff(), denotes the current revision.
    
    Since:
    
    0.21
    
    See Also:
    Wiki.Revision.diff(org.wikipedia.Wiki.Revision), Constant Field Values
  - PREVIOUS_REVISION
```
public static final long PREVIOUS_REVISION
```
    In Revision.diff(), denotes the previous revision.
    
    Since:
    
    0.21
    
    See Also:
    Wiki.Revision.diff(org.wikipedia.Wiki.Revision), Constant Field Values
  - query
```
protected String query
```
  - base
```
protected String base
```
  - apiUrl
```
protected String apiUrl
```
  - scriptPath
```
protected String scriptPath
```
  - logger
```
protected static final Logger logger
```
- Constructor Detail
  - Wiki
```
public Wiki()
```
    Creates a new connection to the English Wikipedia.
    
    Since:
    
    0.02
  - Wiki
```
public Wiki(String domain)
```
    Creates a new connection to a wiki. WARNING: if the wiki uses a $wgScriptpath other than the default /w, you need to call getScriptPath() to automatically set it. Alternatively, you can use the constructor below if you know it in advance.
    
    Parameters:
    domain - the wiki domain name e.g. en.wikipedia.org (defaults to en.wikipedia.org)
  - Wiki
```
public Wiki(String domain,
    String scriptPath)
```
    Creates a new connection to a wiki with $wgScriptpath set to scriptPath.
    
    Parameters:
    domain - the wiki domain name
    scriptPath - the script path
    Since:
    
    0.14
- Method Detail
  - initVars
```
protected void initVars()
```
    Override/edit this if you need to change the API and human interface url configuration of the wiki. Some example uses: *Using HTTPS on Wikimedia sites *Server-side cache management (maxage and smaxage API parameters)
    
    Contributed by Tedder
    
    Since:
    
    0.24
  - getDomain
```
public String getDomain()
```
    Gets the domain of the wiki, as supplied on construction.
    
    Returns:
    the domain of the wiki
    Since:
    
    0.06
  - getThrottle
```
public int getThrottle()
```
    Gets the editing throttle.
    
    Returns:
    the throttle value in milliseconds
    Since:
    
    0.09
    
    See Also:
    setThrottle(int)
  - setThrottle
```
public void setThrottle(int throttle)
```
    Sets the editing throttle. Read requests are not throttled or restricted in any way. Default is 10s.
    
    Parameters:
    throttle - the new throttle value in milliseconds
    Since:
    
    0.09
    
    See Also:
    getThrottle()
  - getScriptPath
```
public String getScriptPath()
                     throws IOException
```
    Detects the $wgScriptpath wiki variable and sets the bot framework up to use it. You need not call this if you know the script path is /w . See also [[mw:Manual:$wgScriptpath]].
    
    Returns:
    the script path, if you have any use for it
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.14
  - setUserAgent
```
public void setUserAgent(String useragent)
```
    Sets the user agent HTTP header to be used for requests. Default is "Wiki.java " + version.
    
    Parameters:
    useragent - the new user agent
    Since:
    
    0.22
  - getUserAgent
```
public String getUserAgent()
```
    Gets the user agent HTTP header to be used for requests. Default is "Wiki.java " + version.
    
    Returns:
    useragent the user agent
    Since:
    
    0.22
  - setUsingCompressedRequests
```
public void setUsingCompressedRequests(boolean zipped)
```
    Enables/disables GZip compression for GET requests. Default: true.
    
    Parameters:
    zipped - whether we use GZip compression
    Since:
    
    0.23
  - isUsingCompressedRequests
```
public boolean isUsingCompressedRequests()
```
    Checks whether we are using GZip compression for GET requests. Default: true.
    
    Returns:
    (see above)
    Since:
    
    0.23
  - isResolvingRedirects
```
public boolean isResolvingRedirects()
```
    Checks whether API action=query dependencies automatically resolve redirects (default = false).
    
    Returns:
    (see above)
    Since:
    
    0.27
  - setResolveRedirects
```
public void setResolveRedirects(boolean b)
```
    Sets whether API action=query dependencies automatically resolve redirects (default = false).
    
    Parameters:
    b - (see above)
    Since:
    
    0.27
  - setMarkBot
```
public void setMarkBot(boolean markbot)
```
    Sets whether edits are marked as bot by default (may be overridden specifically by edit()). Default = false. Works only if one has the required permissions.
    
    Parameters:
    markbot - (see above)
    Since:
    
    0.26
  - isMarkBot
```
public boolean isMarkBot()
```
    Are edits are marked as bot by default?
    
    Returns:
    whether edits are marked as bot by default
    Since:
    
    0.26
  - setMarkMinor
```
public void setMarkMinor(boolean minor)
```
    Sets whether edits are marked as minor by default (may be overridden specifically by edit()). Default = false.
    
    Parameters:
    minor - (see above)
    Since:
    
    0.26
  - isMarkMinor
```
public boolean isMarkMinor()
```
    Are edits are marked as minor by default?
    
    Returns:
    whether edits are marked as minor by default
    Since:
    
    0.26
  - equals
```
public boolean equals(Object obj)
```
    Determines whether this wiki is equal to another object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare
    
    Returns:
    whether this wiki is equal to such object
    Since:
    
    0.10
  - hashCode
```
public int hashCode()
```
    Returns a hash code of this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code
    Since:
    
    0.12
  - toString
```
public String toString()
```
    Returns a string representation of this Wiki.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this Wiki.
    Since:
    
    0.10
  - getMaxLag
```
public int getMaxLag()
```
    Gets the maxlag parameter. See [[mw:Manual:Maxlag parameter]].
    
    Returns:
    the current maxlag, in seconds
    Since:
    
    0.11
    
    See Also:
    setMaxLag(int), getCurrentDatabaseLag()
  - setMaxLag
```
public void setMaxLag(int lag)
```
    Sets the maxlag parameter. A value of less than 0s disables this mechanism. Default is 5s.
    
    Parameters:
    lag - the desired maxlag in seconds
    Since:
    
    0.11
    
    See Also:
    getMaxLag(), getCurrentDatabaseLag()
  - getAssertionMode
```
public int getAssertionMode()
```
    Gets the assertion mode. See [[mw:Extension:Assert Edit]] for what functionality this mimics. Assertion modes are bitmasks.
    
    Returns:
    the current assertion mode
    Since:
    
    0.11
    
    See Also:
    setAssertionMode(int)
  - setAssertionMode
```
public void setAssertionMode(int mode)
```
    Sets the assertion mode. See [[mw:Extension:Assert Edit]] for what this functionality this mimics. Assertion modes are bitmasks. Default is ASSERT_NONE.
    
    Parameters:
    mode - an assertion mode
    Since:
    
    0.11
    
    See Also:
    getAssertionMode()
  - getStatusCheckInterval
```
public int getStatusCheckInterval()
```
    Gets the number of actions (edit, move, block, delete, etc) between status checks. A status check is where we update user rights, block status and check for new messages (if the appropriate assertion mode is set).
    
    Returns:
    the number of edits between status checks
    Since:
    
    0.18
    
    See Also:
    setStatusCheckInterval(int)
  - setStatusCheckInterval
```
public void setStatusCheckInterval(int interval)
```
    Sets the number of actions (edit, move, block, delete, etc) between status checks. A status check is where we update user rights, block status and check for new messages (if the appropriate assertion mode is set). Default is 100.
    
    Parameters:
    interval - the number of edits between status checks
    Since:
    
    0.18
    
    See Also:
    getStatusCheckInterval()
  - login
```
public void login(String username,
         char[] password)
           throws IOException,
                  FailedLoginException
```
    Logs in to the wiki. This method is thread-safe. If the specified username or password is incorrect, the thread blocks for 20 seconds then throws an exception.
    
    Parameters:
    username - a username
    password - a password (as a char[] due to JPasswordField)
    
    Throws:
    
    FailedLoginException - if the login failed due to incorrect username and/or password
    
    IOException - if a network error occurs
    See Also:
    logout()
  - login
```
public void login(String username,
         String password)
           throws IOException,
                  FailedLoginException
```
    Throws:
    
    IOException
    
    FailedLoginException
  - logout
```
public void logout()
```
    Logs out of the wiki. This method is thread safe (so that we don't log out during an edit). All operations are conducted offline, so you can serialize this Wiki first.
    
    See Also:
    login(java.lang.String, char[]), logoutServerSide()
  - logoutServerSide
```
public void logoutServerSide()
                      throws IOException
```
    Logs out of the wiki and destroys the session on the server. You will need to log in again instead of just reading in a serialized wiki. Equivalent to [[Special:Userlogout]]. This method is thread safe (so that we don't log out during an edit). WARNING: kills all concurrent sessions - if you are logged in with a browser this will log you out there as well.
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.14
    
    See Also:
    login(java.lang.String, char[]), logout()
  - hasNewMessages
```
public boolean hasNewMessages()
                       throws IOException
```
    Determines whether the current user has new messages. (A human would notice a yellow bar at the top of the page).
    
    Returns:
    whether the user has new messages
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.11
  - getCurrentDatabaseLag
```
public int getCurrentDatabaseLag()
                          throws IOException
```
    Determines the current database replication lag.
    
    Returns:
    the current database replication lag
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
    
    See Also:
    setMaxLag(int), getMaxLag()
  - getSiteStatistics
```
public HashMap<String,Integer> getSiteStatistics()
                                          throws IOException
```
    Fetches some site statistics, namely the number of articles, pages, files, edits, users and admins. Equivalent to [[Special:Statistics]].
    
    Returns:
    a map containing the stats. Use "articles", "pages", "files" "edits", "users" or "admins" to retrieve the respective value
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.14
  - version
```
public String version()
               throws IOException
```
    Gets the version of MediaWiki this wiki runs e.g. 1.20wmf5 (54b4fcb). See also http://gerrit.wikimedia.org/ .
    
    Returns:
    the version of MediaWiki used
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.14
  - parse
```
public String parse(String markup)
             throws IOException
```
    Renders the specified wiki markup by passing it to the MediaWiki parser through the API. (Note: this isn't implemented locally because I can't be stuffed porting Parser.php). One use of this method is to emulate the previewing functionality of the MediaWiki software.
    
    Parameters:
    markup - the markup to parse
    
    Returns:
    the parsed markup as HTML
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.13
  - parseAndCleanup
```
protected String parseAndCleanup(String in)
                          throws IOException
```
    Same as parse(), but also strips out unwanted crap. This might be useful to subclasses.
    
    Parameters:
    in - the string to parse
    
    Returns:
    that string without the crap
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.14
  - random
```
public String random()
              throws IOException
```
    Fetches a random page in the main namespace. Equivalent to [[Special:Random]].
    
    Returns:
    the title of the page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.13
  - random
```
public String random(int... ns)
              throws IOException
```
    Fetches a random page in the specified namespace. Equivalent to [[Special:Random]].
    
    Parameters:
    ns - namespace(s)
    
    Returns:
    the title of the page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.13
  - intersection
```
public static String[] intersection(String[] a,
                    String[] b)
```
    Determines the intersection of two lists of pages a and b. Such lists might be generated from the various list methods below. Examples from the English Wikipedia:
```
 // find all orphaned and unwikified articles
 String[] articles = Wiki.intersection(wikipedia.getCategoryMembers(
                "All orphaned articles", Wiki.MAIN_NAMESPACE), wikipedia
                .getCategoryMembers("All pages needing to be wikified",
                                Wiki.MAIN_NAMESPACE));
 
 // find all (notable) living people who are related to Barack Obama
 String[] people = Wiki.intersection(
                wikipedia.getCategoryMembers("Living people", Wiki.MAIN_NAMESPACE),
                wikipedia.whatLinksHere("Barack Obama", Wiki.MAIN_NAMESPACE));
 
```
    Parameters:
    a - a list of pages
    b - another list of pages
    
    Returns:
    a intersect b (as String[])
    Since:
    
    0.04
  - relativeComplement
```
public static String[] relativeComplement(String[] a,
                          String[] b)
```
    Determines the list of articles that are in a but not b, i.e. a \ b. This is not the same as b \ a. Such lists might be generated from the various lists below. Some examples from the English Wikipedia:
```
 // find all Martian crater articles that do not have an infobox
 String[] articles = Wiki.relativeComplement(wikipedia
                .getCategoryMembers("Craters on Mars"), wikipedia.whatTranscludesHere(
                "Template:MarsGeo-Crater", Wiki.MAIN_NAMESPACE));
 
 // find all images without a description that haven't been tagged "no license"
 String[] images = Wiki.relativeComplement(wikipedia
                .getCategoryMembers("Images lacking a description"), wikipedia
                .getCategoryMembers("All images with unknown copyright status"));
 
```
    Parameters:
    a - a list of pages
    b - another list of pages
    
    Returns:
    a \ b
    Since:
    
    0.14
  - getTalkPage
```
public String getTalkPage(String title)
                   throws IOException
```
    Returns the corresponding talk page to this page.
    
    Parameters:
    title - the page title
    
    Returns:
    the name of the talk page corresponding to title or "" if we cannot recognise it
    
    Throws:
    
    IllegalArgumentException - if given title is in a talk namespace or we try to retrieve the talk page of a Special: or Media: page.
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - getPageInfo
```
public HashMap getPageInfo(String page)
                    throws IOException
```
    Gets miscellaneous page info.
    
    Parameters:
    page - the page to get info for
    
    Returns:
    see getPageInfo(String[])
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.28
  - getPageInfo
```
public HashMap[] getPageInfo(String[] pages)
                      throws IOException
```
    Gets miscellaneous page info. Returns:
```
  {
      "displaytitle" => "iPod"         , // the title of the page that is actually displayed (String)
      "protection"   => NO_PROTECTION  , // the // protection state of the page (HashMap)
      "token"        => "\+"           , // an edit token for the page, must be logged
                                         // in to be non-trivial (String)
      "exists"       => true           , // whether the page exists (Boolean)
      "lastpurged"   => 20110101000000 , // when the page was last purged (Calendar), null if the
                                         // page does not exist
      "lastrevid"    => 123456789L     , // the revid of the top revision (Long), -1L if the page
                                         // does not exist
      "size"         => 5000           , // the size of the page (Integer), -1 if the page does
                                         // not exist
      "timestamp"    => makeCalendar() , // when this method was called (Calendar)
      "watchtoken"   => "\+"           , // watchlist token (String)
      "watchers"     => 34               // number of watchers (Integer), may be restricted
  }
 
```
    Parameters:
    pages - the pages to get info for
    
    Returns:
    (see above)
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.23
  - namespace
```
public int namespace(String title)
              throws IOException
```
    Returns the namespace a set of pages is in. See namespace(String[]).
    
    Parameters:
    title - a page
    
    Returns:
    (see above)
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.28
  - namespace
```
public int[] namespace(String[] titles)
                throws IOException
```
    Returns the namespace a set of pages is in. No need to override this to add custom namespaces, though you may want to define static fields e.g. public static final int PORTAL_NAMESPACE = 100; for the Portal namespace on the English Wikipedia.
    
    Parameters:
    titles - at least one page
    
    Returns:
    an integer array containing the namespaces of pages in titles in the same order
    
    Throws:
    
    IOException - if a network error occurs while populating the namespace cache
    Since:
    
    0.03
    
    See Also:
    namespaceIdentifier(int)
  - namespaceIdentifier
```
public String namespaceIdentifier(int namespace)
                           throws IOException
```
    For a given namespace denoted as an integer, fetch the corresponding identification string e.g. namespaceIdentifier(1) should return "Talk" on en.wp. (This does the exact opposite to namespace()). Strings returned are localized.
    
    Parameters:
    namespace - an integer corresponding to a namespace. If it does not correspond to a namespace, we assume you mean the main namespace (i.e. return "").
    
    Returns:
    the identifier of the namespace
    
    Throws:
    
    IOException - if the namespace cache has not been populated, and a network error occurs when populating it
    Since:
    
    0.25
    
    See Also:
    namespace(java.lang.String)
  - getNamespaces
```
public HashMap<String,Integer> getNamespaces()
                                      throws IOException
```
    Gets the namespaces used by this wiki.
    
    Returns:
    a map containing e.g. {"Media" => -2, "Special" => -1, ...}. Changes in this map do not propagate back to this Wiki object.
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.28
  - populateNamespaceCache
```
protected void populateNamespaceCache()
                               throws IOException
```
    Populates the namespace cache.
    
    Throws:
    
    IOException - if a network error occurs.
    Since:
    
    0.25
  - exists
```
public boolean[] exists(String... titles)
                 throws IOException
```
    Determines whether a series of pages exist.
    
    Parameters:
    titles - the titles to check
    
    Returns:
    whether the pages exist
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - getPageText
```
public String getPageText(String title)
                   throws IOException
```
    Gets the raw wikicode for a page. WARNING: does not support special pages. Check [[User talk:MER-C/Wiki.java#Special page equivalents]] for fetching the contents of special pages. Use getImage() to fetch an image.
    
    Parameters:
    title - the title of the page.
    
    Returns:
    the raw wikicode of a page.
    
    Throws:
    
    UnsupportedOperationException - if you try to retrieve the text of a Special: or Media: page
    
    FileNotFoundException - if the page does not exist
    
    IOException - if a network error occurs
    See Also:
    edit(java.lang.String, java.lang.String, java.lang.String)
  - getSectionText
```
public String getSectionText(String title,
                    int number)
                      throws IOException
```
    Gets the text of a specific section. Useful for section editing.
    
    Parameters:
    title - the title of the relevant page
    number - the section number of the section to retrieve text for
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if the page has less than number sections
    Since:
    
    0.24
  - getRenderedText
```
public String getRenderedText(String title)
                       throws IOException
```
    Gets the contents of a page, rendered in HTML (as opposed to wikitext). WARNING: only supports special pages in certain circumstances, for example getRenderedText("Special:Recentchanges") returns the 50 most recent change to the wiki in pretty-print HTML. You should test any use of this method on-wiki through the text {{Special:Specialpage}}. Use getImage() to fetch an image. Be aware of any transclusion limits, as outlined at [[Wikipedia:Template limits]].
    
    Parameters:
    title - the title of the page
    
    Returns:
    the rendered contents of that page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - edit
```
public void edit(String title,
        String text,
        String summary)
          throws IOException,
                 LoginException
```
    Edits a page by setting its text to the supplied value. This method is thread safe and blocks for a minimum time as specified by the throttle. The edit will be marked bot if isMarkBot() == true and minor if isMarkMinor() == true.
    
    Parameters:
    text - the text of the page
    title - the title of the page
    summary - the edit summary. See [[Help:Edit summary]]. Summaries longer than 200 characters are truncated server-side.
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialException - if page is protected and we can't edit it
    
    UnsupportedOperationException - if you try to edit a Special: or a Media: page
    
    LoginException
    See Also:
    getPageText(java.lang.String)
  - edit
```
public void edit(String title,
        String text,
        String summary,
        Calendar basetime)
          throws IOException,
                 LoginException
```
    Edits a page by setting its text to the supplied value. This method is thread safe and blocks for a minimum time as specified by the throttle. The edit will be marked bot if isMarkBot() == true and minor if isMarkMinor() == true.
    
    Parameters:
    text - the text of the page
    title - the title of the page
    summary - the edit summary. See [[Help:Edit summary]]. Summaries longer than 200 characters are truncated server-side.
    basetime - the timestamp of the revision on which text is based, used to check for edit conflicts. null disables this.
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialException - if page is protected and we can't edit it
    
    UnsupportedOperationException - if you try to edit a Special: or a Media: page
    
    LoginException
    See Also:
    getPageText(java.lang.String)
  - edit
```
public void edit(String title,
        String text,
        String summary,
        int section)
          throws IOException,
                 LoginException
```
    Edits a page by setting its text to the supplied value. This method is thread safe and blocks for a minimum time as specified by the throttle. The edit will be marked bot if isMarkBot() == true and minor if isMarkMinor() == true.
    
    Parameters:
    text - the text of the page
    title - the title of the page
    summary - the edit summary. See [[Help:Edit summary]]. Summaries longer than 200 characters are truncated server-side.
    section - the section to edit. Use -1 to specify a new section and -2 to disable section editing.
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialException - if page is protected and we can't edit it
    
    UnsupportedOperationException - if you try to edit a Special: or a Media: page
    
    LoginException
    Since:
    
    0.25
    
    See Also:
    getPageText(java.lang.String)
  - edit
```
public void edit(String title,
        String text,
        String summary,
        int section,
        Calendar basetime)
          throws IOException,
                 LoginException
```
    Edits a page by setting its text to the supplied value. This method is thread safe and blocks for a minimum time as specified by the throttle. The edit will be marked bot if isMarkBot() == true and minor if isMarkMinor() == true.
    
    Parameters:
    text - the text of the page
    title - the title of the page
    summary - the edit summary. See [[Help:Edit summary]]. Summaries longer than 200 characters are truncated server-side.
    section - the section to edit. Use -1 to specify a new section and -2 to disable section editing.
    basetime - the timestamp of the revision on which text is based, used to check for edit conflicts. null disables this.
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialException - if page is protected and we can't edit it
    
    UnsupportedOperationException - if you try to edit a Special: or a Media: page
    
    LoginException
    Since:
    
    0.25
    
    See Also:
    getPageText(java.lang.String)
  - edit
```
public void edit(String title,
        String text,
        String summary,
        boolean minor,
        boolean bot,
        int section,
        Calendar basetime)
          throws IOException,
                 LoginException
```
    Edits a page by setting its text to the supplied value. This method is thread safe and blocks for a minimum time as specified by the throttle.
    
    Parameters:
    text - the text of the page
    title - the title of the page
    summary - the edit summary. See [[Help:Edit summary]]. Summaries longer than 200 characters are truncated server-side.
    minor - whether the edit should be marked as minor, See [[Help:Minor edit]].
    bot - whether to mark the edit as a bot edit (ignored if one does not have the necessary permissions)
    section - the section to edit. Use -1 to specify a new section and -2 to disable section editing.
    basetime - the timestamp of the revision on which text is based, used to check for edit conflicts. null disables this.
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialExpiredException - if cookies have expired
    
    CredentialException - if page is protected and we can't edit it
    
    UnsupportedOperationException - if you try to edit a Special: or Media: page
    
    LoginException
    Since:
    
    0.17
    
    See Also:
    getPageText(java.lang.String)
  - newSection
```
public void newSection(String title,
              String subject,
              String text,
              boolean minor,
              boolean bot)
                throws IOException,
                       LoginException
```
    Creates a new section on the specified page. Leave subject as the empty string if you just want to append.
    
    Parameters:
    title - the title of the page to edit
    subject - the subject of the new section
    text - the text of the new section
    minor - whether the edit should be marked as minor (see [[Help:Minor edit]])
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialException - if page is protected and we can't edit it
    
    CredentialExpiredException - if cookies have expired
    
    UnsupportedOperationException - if you try to edit a Special: or Media: page
    
    LoginException
    Since:
    
    0.17
  - prepend
```
public void prepend(String title,
           String stuff,
           String summary,
           boolean minor,
           boolean bot)
             throws IOException,
                    LoginException
```
    Prepends something to the given page. A convenience method for adding maintainance templates, rather than getting and setting the page yourself.
    
    Parameters:
    title - the title of the page
    stuff - what to prepend to the page
    summary - the edit summary. See [[Help:Edit summary]]. Summaries longer than 200 characters are truncated server-side.
    minor - whether the edit is minor
    
    Throws:
    
    AccountLockedException - if user is blocked
    
    CredentialException - if page is protected and we can't edit it
    
    CredentialExpiredException - if cookies have expired
    
    UnsupportedOperationException - if you try to retrieve the text of a Special: page or a Media: page
    
    IOException - if a network error occurs
    
    LoginException
  - delete
```
public void delete(String title,
          String reason)
            throws IOException,
                   LoginException
```
    Deletes a page. Does not delete any page requiring bigdelete.
    
    Parameters:
    title - the page to delete
    reason - the reason for deletion
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if the user lacks the permission to delete
    
    CredentialExpiredException - if cookies have expired
    
    AccountLockedException - if user is blocked
    
    LoginException
    Since:
    
    0.24
  - purge
```
public void purge(boolean links,
         String... titles)
           throws IOException
```
    Purges the server-side cache for various pages.
    
    Parameters:
    titles - the titles of the page to purge
    links - update the links tables
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.17
  - getImagesOnPage
```
public String[] getImagesOnPage(String title)
                         throws IOException
```
    Gets the list of images used on a particular page. Capped at max number of images, there's no reason why there should be more than that.
    
    Parameters:
    title - a page
    
    Returns:
    the list of images used in the page. Note that each String in the array will begin with the prefix "File:"
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.16
  - getCategories
```
public String[] getCategories(String title)
                       throws IOException
```
    Gets the list of categories a particular page is in. Includes hidden categories. Capped at max number of categories, there's no reason why there should be more than that.
    
    Parameters:
    title - a page
    
    Returns:
    the list of categories that page is in
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.16
  - getTemplates
```
public String[] getTemplates(String title,
                    int... ns)
                      throws IOException
```
    Gets the list of templates used on a particular page that are in a particular namespace(s). Capped at max number of templates, there's no reason why there should be more than that.
    
    Parameters:
    title - a page
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the list of templates used on that page in that namespace
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.16
  - getInterWikiLinks
```
public HashMap<String,String> getInterWikiLinks(String title)
                                         throws IOException
```
    Gets the list of interwiki links a particular page has. The returned map has the format language code => the page on the external wiki linked to.
    
    Parameters:
    title - a page
    
    Returns:
    a map of interwiki links that page has
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.18
  - getLinksOnPage
```
public String[] getLinksOnPage(String title)
                        throws IOException
```
    Gets the list of links used on a particular page. Patch somewhat by wim.jongman
    
    Parameters:
    title - a page
    
    Returns:
    the list of links used in the page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.24
  - getSectionMap
```
public LinkedHashMap<String,String> getSectionMap(String page)
                                           throws IOException
```
    Gets the list of sections on a particular page. The returned map pairs the section numbering as in the table of contents with the section title, as in the following example: 1 => How to nominate 1.1 => Step 1 - Evaluate 1.2 => Step 2 - Create subpage 1.2.1 => Step 2.5 - Transclude and link 1.3 => Step 3 - Update image ...
    
    Parameters:
    page - the page to get sections for
    
    Returns:
    the section map for that page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.18
  - getTopRevision
```
public Wiki.Revision getTopRevision(String title)
                             throws IOException
```
    Gets the most recent revision of a page, or null if the page does not exist.
    
    Parameters:
    title - a page
    
    Returns:
    the most recent revision of that page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.24
  - getFirstRevision
```
public Wiki.Revision getFirstRevision(String title)
                               throws IOException
```
    Gets the first revision of a page, or null if the page does not exist.
    
    Parameters:
    title - a page
    
    Returns:
    the oldest revision of that page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.24
  - getPageHistory
```
public Wiki.Revision[] getPageHistory(String title)
                               throws IOException
```
    Gets the entire revision history of a page. Be careful when using this method as some pages (such as [[Wikipedia:Administrators' noticeboard/Incidents]] have ~10^6 revisions.
    
    Parameters:
    title - a page
    
    Returns:
    the revisions of that page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.19
  - getPageHistory
```
public Wiki.Revision[] getPageHistory(String title,
                             Calendar start,
                             Calendar end)
                               throws IOException
```
    Gets the revision history of a page between two dates.
    
    Parameters:
    title - a page
    start - the date to start enumeration (the latest of the two dates)
    end - the date to stop enumeration (the earliest of the two dates)
    
    Returns:
    the revisions of that page in that time span
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.19
  - move
```
public void move(String title,
        String newTitle,
        String reason)
          throws IOException,
                 LoginException
```
    Moves a page. Moves the associated talk page and leaves redirects, if applicable. Equivalent to [[Special:MovePage]]. This method is thread safe and is subject to the throttle.
    
    Parameters:
    title - the title of the page to move
    newTitle - the new title of the page
    reason - a reason for the move
    
    Throws:
    
    UnsupportedOperationException - if the original page is in the Category or Image namespace. MediaWiki does not support moving of these pages.
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    
    CredentialExpiredException - if cookies have expired
    
    CredentialException - if page is protected and we can't move it
    
    LoginException
    Since:
    
    0.16
  - move
```
public void move(String title,
        String newTitle,
        String reason,
        boolean noredirect,
        boolean movetalk,
        boolean movesubpages)
          throws IOException,
                 LoginException
```
    Moves a page. Equivalent to [[Special:MovePage]]. This method is thread safe and is subject to the throttle.
    
    Parameters:
    title - the title of the page to move
    newTitle - the new title of the page
    reason - a reason for the move
    noredirect - don't leave a redirect behind. You need to be a admin to do this, otherwise this option is ignored.
    movesubpages - move the subpages of this page as well. You need to be an admin to do this, otherwise this will be ignored.
    movetalk - move the talk page as well (if applicable)
    
    Throws:
    
    UnsupportedOperationException - if the original page is in the Category or Image namespace. MediaWiki does not support moving of these pages.
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    
    CredentialExpiredException - if cookies have expired
    
    CredentialException - if page is protected and we can't move it
    
    LoginException
    Since:
    
    0.16
  - protect
```
public void protect(String page,
           HashMap<String,Object> protectionstate)
             throws IOException,
                    CredentialException
```
    Protects a page. Structure of protectionstate (everything is optional, if a value is not present, then the corresponding values will be left untouched):
```
  {
     edit => one of { NO_PROTECTION, SEMI_PROTECTION, FULL_PROTECTION }, // restricts editing
     editexpiry => Calendar, // expiry time for edit protection, null = indefinite
     move, moveexpiry, // as above, prevents page moving
     create, createexpiry, // as above, prevents page creation (no effect on existing pages)
     upload, uploadexpiry, // as above, prevents uploading of files (FILE_NAMESPACE only)
     cascade => Boolean // Enables cascading protection (requires edit=FULL_PROTECTION). Default: false.
     cascadesource => String // souce of cascading protection (here ignored)
  };
 
```
    Parameters:
    page - the page
    protectionstate - (see above). null unprotects.
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialException - if we cannot protect
  - unprotect
```
public void unprotect(String page)
               throws IOException,
                      CredentialException
```
    Completely unprotects a page.
    
    Parameters:
    page - the page to unprotect
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialException - if we cannot protect
  - export
```
public String export(String title)
              throws IOException
```
    Exports the current revision of this page. Equivalent to [[Special:Export]].
    
    Parameters:
    title - the title of the page to export
    
    Returns:
    the exported text
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.20
  - getRevision
```
public Wiki.Revision getRevision(long oldid)
                          throws IOException
```
    Gets a revision based on a given oldid. Automatically fills out all attributes of that revision except rcid and rollbacktoken.
    
    Parameters:
    oldid - a particular oldid
    
    Returns:
    the revision corresponding to that oldid. If a particular revision has been deleted, returns null.
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.17
  - rollback
```
public void rollback(Wiki.Revision revision)
              throws IOException,
                     LoginException
```
    Reverts a series of edits on the same page by the same user quickly provided that they are the most recent revisions on that page. If this is not the case, then this method does nothing. See [[mw:Manual:Parameters to index.php#Actions]] (look under rollback) for more information. The edit and reverted edits will be marked as bot if isMarkBot() == true.
    
    Parameters:
    revision - the revision to revert. revision.isTop() must be true for the rollback to succeed
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if the user is not an admin
    
    CredentialExpiredException - if cookies have expired
    
    AccountLockedException - if the user is blocked
    
    LoginException
    Since:
    
    0.19
  - rollback
```
public void rollback(Wiki.Revision revision,
            boolean bot,
            String reason)
              throws IOException,
                     LoginException
```
    Reverts a series of edits on the same page by the same user quickly provided that they are the most recent revisions on that page. If this is not the case, then this method does nothing. See [[mw:Manual:Parameters to index.php#Actions]] (look under rollback) for more information.
    
    Parameters:
    revision - the revision to revert. revision.isTop() must be true for the rollback to succeed
    bot - whether to mark this edit and the reverted revisions as bot edits (ignored if we cannot do this)
    reason - (optional) a reason for the rollback. Use "" for the default ([[MediaWiki:Revertpage]]).
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialExpiredException - if cookies have expired
    
    CredentialNotFoundException - if the user is not an admin
    
    AccountLockedException - if the user is blocked
    
    LoginException
    Since:
    
    0.19
  - undo
```
public void undo(Wiki.Revision rev,
        Wiki.Revision to,
        String reason,
        boolean minor,
        boolean bot)
          throws IOException,
                 LoginException
```
    Undoes revisions, equivalent to the "undo" button in the GUI page history. A quick explanation on how this might work - suppose the edit history was as follows:
    - (revid=541) 2009-01-13 00:01 92.45.43.227
    - (revid=325) 2008-12-10 11:34 Example user
    - (revid=314) 2008-12-10 10:15 127.0.0.1
    - (revid=236) 2008-08-08 08:00 Anonymous
    - (revid=200) 2008-07-31 16:46 EvilCabalMember
    Then:
```
 wiki.undo(wiki.getRevision(314L), null, reason, false); // undo revision 314
                                                                                                                // only
 wiki.undo(wiki.getRevision(236L), wiki.getRevision(325L), reason, false); // undo
                                                                                                                                                        // revisions
                                                                                                                                                        // 236-325
 
```
    This will only work if revision 541 or any subsequent edits do not clash with the change resulting from the undo.
    Parameters:
    rev - a revision to undo
    to - the most recent in a range of revisions to undo. Set to null to undo only one revision.
    reason - an edit summary (optional). Use "" to get the default [[MediaWiki:Undo-summary]].
    minor - whether this is a minor edit
    bot - whether this is a bot edit
    
    Throws:
    
    IOException - if a network error occurs
    
    AccountLockedException - if user is blocked
    
    CredentialExpiredException - if cookies have expired
    
    CredentialException - if page is protected and we can't edit it
    
    IllegalArgumentException - if the revisions are not on the same page.
    
    LoginException
    Since:
    
    0.20
  - parseRevision
```
protected Wiki.Revision parseRevision(String xml,
                          String title)
```
    Parses stuff of the form title="L. Sprague de Camp" timestamp="2006-08-28T23:48:08Z" minor="" comment="robot Modifying: [[bg:Blah]]" into useful revision objects. Used by contribs(), watchlist(), getPageHistory() rangeContribs() and recentChanges(). NOTE: if RevisionDelete was used on a revision, the relevant values will be null.
    
    Parameters:
    xml - the XML to parse
    title - an optional title parameter if we already know what it is (use "" if we don't)
    
    Returns:
    the Revision encoded in the XML
    Since:
    
    0.17
  - getImage
```
public byte[] getImage(String title)
                throws IOException
```
    Fetches an image file and returns the image data in a byte[]. To recover the old behavior (BufferedImage), use ImageIO.read(new ByteArrayInputStream(getImage("Example.jpg")));
    
    Parameters:
    title - the title of the image (may contain "File")
    
    Returns:
    the image data
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - getImage
```
public byte[] getImage(String title,
              int width,
              int height)
                throws IOException
```
    Fetches a thumbnail of an image file and returns the image data in a byte[]. To recover the old behavior (BufferedImage), use ImageIO.read(new ByteArrayInputStream(getImage("Example.jpg")));
    
    Parameters:
    title - the title of the image (may contain "File")
    width - the width of the thumbnail (use -1 for actual width)
    height - the height of the thumbnail (use -1 for actual height)
    
    Returns:
    the image data
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.13
  - getFileMetadata
```
public HashMap<String,Object> getFileMetadata(String file)
                                       throws IOException
```
    Gets the file metadata for a file. Note that getImage() reads directly into a BufferedImage object, so you won't be able to get all metadata that way. The keys are: * size (file size, Integer) * width (Integer) * height (Integer) * mime (MIME type, String) * plus EXIF metadata (Strings)
    
    Parameters:
    file - the image to get metadata for (may contain "File")
    
    Returns:
    the metadata for the image
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.20
  - getDuplicates
```
public String[] getDuplicates(String file)
                       throws IOException
```
    Gets duplicates of this file. Capped at max number of duplicates, there's no good reason why there should be more than that. Equivalent to [[Special:FileDuplicateSearch]].
    
    Parameters:
    file - the file for checking duplicates (may contain "File")
    
    Returns:
    the duplicates of that file
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.18
  - getImageHistory
```
public Wiki.LogEntry[] getImageHistory(String title)
                                throws IOException
```
    Returns the upload history of an image. This is not the same as getLogEntries(null, null, Integer.MAX_VALUE, Wiki.UPLOAD_LOG, title, Wiki.FILE_NAMESPACE), as the image may have been deleted. This returns only the live history of an image.
    
    Parameters:
    title - the title of the image (may contain File)
    
    Returns:
    the image history of the image
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.20
  - getOldImage
```
public byte[] getOldImage(Wiki.LogEntry entry)
                   throws IOException
```
    Gets an old image revision and returns the image data in a byte[]. You will have to do the thumbnailing yourself.n
    
    Parameters:
    entry - the upload log entry that corresponds to the image being uploaded
    
    Returns:
    the image data that was uploaded, as long as it exists in the local repository (i.e. not on Commons or deleted)
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if the entry is not in the upload log
    Since:
    
    0.20
  - getUploads
```
public Wiki.LogEntry[] getUploads(Wiki.User user)
                           throws IOException
```
    Gets the uploads of a user.
    
    Parameters:
    user - the user to get uploads for
    
    Returns:
    a list of all live images the user has uploaded
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.28
  - getUploads
```
public Wiki.LogEntry[] getUploads(Wiki.User user,
                         Calendar start,
                         Calendar end)
                           throws IOException
```
    Gets the uploads of a user between the specified times.
    
    Parameters:
    user - the user to get uploads for
    start - the date to start enumeration (use null to not specify one)
    end - the date to end enumeration (use null to not specify one)
    
    Returns:
    a list of all live images the user has uploaded
    
    Throws:
    
    IOException - if a network error occurs
  - upload
```
public void upload(File file,
          String filename,
          String contents,
          String reason)
            throws IOException,
                   LoginException
```
    Uploads an image. Equivalent to [[Special:Upload]]. Supported extensions are (case-insensitive) "png", "jpg", "gif" and "svg". You need to be logged on to do this. Automatically breaks uploads into 2^ LOG2_CHUNK_SIZE byte size chunks. This method is thread safe and subject to the throttle.
    
    Parameters:
    file - the image file
    filename - the target file name (may contain File)
    contents - the contents of the image description page, set to "" if overwriting an existing file
    reason - an upload summary (defaults to contents, use "" to not specify one)
    
    Throws:
    
    CredentialNotFoundException - if not logged in
    
    CredentialException - if (page is protected OR file is on a central repository) and we can't upload
    
    CredentialExpiredException - if cookies have expired
    
    IOException - if a network/local filesystem error occurs
    
    AccountLockedException - if user is blocked
    
    LoginException
    Since:
    
    0.21
  - userExists
```
public boolean userExists(String username)
                   throws IOException
```
    Determines whether a specific user exists. Should evaluate to false for anons.
    
    Parameters:
    username - a username
    
    Returns:
    whether the user exists
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.05
  - allUsers
```
public String[] allUsers(String start,
                int number)
                  throws IOException
```
    Gets the specified number of users (as a String) starting at the given string, in alphabetical order. Equivalent to [[Special:Listusers]].
    
    Parameters:
    start - the string to start enumeration
    number - the number of users to return
    
    Returns:
    a String[] containing the usernames
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.05
  - allUsersWithPrefix
```
public String[] allUsersWithPrefix(String prefix)
                            throws IOException
```
    Returns all usernames with the given prefix.
    
    Parameters:
    prefix - a username prefix (without User:)
    
    Returns:
    (see above)
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.28
  - allUsers
```
public String[] allUsers(String start,
                int number,
                String prefix)
                  throws IOException
```
    Gets the specified number of users (as a String) starting at the given string, in alphabetical order. Equivalent to [[Special:Listusers]].
    
    Parameters:
    start - the string to start enumeration
    number - the number of users to return
    prefix - list all users with this prefix (overrides start and amount), use "" to not specify one
    
    Returns:
    a String[] containing the usernames
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.28
  - getUser
```
public Wiki.User getUser(String username)
                  throws IOException
```
    Gets the user with the given username. Returns null if it doesn't exist.
    
    Parameters:
    username - a username
    
    Returns:
    the user with that username
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.05
  - getCurrentUser
```
public Wiki.User getCurrentUser()
```
    Gets the user we are currently logged in as. If not logged in, returns null.
    
    Returns:
    the current logged in user
    Since:
    
    0.05
  - contribs
```
public Wiki.Revision[] contribs(String user,
                       int... ns)
                         throws IOException
```
    Gets the contributions of a user in a particular namespace. Equivalent to [[Special:Contributions]]. Be careful when using this method because the user may have a high edit count e.g. enWiki.contribs("MER-C", Wiki.MAIN_NAMESPACE).length > 50000.
    
    Parameters:
    user - the user or IP to get contributions for
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the contributions of the user
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.17
  - rangeContribs
```
@Deprecated
public Wiki.Revision[] rangeContribs(String range)
                              throws IOException
```
    Deprecated. doesn't support IPv6, and I am way too lazy to make it do so
    
    Gets the contributions by a range of IP v4 addresses. Supported ranges are /8, /16 and /24. Do be careful with this, as calls such as enWiki.rangeContribs("152.163.0.0/16"); // let's get all the contributions for this AOL range! might just kill your program.
    
    Parameters:
    range - the CIDR range of IP addresses to get contributions for
    
    Returns:
    the contributions of that range
    
    Throws:
    
    IOException - if a network error occurs
    
    NumberFormatException - if we aren't able to parse the range
    Since:
    
    0.17
  - contribs
```
public Wiki.Revision[] contribs(String user,
                       String prefix,
                       Calendar end,
                       Calendar start,
                       int... ns)
                         throws IOException
```
    Gets the contributions for a user, an IP address or a range of IP addresses. Equivalent to [[Special:Contributions]]. To fetch contribs for an IP range, specify part of an IP address e.g. prefix="127.0." for 127.0.0.0/16; for IPv6 addresses use e.g. prefix="2001:db8:0:0:0:". MediaWiki always fully expands IPv6 addresses and converts all digits A through F to uppercase. (No sanitization is done on IP addresses). Be careful when using prefix as it may take too long and/or cause OOM.
    
    Parameters:
    user - the user to get contributions for.
    start - fetch edits no newer than this date
    end - fetch edits no older than this date
    ns - a list of namespaces to filter by, empty = all namespaces.
    prefix - a prefix of usernames. Overrides user. Use "" to not specify one.
    
    Returns:
    contributions of this user
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.17
  - emailUser
```
public void emailUser(Wiki.User user,
             String message,
             String subject,
             boolean emailme)
               throws IOException,
                      LoginException
```
    Sends an email message to a user in a similar manner to [[Special:Emailuser]]. You and the target user must have a confirmed email address and the target user must have email contact enabled. Messages are sent in plain text (no wiki markup or HTML).
    
    Parameters:
    user - a Wikipedia user with email enabled
    subject - the subject of the message
    message - the plain text message
    emailme - whether to send a copy of the message to your email address
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialExpiredException - if cookies have expired
    
    AccountLockedException - if you have been blocked from sending email
    
    UnsupportedOperationException - if email is disabled or if you do not have a verified email address
    
    LoginException
    Since:
    
    0.24
  - watch
```
public void watch(String... titles)
           throws IOException,
                  CredentialNotFoundException
```
    Adds a page to the watchlist. You need to be logged in to use this.
    
    Parameters:
    titles - the pages to add to the watchlist
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.18
    
    See Also:
    unwatch(java.lang.String...)
  - unwatch
```
public void unwatch(String... titles)
             throws IOException,
                    CredentialNotFoundException
```
    Removes pages from the watchlist. You need to be logged in to use this. (Does not do anything if the page is not watched).
    
    Parameters:
    titles - the pages to remove from the watchlist.
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.18
    
    See Also:
    watch(java.lang.String...)
  - watchInternal
```
protected void watchInternal(boolean unwatch,
                 String... titles)
                      throws IOException,
                             CredentialNotFoundException
```
    Internal method for interfacing with the watchlist, since the API URLs for (un)watching are very similar.
    
    Parameters:
    titles - the titles to (un)watch
    unwatch - whether we should unwatch these pages
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.18
    
    See Also:
    watch(java.lang.String...), unwatch(java.lang.String...)
  - getRawWatchlist
```
public String[] getRawWatchlist()
                         throws IOException,
                                CredentialNotFoundException
```
    Fetches the list of titles on the currently logged in user's watchlist. Equivalent to [[Special:Watchlist/raw]].
    
    Returns:
    the contents of the watchlist
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.18
  - getRawWatchlist
```
public String[] getRawWatchlist(boolean cache)
                         throws IOException,
                                CredentialNotFoundException
```
    Fetches the list of titles on the currently logged in user's watchlist. Equivalent to [[Special:Watchlist/raw]].
    
    Parameters:
    cache - whether we should use the watchlist cache (no online activity, if the cache exists)
    
    Returns:
    the contents of the watchlist
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.18
  - isWatched
```
public boolean isWatched(String title)
                  throws IOException,
                         CredentialNotFoundException
```
    Determines whether a page is watched. (Uses a cache).
    
    Parameters:
    title - the title to be checked
    
    Returns:
    whether that page is watched
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.18
  - watchlist
```
public Wiki.Revision[] watchlist()
                          throws IOException,
                                 CredentialNotFoundException
```
    Fetches the most recent changes to pages on your watchlist. Data is retrieved from the recentchanges table and hence cannot be older than about a month.
    
    Returns:
    list of changes to watched pages and their talk pages
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.27
  - watchlist
```
public Wiki.Revision[] watchlist(boolean allrev,
                        int... ns)
                          throws IOException,
                                 CredentialNotFoundException
```
    Fetches recent changes to pages on your watchlist. Data is retrieved from the recentchanges table and hence cannot be older than about a month.
    
    Parameters:
    allrev - show all revisions to the pages, instead of the top most change
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    list of changes to watched pages and their talk pages
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if not logged in
    Since:
    
    0.27
  - search
```
public String[][] search(String search,
                int... namespaces)
                  throws IOException
```
    Performs a full text search of the wiki. Equivalent to [[Special:Search]], or that little textbox in the sidebar. Returns an array of search results, where:
```
  results[0] == page name
  results[1] == parsed section name (may be "")
  results[2] == snippet of page text
 
```
    Parameters:
    search - a search string
    namespaces - the namespaces to search. If no parameters are passed then the default is MAIN_NAMESPACE only.
    
    Returns:
    the search results
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.14
  - imageUsage
```
public String[] imageUsage(String image,
                  int... ns)
                    throws IOException
```
    Returns a list of pages in the specified namespaces which use the specified image.
    
    Parameters:
    image - the image (may contain File:)
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the list of pages that use this image
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - whatLinksHere
```
public String[] whatLinksHere(String title,
                     int... ns)
                       throws IOException
```
    Returns a list of all pages linking to this page. Equivalent to [[Special:Whatlinkshere]].
    
    Parameters:
    title - the title of the page
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the list of pages linking to the specified page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - whatLinksHere
```
public String[] whatLinksHere(String title,
                     boolean redirects,
                     int... ns)
                       throws IOException
```
    Returns a list of all pages linking to this page within the specified namespaces. Alternatively, we can retrive a list of what redirects to a page by setting redirects to true. Equivalent to [[Special:Whatlinkshere]].
    
    Parameters:
    title - the title of the page
    ns - a list of namespaces to filter by, empty = all namespaces.
    redirects - whether we should limit to redirects only
    
    Returns:
    the list of pages linking to the specified page
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.10
  - whatTranscludesHere
```
public String[] whatTranscludesHere(String title,
                           int... ns)
                             throws IOException
```
    Returns a list of all pages transcluding to a page within the specified namespaces.
    
    Parameters:
    title - the title of the page, e.g. "Template:Stub"
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the list of pages transcluding the specified page
    
    Throws:
    
    IOException - if a netwrok error occurs
    Since:
    
    0.12
  - getCategoryMembers
```
public String[] getCategoryMembers(String name,
                          int... ns)
                            throws IOException
```
    Gets the members of a category.
    
    Parameters:
    name - the name of the category (with or without namespace attached)
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    a String[] containing page titles of members of the category
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.03
  - getCategoryMembers
```
public String[] getCategoryMembers(String name,
                          boolean subcat,
                          int... ns)
                            throws IOException
```
    Gets the members of a category.
    
    Parameters:
    name - the name of the category
    subcat - do you want to return members of sub-categories also? (default: false)
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    a String[] containing page titles of members of the category
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.03
  - linksearch
```
public ArrayList[] linksearch(String pattern)
                       throws IOException
```
    Searches the wiki for external links. Equivalent to [[Special:Linksearch]]. Returns two lists, where the first is the list of pages and the second is the list of urls. The index of a page in the first list corresponds to the index of the url on that page in the second list. Wildcards (*) are only permitted at the start of the search string.
    
    Parameters:
    pattern - the pattern (String) to search for (e.g. example.com, *.example.com)
    
    Returns:
    two lists - index 0 is the list of pages (String), index 1 is the list of urls (instance of java.net.URL)
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.06
  - linksearch
```
public ArrayList[] linksearch(String pattern,
                     String protocol,
                     int... ns)
                       throws IOException
```
    Searches the wiki for external links. Equivalent to [[Special:Linksearch]]. Returns two lists, where the first is the list of pages and the second is the list of urls. The index of a page in the first list corresponds to the index of the url on that page in the second list. Wildcards (*) are only permitted at the start of the search string.
    
    Parameters:
    pattern - the pattern (String) to search for (e.g. example.com, *.example.com)
    ns - a list of namespaces to filter by, empty = all namespaces.
    protocol - one of { http, https, ftp, irc, gopher, telnet, nntp, worldwind, mailto, news, svn, git, mms } or "" (equivalent to http)
    
    Returns:
    two lists - index 0 is the list of pages (String), index 1 is the list of urls (instance of java.net.URL)
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.24
  - getIPBlockList
```
public Wiki.LogEntry[] getIPBlockList(String user)
                               throws IOException
```
    Looks up a particular user in the IP block list, i.e. whether a user is currently blocked. Equivalent to [[Special:Ipblocklist]].
    
    Parameters:
    user - a username or IP (e.g. "127.0.0.1")
    
    Returns:
    the block log entry
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.12
  - getIPBlockList
```
public Wiki.LogEntry[] getIPBlockList(Calendar start,
                             Calendar end)
                               throws IOException
```
    Lists currently operating blocks that were made in the specified interval. Equivalent to [[Special:Ipblocklist]].
    
    Parameters:
    start - the start date
    end - the end date
    
    Returns:
    the currently operating blocks that were made in that interval
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.12
  - getIPBlockList
```
protected Wiki.LogEntry[] getIPBlockList(String user,
                             Calendar start,
                             Calendar end)
                                  throws IOException
```
    Fetches part of the list of currently operational blocks. Equivalent to [[Special:Ipblocklist]]. WARNING: cannot tell whether a particular IP is autoblocked as this is non-public data (see also [[bugzilla:12321]] and [[foundation:Privacy policy]]). Don't call this directly, use one of the two above methods instead.
    
    Parameters:
    user - a particular user that might have been blocked. Use "" to not specify one. May be an IP (e.g. "127.0.0.1") or a CIDR range (e.g. "127.0.0.0/16") but not an autoblock (e.g. "#123456").
    start - what timestamp to start. Use null to not specify one.
    end - what timestamp to end. Use null to not specify one.
    
    Returns:
    a LogEntry[] of the blocks
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if start date is before end date
    Since:
    
    0.12
  - getLogEntries
```
public Wiki.LogEntry[] getLogEntries(int amount)
                              throws IOException
```
    Gets the most recent set of log entries up to the given amount. Equivalent to [[Special:Log]].
    
    Parameters:
    amount - the amount of log entries to get
    
    Returns:
    the most recent set of log entries
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if amount < 1
    Since:
    
    0.08
  - getLogEntries
```
public Wiki.LogEntry[] getLogEntries(Wiki.User user)
                              throws IOException
```
    Gets log entries for a specific user. Equivalent to [[Special:Log]].
    
    Parameters:
    user - the user to get log entries for
    
    Returns:
    the set of log entries created by that user
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.08
  - getLogEntries
```
public Wiki.LogEntry[] getLogEntries(String target)
                              throws IOException
```
    Gets the log entries representing actions that were performed on a specific target. Equivalent to [[Special:Log]].
    
    Parameters:
    target - the target of the action(s).
    
    Returns:
    the specified log entries
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.08
  - getLogEntries
```
public Wiki.LogEntry[] getLogEntries(Calendar start,
                            Calendar end)
                              throws IOException
```
    Gets all log entries that occurred between the specified dates. WARNING: the start date is the most recent of the dates given, and the order of enumeration is from newest to oldest. Equivalent to [[Special:Log]].
    
    Parameters:
    start - what timestamp to start. Use null to not specify one.
    end - what timestamp to end. Use null to not specify one.
    
    Returns:
    the specified log entries
    
    Throws:
    
    IOException - if something goes wrong
    
    IllegalArgumentException - if start < end
    Since:
    
    0.08
  - getLogEntries
```
public Wiki.LogEntry[] getLogEntries(int amount,
                            String type,
                            String action)
                              throws IOException
```
    Gets the last how ever many log entries in the specified log. Equivalent to [[Special:Log]] and [[Special:Newimages]] when type.equals(UPLOAD_LOG).
    
    Parameters:
    amount - the number of entries to get
    type - what log to get (e.g. DELETION_LOG)
    action - what action to get (e.g. delete, undelete, etc.), use "" to not specify one
    
    Returns:
    the specified log entries
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if the log type doesn't exist
  - getLogEntries
```
public Wiki.LogEntry[] getLogEntries(Calendar start,
                            Calendar end,
                            int amount,
                            String log,
                            String action,
                            Wiki.User user,
                            String target,
                            int namespace)
                              throws IOException
```
    Gets the specified amount of log entries between the given times by the given user on the given target. Equivalent to [[Special:Log]]. WARNING: the start date is the most recent of the dates given, and the order of enumeration is from newest to oldest.
    
    Parameters:
    start - what timestamp to start. Use null to not specify one.
    end - what timestamp to end. Use null to not specify one.
    amount - the amount of log entries to get. If both start and end are defined, this is ignored. Use Integer.MAX_VALUE to not specify one.
    log - what log to get (e.g. DELETION_LOG)
    action - what action to get (e.g. delete, undelete, etc.), use "" to not specify one
    user - the user performing the action. Use null not to specify one.
    target - the target of the action. Use "" not to specify one.
    namespace - filters by namespace. Returns empty if namespace doesn't exist.
    
    Returns:
    the specified log entries
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if start < end or amount < 1
    Since:
    
    0.08
  - parseLogEntry
```
protected Wiki.LogEntry parseLogEntry(String xml)
```
    Parses xml generated by getLogEntries(), getImageHistory() and getIPBlockList() into LogEntry objects. Override this if you want custom log types. NOTE: if RevisionDelete was used on a log entry, the relevant values will be null.
    
    Parameters:
    xml - the xml to parse
    
    Returns:
    the parsed log entry
    Since:
    
    0.18
  - prefixIndex
```
public String[] prefixIndex(String prefix)
                     throws IOException
```
    Lists pages that start with a given prefix. Equivalent to [[Special:Prefixindex]].
    
    Parameters:
    prefix - the prefix
    
    Returns:
    the list of pages with that prefix
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.15
  - shortPages
```
public String[] shortPages(int cutoff)
                    throws IOException
```
    List pages below a certain size in the main namespace. Equivalent to [[Special:Shortpages]].
    
    Parameters:
    cutoff - the maximum size in bytes these short pages can be
    
    Returns:
    pages below that size
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.15
  - shortPages
```
public String[] shortPages(int cutoff,
                  int namespace)
                    throws IOException
```
    List pages below a certain size in any namespace. Equivalent to [[Special:Shortpages]].
    
    Parameters:
    cutoff - the maximum size in bytes these short pages can be
    namespace - a namespace
    
    Returns:
    pages below that size in that namespace
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.15
  - longPages
```
public String[] longPages(int cutoff)
                   throws IOException
```
    List pages above a certain size in the main namespace. Equivalent to [[Special:Longpages]].
    
    Parameters:
    cutoff - the minimum size in bytes these long pages can be
    
    Returns:
    pages above that size
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.15
  - longPages
```
public String[] longPages(int cutoff,
                 int namespace)
                   throws IOException
```
    List pages above a certain size in any namespace. Equivalent to [[Special:Longpages]].
    
    Parameters:
    cutoff - the minimum size in nbytes these long pages can be
    namespace - a namespace
    
    Returns:
    pages above that size
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.15
  - listPages
```
public String[] listPages(String prefix,
                 HashMap<String,Object> protectionstate,
                 int namespace)
                   throws IOException
```
    Lists pages with titles containing a certain prefix with a certain protection state and in a certain namespace. Equivalent to [[Special:Allpages]], [[Special:Prefixindex]], [[Special:Protectedpages]] and [[Special:Allmessages]] (if namespace == MEDIAWIKI_NAMESPACE). WARNING: Limited to 500 values (5000 for bots), unless a prefix or protection level is specified.
    
    Parameters:
    prefix - the prefix of the title. Use "" to not specify one.
    protectionstate - a protection state, use null to not specify one
    namespace - a namespace. ALL_NAMESPACES is not suppported, an UnsupportedOperationException will be thrown.
    
    Returns:
    the specified list of pages
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.09
  - listPages
```
public String[] listPages(String prefix,
                 HashMap<String,Object> protectionstate,
                 int namespace,
                 int minimum,
                 int maximum)
                   throws IOException
```
    Lists pages with titles containing a certain prefix with a certain protection state and in a certain namespace. Equivalent to [[Special:Allpages]], [[Special:Prefixindex]], [[Special:Protectedpages]] [[Special:Allmessages]] (if namespace == MEDIAWIKI_NAMESPACE), [[Special:Shortpages]] and [[Special:Longpages]]. WARNING: Limited to 500 values (5000 for bots), unless a prefix, (max|min)imum size or protection level is specified.
    
    Parameters:
    prefix - the prefix of the title. Use "" to not specify one.
    protectionstate - a protection state, use null to not specify one
    namespace - a namespace. ALL_NAMESPACES is not suppported, an UnsupportedOperationException will be thrown.
    minimum - the minimum size in bytes these pages can be. Use -1 to not specify one.
    maximum - the maximum size in bytes these pages can be. Use -1 to not specify one.
    
    Returns:
    the specified list of pages
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.09
  - queryPage
```
public String[] queryPage(String page)
                   throws IOException,
                          CredentialNotFoundException
```
    Fetches data from one of a set of miscellaneous special pages. WARNING: some of these may be *CACHED*, *DISABLED* and/or *LIMITED* on large wikis.
    
    Parameters:
    page - one of { Ancientpages, BrokenRedirects, Deadendpages, Disambiguations, DoubleRedirects, Listredirects, Lonelypages, Longpages, Mostcategories, Mostimages, Mostinterwikis, Mostlinkedcategories, Mostlinkedtemplates, Mostlinked, Mostrevisions, Fewestrevisions, Shortpages, Uncategorizedcategories, Uncategorizedpages, Uncategorizedimages, Uncategorizedtemplates, Unusedcategories, Unusedimages, Wantedcategories, Wantedfiles, Wantedpages, Wantedtemplates, Unwatchedpages, Unusedtemplates, Withoutinterwiki }. This parameter is *case sensitive*.
    
    Returns:
    the list of pages returned by that particular special page
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialNotFoundException - if page=Unwatchedpages and we cannot read it
    Since:
    
    0.28
  - newPages
```
public Wiki.Revision[] newPages(int amount)
                         throws IOException
```
    Fetches the amount most recently created pages in the main namespace. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then.
    
    Parameters:
    amount - the number of pages to fetch
    
    Returns:
    the revisions that created the pages satisfying the requirements above
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.20
  - newPages
```
public Wiki.Revision[] newPages(int amount,
                       int rcoptions)
                         throws IOException
```
    Fetches the amount most recently created pages in the main namespace subject to the specified constraints. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then. Equivalent to [[Special:Newpages]].
    
    Parameters:
    rcoptions - a bitmask of HIDE_ANON etc that dictate which pages we return (e.g. exclude patrolled pages => rcoptions = HIDE_PATROLLED).
    amount - the amount of new pages to get
    
    Returns:
    the revisions that created the pages satisfying the requirements above
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.20
  - newPages
```
public Wiki.Revision[] newPages(int amount,
                       int rcoptions,
                       int... ns)
                         throws IOException
```
    Fetches the amount most recently created pages in the specified namespace, subject to the specified constraints. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then. Equivalent to [[Special:Newpages]].
    
    Parameters:
    rcoptions - a bitmask of HIDE_ANON etc that dictate which pages we return (e.g. exclude patrolled pages => rcoptions = HIDE_PATROLLED).
    amount - the amount of new pages to get
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the revisions that created the pages satisfying the requirements above
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.20
  - recentChanges
```
public Wiki.Revision[] recentChanges(int amount)
                              throws IOException
```
    Fetches the amount most recent changes in the main namespace. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then. Equivalent to [[Special:Recentchanges]].
    Note: Log entries in recent changes have a revid of 0!
    
    Parameters:
    amount - the number of entries to return
    
    Returns:
    the recent changes that satisfy these criteria
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.23
  - recentChanges
```
public Wiki.Revision[] recentChanges(int amount,
                            int... ns)
                              throws IOException
```
    Fetches the amount most recent changes in the specified namespace. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then. Equivalent to [[Special:Recentchanges]].
    Note: Log entries in recent changes have a revid of 0!
    
    Parameters:
    amount - the number of entries to return
    ns - a list of namespaces to filter by, empty = all namespaces.
    
    Returns:
    the recent changes that satisfy these criteria
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.23
  - recentChanges
```
public Wiki.Revision[] recentChanges(int amount,
                            int rcoptions,
                            int... ns)
                              throws IOException
```
    Fetches the amount most recent changes in the specified namespace subject to the specified constraints. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then. Equivalent to [[Special:Recentchanges]].
    Note: Log entries in recent changes have a revid of 0!
    
    Parameters:
    amount - the number of entries to return
    ns - a list of namespaces to filter by, empty = all namespaces.
    rcoptions - a bitmask of HIDE_ANON etc that dictate which pages we return.
    
    Returns:
    the recent changes that satisfy these criteria
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.23
  - recentChanges
```
protected Wiki.Revision[] recentChanges(int amount,
                            int rcoptions,
                            boolean newpages,
                            int... ns)
                                 throws IOException
```
    Fetches the amount most recent changes in the specified namespace subject to the specified constraints. WARNING: The recent changes table only stores new pages for about a month. It is not possible to retrieve changes before then. Equivalent to [[Special:Recentchanges]].
    Note: Log entries in recent changes have a revid of 0!
    
    Parameters:
    amount - the number of entries to return
    ns - a list of namespaces to filter by, empty = all namespaces.
    rcoptions - a bitmask of HIDE_ANON etc that dictate which pages we return.
    newpages - show new pages only
    
    Returns:
    the recent changes that satisfy these criteria
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.23
  - getInterWikiBacklinks
```
public String[][] getInterWikiBacklinks(String prefix)
                                 throws IOException
```
    Fetches all pages that use interwiki links to the specified wiki and the page on that wiki that is linked to. For example, getInterWikiBacklinks("testwiki") may return:
```
 { { "Spam", "testwiki:Blah" }, { "Test", "testwiki:Main_Page" } }
 
```
    Here the page [[Spam]] contains the interwiki link [[testwiki:Blah]] and the page [[Test]] contains the interwiki link [[testwiki:Main_Page]]. This does not resolve nested interwiki prefixes, e.g. [[wikt:fr:Test]].
    For WMF wikis, see the interwiki mapfor where some prefixes link to.
    Parameters:
    prefix - the interwiki prefix that denotes a wiki
    
    Returns:
    all pages that contain interwiki links to said wiki
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.23
  - getInterWikiBacklinks
```
public String[][] getInterWikiBacklinks(String prefix,
                               String title)
                                 throws IOException
```
    Fetches all pages that use interwiki links with a certain prefix and title. prefix refers to the wiki being linked to and title refers to the page on said wiki being linked to. In wiki syntax, this is [[prefix:title]]. This does not resolve nested prefixes, e.g. [[wikt:fr:Test]].
    Example: If [[Test]] and [[Spam]] both contain the interwiki link [[testwiki:Blah]] then getInterWikiBacklinks("testwiki", "Blah"); will return (sorted by title)
```
 { { "Spam", "testwiki:Blah" }, { "Test", "testwiki:Blah" } }
 
```
    For WMF wikis, see the interwiki mapfor where some prefixes link to.
    Parameters:
    prefix - the interwiki prefix to search
    title - the title of the page on the other wiki to search for (optional, use "|" to not specify one). Warning: "" is a valid interwiki target!
    
    Returns:
    a list of all pages that use interwiki links satisfying the parameters given
    
    Throws:
    
    IOException - if a network error occurs
    
    IllegalArgumentException - if a title is specified without a prefix (the MediaWiki API doesn't like this)
    Since:
    
    0.23
  - fetch
```
protected String fetch(String url,
           String caller)
                throws IOException
```
    A generic URL content fetcher. This is only useful for GET requests, which is almost everything that doesn't modify the wiki. Might be useful for subclasses. Here we also check the database lag and wait if it exceeds maxlag, see here for how this works.
    
    Parameters:
    url - the url to fetch
    caller - the caller of this method
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.18
  - post
```
protected String post(String url,
          String text,
          String caller)
               throws IOException
```
    Does a text-only HTTP POST.
    
    Parameters:
    url - the url to post to
    text - the text to post
    caller - the caller of this method
    
    Returns:
    the server response
    
    Throws:
    
    IOException - if a network error occurs
    Since:
    
    0.24
    
    See Also:
    multipartPost(java.lang.String, java.util.Map, java.lang.String)
  - multipartPost
```
protected String multipartPost(String url,
                   Map<String,?> params,
                   String caller)
                        throws IOException
```
    Performs a multi-part HTTP POST.
    
    Parameters:
    url - the url to post to
    params - the POST parameters. Supported types: UTF-8 text, byte[]. Text and parameter names must NOT be URL encoded.
    caller - the caller of this method
    
    Returns:
    the server response
    
    Throws:
    
    IOException
    Since:
    
    0.27
    
    See Also:
    post(java.lang.String, java.lang.String, java.lang.String), Multipart/form-data
  - checkErrors
```
protected void checkErrors(String line,
               String caller)
                    throws IOException,
                           LoginException
```
    Checks for errors from standard read/write requests.
    
    Parameters:
    line - the response from the server to analyze
    caller - what we tried to do
    
    Throws:
    
    AccountLockedException - if the user is blocked
    
    HttpRetryException - if the database is locked or action was throttled and a retry failed
    
    UnknownError - in the case of a MediaWiki bug
    
    IOException
    
    LoginException
    Since:
    
    0.18
  - decode
```
protected String decode(String in)
```
    Strips entity references like " from the supplied string. This might be useful for subclasses.
    
    Parameters:
    in - the string to remove URL encoding from
    
    Returns:
    that string without URL encoding
    Since:
    
    0.11
  - constructNamespaceString
```
protected void constructNamespaceString(StringBuilder sb,
                            String id,
                            int... namespaces)
```
    Convenience method for converting a namespace list into String form.
    
    Parameters:
    sb - the url StringBuilder to append to
    id - the request type prefix (e.g. "pl" for prop=links)
    namespaces - the list of namespaces to append
    Since:
    
    0.27
  - normalize
```
public String normalize(String s)
```
    Convenience method for normalizing MediaWiki titles. (Converts all spaces to underscores and makes the first letter caps).
    
    Parameters:
    s - the string to normalize
    
    Returns:
    the normalized string
    
    Throws:
    
    IllegalArgumentException - if the title is invalid
    Since:
    
    0.27
  - checkRights
```
protected boolean checkRights(HashMap<String,Object> pageinfo,
                  String action)
                       throws IOException,
                              CredentialException
```
    Checks whether the currently logged on user has sufficient rights to edit/move a protected page.
    
    Parameters:
    pageinfo - the output from getPageInfo()
    action - what we are doing
    
    Returns:
    whether the user can perform the specified action
    
    Throws:
    
    IOException - if a network error occurs
    
    CredentialExpiredException - if cookies have expired
    
    CredentialException
    Since:
    
    0.10
  - statusCheck
```
protected void statusCheck()
                    throws IOException
```
    Performs a status check, including assertions.
    
    Throws:
    
    AssertionError - if any assertions are false
    
    IOException - if a network error occurs
    Since:
    
    0.11
    
    See Also:
    setAssertionMode(int)
  - setCookies
```
protected void setCookies(URLConnection u)
```
    Sets cookies to an unconnected URLConnection and enables gzip compression of returned text.
    
    Parameters:
    u - an unconnected URLConnection
  - log
```
protected void log(Level level,
       String text,
       String method)
```
    Logs a successful result.
    
    Parameters:
    text - string the string to log
    method - what we are currently doing
    level - the level to log at
    Since:
    
    0.06
  - setLogLevel
```
@Deprecated
public void setLogLevel(Level level)
```
    Deprecated. logger is now protected, can call setLevel there
    
    Change the logging level of this object's Logger object.
    
    Parameters:
    level - the new logging level
    Since:
    
    0.24
  - logurl
```
protected void logurl(String url,
          String method)
```
    Logs a url fetch.
    
    Parameters:
    url - the url we are fetching
    method - what we are currently doing
    Since:
    
    0.08
  - makeCalendar
```
public Calendar makeCalendar()
```
    Creates a Calendar object with the current time. Wikimedia wikis use UTC, override this if your wiki is in another timezone.
    
    Returns:
    see above
    Since:
    
    0.26
  - calendarToTimestamp
```
protected String calendarToTimestamp(Calendar c)
```
    Turns a calendar into a timestamp of the format yyyymmddhhmmss. Might be useful for subclasses.
    
    Parameters:
    c - the calendar to convert
    
    Returns:
    the converted calendar
    Since:
    
    0.08
    
    See Also:
    timestampToCalendar(java.lang.String)
  - timestampToCalendar
```
protected final Calendar timestampToCalendar(String timestamp)
```
    Turns a timestamp of the format yyyymmddhhmmss into a Calendar object. Might be useful for subclasses.
    
    Parameters:
    timestamp - the timestamp to convert
    
    Returns:
    the converted Calendar
    Since:
    
    0.08
    
    See Also:
    calendarToTimestamp(java.util.Calendar)
  - convertTimestamp
```
protected String convertTimestamp(String timestamp)
```
    Converts a timestamp of the form used by the API (yyyy-mm-ddThh:mm:ssZ) to the form yyyymmddhhmmss, which can be fed into timestampToCalendar().
    
    Parameters:
    timestamp - the timestamp to convert
    
    Returns:
    the converted timestamp
    Since:
    
    0.12
    
    See Also:
    timestampToCalendar(java.lang.String)

Class Wiki

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MEDIA_NAMESPACE

SPECIAL_NAMESPACE

MAIN_NAMESPACE

TALK_NAMESPACE

USER_NAMESPACE

USER_TALK_NAMESPACE

PROJECT_NAMESPACE

PROJECT_TALK_NAMESPACE

FILE_NAMESPACE

FILE_TALK_NAMESPACE

IMAGE_NAMESPACE

IMAGE_TALK_NAMESPACE

MEDIAWIKI_NAMESPACE

MEDIAWIKI_TALK_NAMESPACE

TEMPLATE_NAMESPACE

TEMPLATE_TALK_NAMESPACE

HELP_NAMESPACE

HELP_TALK_NAMESPACE

CATEGORY_NAMESPACE

CATEGORY_TALK_NAMESPACE

ALL_NAMESPACES

ALL_LOGS

USER_CREATION_LOG

UPLOAD_LOG

DELETION_LOG

MOVE_LOG

BLOCK_LOG

PROTECTION_LOG

USER_RIGHTS_LOG

USER_RENAME_LOG

IMPORT_LOG

PATROL_LOG

NO_PROTECTION

SEMI_PROTECTION

FULL_PROTECTION

ASSERT_NONE

ASSERT_BOT

ASSERT_NO_MESSAGES

HIDE_ANON

HIDE_BOT

HIDE_SELF

HIDE_MINOR

HIDE_PATROLLED

NEXT_REVISION

CURRENT_REVISION

PREVIOUS_REVISION

query

base

apiUrl

scriptPath

logger

Constructor Detail

Wiki

Wiki

Wiki

Method Detail

initVars

getDomain

getThrottle

setThrottle

getScriptPath

setUserAgent

getUserAgent

setUsingCompressedRequests

isUsingCompressedRequests

isResolvingRedirects

setResolveRedirects

setMarkBot

isMarkBot

setMarkMinor

isMarkMinor

equals

hashCode