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 String	avatar
protected String	bio
protected int	ID
protected boolean	isBanned
protected String	name

Method Summary

Modifier and Type	Method and Description
LoggedUser	asLogged() This object, as a LoggedUser.
Optional<String>	avatar() The avatar of this user: the raw URL written in a String object, as specified by the server.
Optional<URL>	avatarUrl() The avatar of this user: a URL object is created and points to the location of the avatar picture.
String	bio() The bio of this user.
CacheManager	cacheManager() The Cache Manager that handles this object.
boolean	canEdit() Can this user be edited?
boolean	equals(Object o)
int	getID() The ID of this user.
int	hashCode()
boolean	isBanned() Is this user banned?
String	name() The name of this user.
String	toString()
void	update() Updates this Descriptor.

Methods inherited from class net.wildfyre.descriptors.Descriptor

isNew, isValid, isValid, 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 String name

avatar

protected String avatar

bio

protected String bio

isBanned

protected boolean isBanned

Method Detail

update

public void update()
            throws NoSuchEntityException,
                   net.wildfyre.http.Request.CantConnectException

Description copied from class: Descriptor

Updates this Descriptor.

The update is always executed in the current thread.

Specified by:

update in class Descriptor

Throws:

NoSuchEntityException

net.wildfyre.http.Request.CantConnectException

cacheManager

public CacheManager cacheManager()

Description copied from class: Descriptor

The Cache Manager that handles this object.

Specified by:

cacheManager in class Descriptor

Returns:

This object.

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 ClassCastException

This object, as a LoggedUser.

Returns:

This object, as a LoggedUser.

Throws:

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.

avatar

public Optional<String> avatar()

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

Returns:

The avatar of this user.

avatarUrl

public Optional<URL> avatarUrl()

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.

bio

public String bio()

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.

name

public String name()

The name of this user.

Returns:

The name of this user.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object