Package org.spongepowered.api.profile

Interface GameProfileProvider

All Known Subinterfaces:

GameProfileManager

public interface GameProfileProvider

A provider which can be used to lookup GameProfiles.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<GameProfile>	basicProfile(String name)	Attempts to get a basic GameProfile for the given name.
CompletableFuture<GameProfile>	basicProfile(String name, @Nullable Instant time)	Attempts to get a basic GameProfile for the given name.
CompletableFuture<GameProfile>	basicProfile(UUID uniqueId)	Attempts to get a basic GameProfile for the given unique id.
default CompletableFuture<Map<String,GameProfile>>	basicProfiles(Iterable<String> names)	Attempts to get a basic GameProfiles for the given names.
CompletableFuture<Map<String,GameProfile>>	basicProfiles(Iterable<String> names, @Nullable Instant time)	Attempts to get a basic GameProfiles for the given names.
default CompletableFuture<GameProfile>	profile(String name)	Attempts to get a full GameProfile for the given name.
CompletableFuture<GameProfile>	profile(String name, boolean signed)	Attempts to get a full GameProfile for the given name.
default CompletableFuture<GameProfile>	profile(UUID uniqueId)	Attempts to get a full GameProfile for the given unique id.
CompletableFuture<GameProfile>	profile(UUID uniqueId, boolean signed)	Attempts to get a full GameProfile for the given unique id.
default CompletableFuture<GameProfile>	profile(GameProfile profile)	Attempts to get a full GameProfile for the given profile.
default CompletableFuture<GameProfile>	profile(GameProfile profile, boolean signed)	Attempts to get a full GameProfile for the given profile.

Method Detail

basicProfile

CompletableFuture<GameProfile> basicProfile(UUID uniqueId)

Attempts to get a basic GameProfile for the given unique id.

Basic game profiles don't include any profile properties.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given unique id.

Parameters:

uniqueId - The unique id

Returns:

The profile found for the given unique id

basicProfile

default CompletableFuture<GameProfile> basicProfile(String name)

Attempts to get a basic GameProfile for the given name.

Basic game profiles don't include any profile properties.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

The requested name is matched case insensitively, the corrected name will be present in the GameProfile.

Parameters:

name - The name

Returns:

The profile found for the given name

basicProfile

CompletableFuture<GameProfile> basicProfile(String name,
                                            @Nullable Instant time)

Attempts to get a basic GameProfile for the given name.

Basic game profiles don't include any profile properties.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

The requested name is matched case insensitively, the corrected name will be present in the GameProfile.

Parameters:

name - The name

time - The time at which the name was assigned to a specific profile, or null if current

Returns:

The profile found for the given name

basicProfiles

default CompletableFuture<Map<String,GameProfile>> basicProfiles(Iterable<String> names)

Attempts to get a basic GameProfiles for the given names.

Basic game profiles don't include any profile properties.

The requested names are matched case insensitively, the corrected names will be present in the GameProfiles.

Parameters:

names - The names

Returns:

The profiles found for the given names

basicProfiles

CompletableFuture<Map<String,GameProfile>> basicProfiles(Iterable<String> names,
                                                               @Nullable Instant time)

Attempts to get a basic GameProfiles for the given names.

Basic game profiles don't include any profile properties.

The requested names are matched case insensitively, the corrected names will be present in the GameProfiles.

Parameters:

names - The names

time - The time at which the names were assigned to specific profiles, or null if current

Returns:

The profiles found for the given names

profile

default CompletableFuture<GameProfile> profile(GameProfile profile)

Attempts to get a full GameProfile for the given profile.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the unique id of the given profile.

Parameters:

profile - The profile

Returns:

The profile found for the given unique id

profile

default CompletableFuture<GameProfile> profile(GameProfile profile,
                                               boolean signed)

Attempts to get a full GameProfile for the given profile.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the unique id of the given profile.

Parameters:

profile - The profile

signed - Whether property values should be signed

Returns:

The profile found for the given unique id

profile

default CompletableFuture<GameProfile> profile(String name)

Attempts to get a full GameProfile for the given name.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

Parameters:

name - The name

Returns:

The profile found for the given name

profile

default CompletableFuture<GameProfile> profile(UUID uniqueId)

Attempts to get a full GameProfile for the given unique id.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given unique id.

Parameters:

uniqueId - The unique id

Returns:

The profile found for the given unique id

profile

CompletableFuture<GameProfile> profile(String name,
                                       boolean signed)

Attempts to get a full GameProfile for the given name.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given name.

Parameters:

name - The name

signed - Whether property values should be signed

Returns:

The profile found for the given name

profile

CompletableFuture<GameProfile> profile(UUID uniqueId,
                                       boolean signed)

Attempts to get a full GameProfile for the given unique id.

The CompletableFuture can fail with a ProfileNotFoundException if no profile was found with the given unique id.

Parameters:

uniqueId - The unique id

signed - Whether property values should be signed

Returns:

The profile found for the given unique id