org.wikipedia

Class Wiki.Revision

java.lang.Object

org.wikipedia.Wiki.Revision

All Implemented Interfaces:

Comparable<Wiki.Revision>

Enclosing class:

Wiki

public class Wiki.Revision
extends Object
implements Comparable<Wiki.Revision>

Represents a contribution and/or a revision to a page.

Since:

0.17

Constructor Summary

Constructors

Constructor and Description
Wiki.Revision(long revid, Calendar timestamp, String title, String summary, String user, boolean minor, boolean bot, boolean rvnew, int size) Constructs a new Revision object.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Wiki.Revision other) Compares this revision to another revision based on the recentness of their timestamps.
String	diff(long oldid) Returns a HTML rendered diff table; see the table at the example.
protected String	diff(long oldid, String text) Fetches a HTML rendered diff table; see the table at the example.
String	diff(String text) Returns a HTML rendered diff table between this revision and the given text.
String	diff(Wiki.Revision other) Returns a HTML rendered diff table; see the table at the example.
boolean	equals(Object o) Determines whether this Revision is equal to another object.
Wiki.Revision	getNext() Gets the next revision.
String	getPage() Returns the page to which this revision was made.
Wiki.Revision	getPrevious() Gets the previous revision.
long	getRcid() Gets the rcid of this revision for patrolling purposes.
String	getRenderedText() Gets the rendered text of this revision.
long	getRevid() Returns the oldid of this revision.
String	getRollbackToken() Gets the rollback token for this revision.
int	getSize() Gets the size of this revision in bytes.
int	getSizeDiff() Returns the change in page size caused by this revision.
String	getSummary() Returns the edit summary for this revision.
String	getText() Fetches the contents of this revision.
Calendar	getTimestamp() Gets the time that this revision was made.
String	getUser() Returns the user or anon who created this revision.
int	hashCode() Returns a hash code of this revision.
boolean	isBot() Determines whether this revision was made by a bot.
boolean	isMinor() Checks whether this edit was marked as minor.
boolean	isNew() Determines whether this revision created a new page.
void	rollback() Reverts this revision using the rollback method.
void	rollback(boolean bot, String reason) Reverts this revision using the rollback method.
void	setRcid(long rcid) Sets the rcid of this revision, used for patrolling.
void	setRollbackToken(String token) Sets a rollback token for this revision.
String	toString() Returns a string representation of this revision.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wiki.Revision

public Wiki.Revision(long revid,
             Calendar timestamp,
             String title,
             String summary,
             String user,
             boolean minor,
             boolean bot,
             boolean rvnew,
             int size)

Constructs a new Revision object.

Parameters:

