net.wildfyre.users

Class Users

java.lang.Object

net.wildfyre.users.Users

public class Users
extends Object

Method Summary

Modifier and Type	Method and Description
static CacheManager	cacheManager() The Cache Manager that handles Users.
static void	clean() Cleans the internal cache, by removing the users that have expired.
static void	clear() The full User cache is cleared, no User is kept.
static Optional<User>	get(int id) Retrieves a user from the database.
static Optional<User>	getCached(int id) Retrieves the user corresponding to a provided ID from the cache.
static void	init() Prepares this class to serve Users.
static boolean	isMyID(int id)
static LoggedUser	me() The user that is connected to the API.
static OptionalInt	myID()
static void	reset() Resets the stored data of this class, that is dependent on the logged-in user.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static Optional<User> get(int id)

Retrieves a user from the database.

If the user is in the cache, it is returned. If the user is not in the cache, this method stalls and queries the server. If the user is in the cache but has expired, it is returned and a concurrent update job starts.

Note that this API is written so that IDs are not needed for the typical user.

This method intentionally doesn't throw any exceptions, because it is designed to be used in a concurrent fashion. If any occurs, they are sent to the exceptions handlers, see Internal.setCantConnectHandler(Consumer).

Parameters:

id - the ID of the user.

Returns:

The user, if any was found.

See Also:

Same, but without querying the server

getCached

public static Optional<User> getCached(int id)

Retrieves the user corresponding to a provided ID from the cache. This method is not designed to be used often, as it is only of any use in the rare case where the lib needs to access the cache itself. Therefore, it has a few shortcomings, listed below. If this does not exactly fit what you're searching for, you should see this method.

This method will not query the server in any way. It only returns the contents of the cache for that specific ID.

As a side effect, this method will not update the user either. This means that the User's inherent timer (see the Descriptor class for more information) will not be reset, as this does not count as a usage of the User.

Parameters:

id - the ID of the user.

Returns:

The user, or an empty optional if it is not found in the cache.

See Also:

Same, but queries the server is the user is not found in the cache.

me

public static LoggedUser me()

The user that is connected to the API.

Returns:

The user that is connected to the API.

clear

public static void clear()

The full User cache is cleared, no User is kept.

clean

public static void clean()

Cleans the internal cache, by removing the users that have expired.

reset

public static void reset()

Resets the stored data of this class, that is dependent on the logged-in user. It is necessary to call this method if you'd like to disconnect and reconnect as an other user.

init

public static void init()
                 throws Request.CantConnectException

Prepares this class to serve Users. This method must be called after the token is set, but before any work is done on Areas or Posts. This method must be called again if you modify the token.

Throws:

Request.CantConnectException - if no connection to the server can be established.

isMyID

public static boolean isMyID(int id)

myID

public static OptionalInt myID()

cacheManager

public static CacheManager cacheManager()

The Cache Manager that handles Users.

Returns:

The User Cache Manager.