com.elikill58.negativity.universal.account

Class NegativityAccountManager

java.lang.Object

com.elikill58.negativity.universal.account.NegativityAccountManager

Direct Known Subclasses:

SimpleAccountManager

public abstract class NegativityAccountManager
extends Object

Constructor Summary

Constructors

Constructor and Description
NegativityAccountManager()

Method Summary

Modifier and Type	Method and Description
abstract @Nullable NegativityAccount	dispose(UUID accountId) Indicates that the account for the given UUID can be forgotten by this manager.
abstract CompletableFuture<NegativityAccount>	get(UUID accountId) Gets the account associated to the given UUID wrapped in a CompletableFuture.
NegativityAccount	getNow(UUID accountId) Gets the account associated to the given UUID in a blocking manner.
abstract CompletableFuture<Void>	save(UUID accountId) Saves the account associated to the given UUID.
abstract void	update(NegativityAccount account) Makes this manager use the the given account's data instead of what it may have already.

Methods inherited from class java.lang.Object

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

Constructor Detail

NegativityAccountManager

public NegativityAccountManager()

Method Detail

get

public abstract CompletableFuture<NegativityAccount> get(UUID accountId)

Gets the account associated to the given UUID wrapped in a CompletableFuture.

The account may be returned directly (if cached for example), or loaded via potential (slow) IO operations.

Ideally, cancelling the returned CompletableFuture will cancel the underlying (potentially slow) operations to avoid wasting resources.

Parameters:

accountId - the ID of the account to get

Returns:

the requested account wrapped in a CompletableFuture

See Also:

getNow(java.util.UUID)

getNow

public NegativityAccount getNow(UUID accountId)

Gets the account associated to the given UUID in a blocking manner.

This is equivalent to calling get(accountId).join()

This method may throw CompletionException according to CompletableFuture.join(), and is unlikely (but still may) throw CancellationException.

Parameters:

accountId - the ID of the account to get

Returns:

the requested account

save

public abstract CompletableFuture<Void> save(UUID accountId)

Saves the account associated to the given UUID. The returned CompletableFuture will be completed once the save has been done, and may complete exceptionally if it failed in some way.

Parameters:

accountId - the ID of the account to save

Returns:

a CompletableFuture that will complete once the save has been done

update

public abstract void update(NegativityAccount account)

Makes this manager use the the given account's data instead of what it may have already.

Parameters:

account - the account to use

dispose

public abstract @Nullable NegativityAccount dispose(UUID accountId)

Indicates that the account for the given UUID can be forgotten by this manager.

What this method does is completely up to the implementing class, it may do nothing, or remove the account from a cache for example.

If an implementation caches accounts, the returned account would be the one removed from its cache.

Parameters:

accountId - the ID of the account to dispose

Returns:

the disposed account, if available