net.sourceforge.jwbf.mediawiki.actions.queries

Class TitleQuery<T>

java.lang.Object

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

net.sourceforge.jwbf.mediawiki.actions.queries.TitleQuery<T>

Type Parameters:

T - of

All Implemented Interfaces:

Iterable<T>, Iterator<T>, ContentProcessable, ReturningText

Direct Known Subclasses:

AllPageTitles, BacklinkTitles, ImageUsageTitles, RecentchangeTitles, TemplateUserTitles

public abstract class TitleQuery<T>
extends MWAction
implements Iterable<T>, Iterator<T>

Abstract class which is superclass of all titleiterations, represented by the sufix "Titles".

Author:

Thomas Stock

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TitleQuery.InnerAction Inner helper class for this type.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	nextPageInfo Information necessary to get the next api page.
protected Iterator<T>	titleIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TitleQuery(MediaWikiBot bot)

Method Summary

Methods

Modifier and Type	Method and Description
protected TitleQuery.InnerAction	getInnerAction(MediaWiki.Version v)
HttpAction	getNextMessage()
protected String	getNextPageInfo()
boolean	hasNext()
Iterator<T>	iterator()
T	next()
protected abstract Collection<T>	parseArticleTitles(String s)
protected abstract String	parseHasMore(String s)
protected abstract HttpAction	prepareCollection()
void	remove()

Methods inherited from class net.sourceforge.jwbf.mediawiki.actions.util.MWAction

createNsString, evaluateXpath, getErrorElement, getRootElement, getRootElementWithError, hasMoreMessages, isSelfExecuter, processAllReturningText, processReturningText, setExceptionHandler, setHasMoreMessages

Methods inherited from class java.lang.Object

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

Field Detail

titleIterator

protected Iterator<T> titleIterator

nextPageInfo

protected String nextPageInfo

Information necessary to get the next api page.

Constructor Detail

TitleQuery

protected TitleQuery(MediaWikiBot bot)

Method Detail

getNextPageInfo

protected final String getNextPageInfo()

getInnerAction

protected TitleQuery.InnerAction getInnerAction(MediaWiki.Version v)

getNextMessage

public HttpAction getNextMessage()

Specified by:

getNextMessage in interface ContentProcessable

Returns:

the of messages in this action

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public final T next()

Specified by:

next in interface Iterator<T>

remove

public final void remove()

Specified by:

remove in interface Iterator<T>

prepareCollection

protected abstract HttpAction prepareCollection()

parseArticleTitles

protected abstract Collection<T> parseArticleTitles(String s)

parseHasMore

protected abstract String parseHasMore(String s)