org.wikipedia

Class Wiki.LogEntry

java.lang.Object

org.wikipedia.Wiki.LogEntry

All Implemented Interfaces:

Comparable<Wiki.LogEntry>

Enclosing class:

Wiki

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

A wrapper class for an entry in a wiki log, which represents an action performed on the wiki.

Since:

0.08

See Also:

Wiki.getLogEntries(int)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogEntry(String type, String action, String reason, Wiki.User user, String target, String timestamp, Object details) Creates a new log entry.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Wiki.LogEntry other) Compares this log entry to another one based on the recentness of their timestamps.
String	getAction() Gets a string description of the action performed, for example "delete", "protect", "overwrite", ...
Object	getDetails() Gets the details of this log entry.
String	getReason() Gets the reason supplied by the perfoming user when the action was performed.
String	getTarget() Gets the target of the action represented by this log entry.
Calendar	getTimestamp() Gets the timestamp of this log entry.
String	getType() Gets the type of log that this entry is in.
Wiki.User	getUser() Gets the user object representing who performed the action.
String	toString() Returns a string representation of this log entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogEntry

protected LogEntry(String type,
                   String action,
                   String reason,
                   Wiki.User user,
                   String target,
                   String timestamp,
                   Object details)

Creates a new log entry. WARNING: does not perform the action implied. Use Wiki.class methods to achieve this.

Parameters:

type - the type of log entry, one of USER_CREATION_LOG, DELETION_LOG, BLOCK_LOG, etc.

action - the type of action that was performed e.g. "delete", "unblock", "overwrite", etc.

reason - why the action was performed

user - the user who performed the action

target - the target of the action

timestamp - the local time when the action was performed. We will convert this back into a Calendar.

details - the details of the action (e.g. the new title of the page after a move was performed).

Since:

0.08

Method Detail

getType

public String getType()

Gets the type of log that this entry is in.

Returns:

one of DELETION_LOG, USER_CREATION_LOG, BLOCK_LOG, etc.

Since:

0.08

getAction

public String getAction()

Gets a string description of the action performed, for example "delete", "protect", "overwrite", ... WARNING: returns null if the action was RevisionDeleted.

Returns:

the type of action performed

Since:

0.08

getReason

public String getReason()

Gets the reason supplied by the perfoming user when the action was performed. WARNING: returns null if the reason was RevisionDeleted.

Returns:

the reason the action was performed

Since:

0.08

getUser

public Wiki.User getUser()

Gets the user object representing who performed the action. WARNING: returns null if the user was RevisionDeleted.

Returns:

the user who performed the action.

Since:

0.08

getTarget

public String getTarget()

Gets the target of the action represented by this log entry. WARNING: returns null if the content was RevisionDeleted.

Returns:

the target of this log entry

Since:

0.08

getTimestamp

public Calendar getTimestamp()

Gets the timestamp of this log entry.

Returns:

the timestamp of this log entry

Since:

0.08

getDetails

public Object getDetails()

Gets the details of this log entry. Return values are as follows:

Log type	Return value
MOVE_LOG	The new page title
USER_RENAME_LOG	The new username
BLOCK_LOG	new Object[] { boolean anononly, boolean nocreate, boolean noautoblock, boolean noemail, boolean nousertalk, String duration }
USER_RIGHTS_LOG	The new user rights (String[])
PROTECTION_LOG	action == "protect" or "modify" => the protection level (int, -2 if unrecognized), action == "move_prot" => the old title, else null
Others or RevisionDeleted	null

Note that the duration of a block may be given as a period of time (e.g. "31 hours") or a timestamp (e.g. 20071216160302). To tell these apart, feed it into Long.parseLong() and catch any resulting exceptions.

Returns:

the details of the log entry

Since:

0.08

toString

public String toString()

Returns a string representation of this log entry.

Overrides:

toString in class Object

Returns:

a string representation of this object

Since:

0.08

compareTo

public int compareTo(Wiki.LogEntry other)

Compares this log entry to another one based on the recentness of their timestamps.

Specified by:

compareTo in interface Comparable<Wiki.LogEntry>

Parameters:

other - the log entry to compare

Returns:

whether this object is equal to

Since:

0.18