net.wildfyre.users

Class User

java.lang.Object

net.wildfyre.descriptors.Descriptor

net.wildfyre.users.User

Direct Known Subclasses:

LoggedUser

public class User
extends Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	avatar
protected java.lang.String	bio
protected int	ID
protected boolean	isBanned
protected java.lang.String	name

Method Summary

Modifier and Type	Method and Description
LoggedUser	asLogged() This object, as a LoggedUser.
boolean	canEdit() Can this user be edited?
boolean	equals(java.lang.Object o)
java.lang.String	getAvatar() The avatar of this user: the raw URL written in a String object, as specified by the server.
java.net.URL	getAvatarUrl() The avatar of this user: a URL object is created and points to the location of the avatar picture.
java.lang.String	getBio() The bio of this user.
int	getID() The ID of this user.
java.lang.String	getName() The name of this user.
int	hashCode()
boolean	isBanned() Is this user banned?
static User	query(int id) Retrieves a specific user by ID.
java.lang.String	toString()
void	update() Updates this Descriptor.

Methods inherited from class net.wildfyre.descriptors.Descriptor

isNew, isValid, isValid, setTimeBeforeRemoval, use

Methods inherited from class java.lang.Object

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

Field Detail

ID

protected final int ID

name

protected java.lang.String name

avatar

protected java.lang.String avatar

bio

protected java.lang.String bio

isBanned

protected boolean isBanned

Method Detail

update

public void update()

Description copied from class: Descriptor

Updates this Descriptor.

The update is always executed in the current thread.

Specified by:

update in class Descriptor

query

public static User query(int id)

Retrieves a specific user by ID. Here are some details on how this method works:

If the user is NOT cached, the method stalls and queries the server. If the user is cached, the method returns the cached user immediately. If the user is cached but has expired, the method immediately returns the expired version and launches a refresh job that will be executed concurrently.

You can know if the user you got is being refreshed or not by checking its Descriptor.isValid() method.

Parameters:

id - the ID of the user

Returns:

The requested user.

canEdit

public boolean canEdit()

Can this user be edited?

This method will always return false for a User, and will always return true for a LoggedUser

Returns:

true if the user's information can edited.

See Also:

Get this object as a LoggedUser

asLogged

public final LoggedUser asLogged()
                          throws java.lang.ClassCastException

This object, as a LoggedUser.

Returns:

This object, as a LoggedUser.

Throws:

java.lang.ClassCastException - if this object cannot be converted to a LoggedUser.

See Also:

Can this object be converted to a LoggedUser?

getID

public int getID()

The ID of this user.

Returns:

The ID of this user, a positive integer.

getAvatar

public java.lang.String getAvatar()

The avatar of this user: the raw URL written in a String object, as specified by the server.

Returns:

The avatar of this user.

getAvatarUrl

public java.net.URL getAvatarUrl()

The avatar of this user: a URL object is created and points to the location of the avatar picture.

Returns:

The avatar of this user.

getBio

public java.lang.String getBio()

The bio of this user.

Returns:

The bio of this user.

isBanned

public boolean isBanned()

Is this user banned?

Returns:

true if this user is banned.

getName

public java.lang.String getName()

The name of this user.

Returns:

The name of this user.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object