revid - the id of the revision (this is a long since {{NUMBEROFEDITS}} on en.wikipedia.org is now (January 2012) ~25% of Integer.MAX_VALUE

timestamp - when this revision was made

title - the concerned article

summary - the edit summary

user - the user making this revision (may be anonymous, if not use User.getUsername())

minor - whether this was a minor edit

bot - whether this was a bot edit

rvnew - whether this revision created a new page

size - the size of the revision

Since:

0.17

Method Detail

getText

public String getText()
               throws IOException

Fetches the contents of this revision. WARNING: fails if the revision is deleted.

Returns:

the contents of the appropriate article at timestamp

Throws:

IOException - if a network error occurs

IllegalArgumentException - if page == Special:Log/xxx.

Since:

0.17

getRenderedText

public String getRenderedText()
                       throws IOException

Gets the rendered text of this revision. WARNING: fails if the revision is deleted.

Returns:

the rendered contents of the appropriate article at timestamp

Throws:

IOException - if a network error occurs

IllegalArgumentException - if page == Special:Log/xxx.

Since:

0.17

diff

public String diff(Wiki.Revision other)
            throws IOException

Returns a HTML rendered diff table; see the table at the example.

Parameters:

other - another revision on the same page.

Returns:

the difference between this and the other revision

Throws:

IOException - if a network error occurs

Since:

0.21

diff

public String diff(String text)
            throws IOException

Returns a HTML rendered diff table between this revision and the given text. Useful for emulating the "show changes" functionality. See the table at the example.

Parameters:

text - some wikitext

Returns:

the difference between this and the the text provided

Throws:

IOException - if a network error occurs

Since:

0.21

diff

public String diff(long oldid)
            throws IOException

Returns a HTML rendered diff table; see the table at the example.

Parameters:

oldid - the oldid of a revision on the same page. NEXT_REVISION, PREVIOUS_REVISION and CURRENT_REVISION can be used here for obvious effect.

Returns:

the difference between this and the other revision

Throws:

IOException - if a network error occurs

Since:

0.26

diff

protected String diff(long oldid,
          String text)
               throws IOException

Fetches a HTML rendered diff table; see the table at the example.

Parameters:

oldid - the id of another revision; (exclusive) or

text - some wikitext to compare against

Returns:

a difference between oldid or text

Throws:

IOException - if a network error occurs

Since:

0.21

equals

public boolean equals(Object o)

Determines whether this Revision is equal to another object.

Overrides:

equals in class Object

Parameters:

o - an object

Returns:

whether o is equal to this object

Since:

0.17

hashCode

public int hashCode()

Returns a hash code of this revision.

Overrides:

hashCode in class Object

Returns:

a hash code

Since:

0.17

isMinor

public boolean isMinor()

Checks whether this edit was marked as minor. See [[Help:Minor edit]] for details.

Returns:

whether this revision was marked as minor

Since:

0.17

isBot

public boolean isBot()

Determines whether this revision was made by a bot.

Returns:

(see above)

Since:

0.23

isNew

public boolean isNew()

Determines whether this revision created a new page.
WARNING: Will return false for all revisions prior to 2007 (I think?) -- this is a MediaWiki problem.
WARNING: Returning true does not imply this is the bottommost revision on the page due to histmerges.
WARNING: Not accessible through getPageHistory() -- a MW problem.

Returns:

(see above)

Since:

0.27

getSummary

public String getSummary()

Returns the edit summary for this revision. WARNING: returns null if the summary was RevisionDeleted.

Returns:

the edit summary

Since:

0.17

getUser

public String getUser()

Returns the user or anon who created this revision. You should pass this (if not an IP) to getUser(String) to obtain a User object. WARNING: returns null if the user was RevisionDeleted.

Returns:

the user or anon

Since:

0.17

getPage

public String getPage()

Returns the page to which this revision was made.

Returns:

the page

Since:

0.17

getRevid

public long getRevid()

Returns the oldid of this revision. Don't confuse this with rcid

Returns:

the oldid (long)

Since:

0.17

getTimestamp

public Calendar getTimestamp()

Gets the time that this revision was made.

Returns:

the timestamp

Since:

0.17

getSize

public int getSize()

Gets the size of this revision in bytes.

Returns:

see above

Since:

0.25

getSizeDiff

public int getSizeDiff()

Returns the change in page size caused by this revision.

Returns:

see above

Since:

0.28

toString

public String toString()

Returns a string representation of this revision.

Overrides:

toString in class Object

Returns:

see above

Since:

0.17

compareTo

public int compareTo(Wiki.Revision other)

Compares this revision to another revision based on the recentness of their timestamps.

Specified by:

compareTo in interface Comparable<Wiki.Revision>

Parameters:

other - the revision to compare

Returns:

whether this object is equal to

Since:

0.18

getPrevious

public Wiki.Revision getPrevious()
                          throws IOException

Gets the previous revision.

Returns:

the previous revision, or null if this is the first revision or this object was spawned via contribs().

Throws:

IOException - if a network error occurs

Since:

0.28

getNext

public Wiki.Revision getNext()
                      throws IOException

Gets the next revision.

Returns:

the next revision, or null if this is the last revision or this object was spawned via contribs().

Throws:

IOException - if a network error occurs

Since:

0.28

setRcid

public void setRcid(long rcid)

Sets the rcid of this revision, used for patrolling. This parameter is optional. This is publicly editable for subclassing.

Parameters:

rcid - the rcid of this revision (long)

Since:

0.17

getRcid

public long getRcid()

Gets the rcid of this revision for patrolling purposes.

Returns:

the rcid of this revision (long)

Since:

0.17

setRollbackToken

public void setRollbackToken(String token)

Sets a rollback token for this revision.

Parameters:

token - a rollback token

Since:

0.24

getRollbackToken

public String getRollbackToken()

Gets the rollback token for this revision. Can be null, and often for good reasons: cannot rollback or not top revision.

Returns:

the rollback token

Since:

0.24

rollback

public void rollback()
              throws IOException,
                     LoginException

Reverts this revision using the rollback method. See Wiki.rollback().

Throws:

IOException - if a network error occurs

CredentialNotFoundException - if not logged in or user is not an admin

CredentialExpiredException - if cookies have expired

AccountLockedException - if the user is blocked

LoginException

Since:

0.19

rollback

public void rollback(boolean bot,
            String reason)
              throws IOException,
                     LoginException

Reverts this revision using the rollback method. See Wiki.rollback().

Parameters:

bot - mark this and the reverted revision(s) as bot edits

reason - (optional) a custom reason

Throws:

IOException - if a network error occurs

CredentialNotFoundException - if not logged in or user is not an admin

CredentialExpiredException - if cookies have expired

AccountLockedException - if the user is blocked

LoginException

Since:

0.19