Interface UserManager
-
public interface UserManager
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompletableFuture<Boolean>
delete(UUID uuid)
Deletes the data associated with aUser
, if the player is offline.boolean
exists(UUID playerUuid)
CompletableFuture<Boolean>
forceSave(UUID uuid)
If the implementation supports caching user objects, this will hint to the implementation that the user with the given UUID should be saved to the disk immediately.CompletableFuture<Optional<User>>
load(String lastKnownName)
Gets the data of aUser
by their last known user name (case-insensitive).CompletableFuture<Optional<User>>
load(UUID uniqueId)
Gets the data of aUser
by their unique id.CompletableFuture<Optional<User>>
load(GameProfile profile)
Gets the data of aUser
by theirGameProfile
.CompletableFuture<User>
loadOrCreate(UUID uuid)
Gets or creates a persistentUser
with the given UUID.boolean
removeFromCache(UUID uuid)
If the implementation supports caching user objects, this will hint to the implementation that the user with the given UUID should no longer be cached.Stream<GameProfile>
streamAll()
Stream<GameProfile>
streamOfMatches(String lastKnownName)
Gets aStream
that returns aGameProfile
for each storedUser
whose last known user names start with the given string (case-insensitive).
-
-
-
Method Detail
-
load
CompletableFuture<Optional<User>> load(UUID uniqueId)
Gets the data of aUser
by their unique id.- Parameters:
uniqueId
- The UUID of the user- Returns:
User
or Optional.empty() if not found
-
load
CompletableFuture<Optional<User>> load(String lastKnownName)
Gets the data of aUser
by their last known user name (case-insensitive).To get the current name of a player, use the
GameProfileManager
service.- Parameters:
lastKnownName
- The user name- Returns:
User
or Optional.empty() if not found
-
load
CompletableFuture<Optional<User>> load(GameProfile profile)
Gets the data of aUser
by theirGameProfile
.- Parameters:
profile
- The profile- Returns:
User
or Optional.empty() if not found
-
loadOrCreate
CompletableFuture<User> loadOrCreate(UUID uuid)
Gets or creates a persistentUser
with the given UUID.- Parameters:
uuid
- TheUUID
of the player to load or create.- Returns:
- The user object
-
delete
CompletableFuture<Boolean> delete(UUID uuid)
Deletes the data associated with aUser
, if the player is offline.- Parameters:
uuid
- The uuid of the user to delete- Returns:
- true if the deletion was successful
-
removeFromCache
boolean removeFromCache(UUID uuid)
If the implementation supports caching user objects, this will hint to the implementation that the user with the given UUID should no longer be cached. AnyUser
objects held that this point will become invalid (though developers should not be storing users).Be aware, any changes that have been made to the user may not be saved.
Users that are online will not be affected by this call.
- Parameters:
uuid
- The UUID of the user to save.- Returns:
true
if the user was removed from a cache.
-
forceSave
CompletableFuture<Boolean> forceSave(UUID uuid)
If the implementation supports caching user objects, this will hint to the implementation that the user with the given UUID should be saved to the disk immediately.If an exception is encountered during save, the completed future will be exceptional and the boolean will be
null
. It is therefore recommended that you check for any exceptions this future holds.- Parameters:
uuid
- The user to attempt to save.- Returns:
- A completed future that returns
true
if the implementation saved the user.
-
exists
boolean exists(UUID playerUuid)
Returns whether data to create aUser
exists for a given player with a specifiedUUID
.If this is
false
, thenload(UUID)
will return an empty optional.- Parameters:
playerUuid
- TheUUID
of the player to check.- Returns:
- If the player has existing user data that can be loaded.
-
streamAll
Stream<GameProfile> streamAll()
Gets aStream
that returns aGameProfile
for each storedUser
s.This
Stream
may contain profiles that only hold a result forIdentifiable.uniqueId()
, that is, do not return a user's name. Such profiles should thus be treated as incomplete and are no more than an indicator that aUser
associated with the givenUUID
exists.Similarly, for
GameProfile
s that are filled and thus contain name data, the profile information is based on the latest information the server holds and no attempt is made to update this information.If you require up to date
GameProfile
s, use the appropriate methods on theGameProfileManager
and/or its associatedGameProfileManager
.Use
load(GameProfile)
to load theUser
data associated with the associatedGameProfile
.- Returns:
- A
Stream
ofGameProfile
s
-
streamOfMatches
Stream<GameProfile> streamOfMatches(String lastKnownName)
Gets aStream
that returns aGameProfile
for each storedUser
whose last known user names start with the given string (case-insensitive).It is important to note that the names this method uses to perform the matching is based on the latest information the server holds and no attempt is made to update this information.
If you require up to date
GameProfile
s, use the appropriate methods on theGameProfileManager
and/or its associatedGameProfileManager
.Use
load(GameProfile)
to load associatedUser
data.- Parameters:
lastKnownName
- The name to check for- Returns:
- A
Stream
ofGameProfile
s
-
-