net.sourceforge.jwbf.mediawiki.actions.util

Class MWAction

java.lang.Object

net.sourceforge.jwbf.mediawiki.actions.util.MWAction

All Implemented Interfaces:

ContentProcessable, ReturningText

Direct Known Subclasses:

CategoryMembersFull, FileUpload, GetApiToken, GetRendering, GetRevision, GetUserinfo, GetVersion, ImageInfo, LogEvents, MovePage, PostDelete, PostLogin, PostModifyContent, RandomPageTitle, TitleQuery, TitleQuery.InnerAction

public abstract class MWAction
extends Object
implements ContentProcessable

Author:

Thomas Stock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MWAction()
protected	MWAction(MediaWiki.Version v) Deprecated. do not uses this

Method Summary

Methods

Modifier and Type	Method and Description
static String	createNsString(int... namespaces) helper method generating a namespace string as required by the MW-api.
protected String	evaluateXpath(String s, String xpath)
protected org.jdom.Element	getErrorElement(org.jdom.Element rootElement) Determines if the given XML Document contains an error message which then would printed by the logger.
protected org.jdom.Element	getRootElement(String xml)
protected org.jdom.Element	getRootElementWithError(String xml)
boolean	hasMoreMessages()
boolean	isSelfExecuter() Deprecated. see interface
String	processAllReturningText(String s)
String	processReturningText(String s, HttpAction hm) Deals with the MediaWiki API's response by parsing the provided text.
static void	setExceptionHandler(ExceptionHandler exceptionHandler) Deprecated. no alternative method is given, because it is not recommended to change the exception handling
void	setHasMoreMessages(boolean b)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.jwbf.core.actions.ContentProcessable

getNextMessage

Constructor Detail

MWAction

protected MWAction()

MWAction

@Deprecated
protected MWAction(MediaWiki.Version v)

Deprecated. do not uses this

Parameters:

v - of the bot

Method Detail

hasMoreMessages

public boolean hasMoreMessages()

Specified by:

hasMoreMessages in interface ContentProcessable

Returns:

true if and changes state to false

setHasMoreMessages

public void setHasMoreMessages(boolean b)

Parameters:

b - if so

processReturningText

public String processReturningText(String s,
                          HttpAction hm)

Deals with the MediaWiki API's response by parsing the provided text.

Specified by:

processReturningText in interface ReturningText

Parameters:

s - the answer to the most recently generated MediaWiki API request

hm - the requestor message

Returns:

the returning text on processing problems

processAllReturningText

public String processAllReturningText(String s)

Parameters:

s - the returning text

Returns:

the returning text never

createNsString

public static String createNsString(int... namespaces)

helper method generating a namespace string as required by the MW-api.

Parameters:

namespaces - namespace as

Returns:

with numbers seperated by |

isSelfExecuter

@Deprecated
public boolean isSelfExecuter()

Deprecated. see interface

Use this in self maintaining lists for e.g., to prevent user to perform this action manually.

Specified by:

isSelfExecuter in interface ContentProcessable

Returns:

true if

evaluateXpath

protected String evaluateXpath(String s,
                   String xpath)

getRootElement

@Nonnull
protected org.jdom.Element getRootElement(String xml)

getRootElementWithError

@Nonnull
protected org.jdom.Element getRootElementWithError(String xml)

getErrorElement

@CheckForNull
protected org.jdom.Element getErrorElement(org.jdom.Element rootElement)

Determines if the given XML Document contains an error message which then would printed by the logger.

Parameters:

rootElement - XML Document

Returns:

error element

Throws:

org.jdom.JDOMException - thrown if the document could not be parsed

setExceptionHandler

@Deprecated
public static void setExceptionHandler(ExceptionHandler exceptionHandler)

Deprecated. no alternative method is given, because it is not recommended to change the exception handling