org.wikipedia

Class Wiki.User

java.lang.Object

org.wikipedia.Wiki.User

All Implemented Interfaces:

Serializable, Cloneable

Enclosing class:

Wiki

public class Wiki.User
extends Object
implements Cloneable, Serializable

Subclass for wiki users.

Since:

0.05

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	User(String username) Creates a new user object.

Method Summary

Modifier and Type	Method and Description
Wiki.LogEntry[]	blockLog() Returns a log of the times when the user has been blocked.
Wiki.User	clone() Copies this user object.
Wiki.Revision[]	contribs(int... ns) Fetches the contributions for this user in a particular namespace(s).
int	countEdits() Fetches the internal edit count for this user, which includes all live edits and deleted edits after (I think) January 2007.
boolean	equals(Object x) Tests whether this user is equal to another one.
Map<String,Object>	getUserInfo() Gets various properties of this user.
String	getUsername() Gets this user's username.
int	hashCode() Returns a hashcode of this user.
boolean	isA(String group) Returns true if the user is a member of the specified group.
boolean	isAllowedTo(String right) Returns true if the user is allowed to perform the specified action.
boolean	isBlocked() Determines whether this user is blocked by looking it up on the IP block list.
String	toString() Returns a string representation of this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

protected User(String username)

Creates a new user object. Does not create a new user on the wiki (we don't implement this for a very good reason). Shouldn't be called for anons.

Parameters:

username - the username of the user

Since:

0.05

Method Detail

getUsername

public String getUsername()

Gets this user's username.

Returns:

this user's username

Since:

0.08

getUserInfo

public Map<String,Object> getUserInfo()
                               throws IOException

Gets various properties of this user. Groups and rights are cached for the current logged in user. Returns:

• editcount: (int) countEdits() the user's edit count
• groups: (String[]) the groups the user is in (see [[Special:Listgrouprights]])
• rights: (String[]) the stuff the user can do
• emailable: (Boolean) whether the user can be emailed through [[Special:Emailuser]] or emailUser()
• blocked: (Boolean) whether the user is blocked
• gender: (Wiki.Gender) the user's gender
• created: (Calendar) when the user account was created

Returns:

(see above)

Throws:

IOException - if a network error occurs

Since:

0.24

isAllowedTo

public boolean isAllowedTo(String right)
                    throws IOException

Returns true if the user is allowed to perform the specified action. Uses the rights cache. Read [[Special:Listgrouprights]] before using this!

Parameters:

right - a specific action

Returns:

whether the user is allowed to execute it

Throws:

IOException - if a network error occurs

Since:

0.24

isA

public boolean isA(String group)
            throws IOException

Returns true if the user is a member of the specified group. Uses the groups cache.

Parameters:

group - a specific group

Returns:

whether the user is in it

Throws:

IOException - if a network error occurs

Since:

0.24

blockLog

public Wiki.LogEntry[] blockLog()
                         throws IOException

Returns a log of the times when the user has been blocked.

Returns:

records of the occasions when this user has been blocked

Throws:

IOException - if something goes wrong

Since:

0.08

isBlocked

public boolean isBlocked()
                  throws IOException

Determines whether this user is blocked by looking it up on the IP block list.

Returns:

whether this user is blocked

Throws:

IOException - if we cannot retrieve the IP block list

Since:

0.12

countEdits

public int countEdits()
               throws IOException

Fetches the internal edit count for this user, which includes all live edits and deleted edits after (I think) January 2007. If you want to count live edits only, use the slower int count = user.contribs().length;.

Returns:

the user's edit count

Throws:

IOException - if a network error occurs

Since:

0.16

contribs

public Wiki.Revision[] contribs(int... ns)
                         throws IOException

Fetches the contributions for this user in a particular namespace(s).

Parameters:

ns - a list of namespaces to filter by, empty = all namespaces.

Returns:

a revision array of contributions

Throws:

IOException - if a network error occurs

Since:

0.17

clone

public Wiki.User clone()

Copies this user object.

Overrides:

clone in class Object

Returns:

the copy

Since:

0.08

equals

public boolean equals(Object x)

Tests whether this user is equal to another one.

Overrides:

equals in class Object

Parameters:

x - another object

Returns:

whether the users are equal

Since:

0.08

toString

public String toString()

Returns a string representation of this user.

Overrides:

toString in class Object

Returns:

see above

Since:

0.17

hashCode

public int hashCode()

Returns a hashcode of this user.

Overrides:

hashCode in class Object

Returns:

see above

Since:

0.19