org.spongepowered.api.profile

Interface GameProfileCache

public interface GameProfileCache

Represents a cache of GameProfiles.

Method Summary

Modifier and Type	Method and Description
default boolean	add(GameProfile profile) Add an entry to this cache.
default boolean	add(GameProfile profile, boolean overwrite, Date expiry) Deprecated. Use add(GameProfile, boolean, Instant)
boolean	add(GameProfile profile, boolean overwrite, Instant expiry) Add an entry to this cache, with an optional expiration date.
default boolean	add(GameProfile profile, Date expiry) Deprecated. Use add(GameProfile, Instant)
default boolean	add(GameProfile profile, Instant expiry) Add an entry to this cache, with an optional expiration date.
void	clear() Clear all entries from this cache.
default Optional<GameProfile>	fillProfile(GameProfile profile) Fills a GameProfile from cached values.
Optional<GameProfile>	fillProfile(GameProfile profile, boolean signed) Fills a GameProfile from cached values.
Optional<GameProfile>	getById(UUID uniqueId) Gets a GameProfile from this cache by its unique id.
Map<UUID,Optional<GameProfile>>	getByIds(Iterable<UUID> uniqueIds) Gets GameProfiles in bulk by their unique id.
Optional<GameProfile>	getByName(String name) Gets a GameProfile from this cache by its name.
Map<String,Optional<GameProfile>>	getByNames(Iterable<String> names) Gets GameProfiles in bulk by their name.
Optional<GameProfile>	getOrLookupById(UUID uniqueId) Gets a GameProfile from this cache by its id if available, or lookups the profile by its unique id.
Map<UUID,Optional<GameProfile>>	getOrLookupByIds(Iterable<UUID> uniqueIds) Gets GameProfiles in bulk from this cache by when available, and lookups the profiles by their unique id when not cached.
Optional<GameProfile>	getOrLookupByName(String name) Gets a GameProfile from this cache by its if available, or lookups the profile by its name.
Map<String,Optional<GameProfile>>	getOrLookupByNames(Iterable<String> names) Gets GameProfiles in bulk from this cache by when available, and lookups the profiles by their unique id when not cached.
Collection<GameProfile>	getProfiles() Gets a collection of all cached GameProfiles.
Optional<GameProfile>	lookupById(UUID uniqueId) Looks a GameProfile up by its unique id and loads it into this cache.
Map<UUID,Optional<GameProfile>>	lookupByIds(Iterable<UUID> uniqueIds) Looks up GameProfiles in bulk by their unique id and loads them into this cache.
Optional<GameProfile>	lookupByName(String name) Looks a GameProfile up by its name and loads it into this cache.
Map<String,Optional<GameProfile>>	lookupByNames(Iterable<String> names) Looks up GameProfiles in bulk by their name and loads them into this cache.
Collection<GameProfile>	match(String name) Returns a collection of matching cached GameProfiles whose last known names start with the given string (case-insensitive).
boolean	remove(GameProfile profile) Remove an entry from this cache.
Collection<GameProfile>	remove(Iterable<GameProfile> profiles) Remove entries from this cache in bulk.

Method Detail

add

default boolean add(GameProfile profile)

Add an entry to this cache.

Parameters:

profile - The profile to cache

Returns:

true if the profile was successfully cached, otherwise false

add

@Deprecated
default boolean add(GameProfile profile,
                                @Nullable
                                Date expiry)

Deprecated. Use add(GameProfile, Instant)

Add an entry to this cache, with an optional expiration date.

Parameters:

profile - The profile to cache

expiry - The expiration date

Returns:

true if the profile was successfully cached, otherwise false

add

default boolean add(GameProfile profile,
                    @Nullable
                    Instant expiry)

Add an entry to this cache, with an optional expiration date.

Parameters:

profile - The profile to cache

expiry - The expiration date

Returns:

true if the profile was successfully cached, otherwise false

add

@Deprecated
default boolean add(GameProfile profile,
                                boolean overwrite,
                                @Nullable
                                Date expiry)

Deprecated. Use add(GameProfile, boolean, Instant)

Add an entry to this cache, with an optional expiration date.

Parameters:

profile - The profile to cache

overwrite - If we should overwrite the cache entry for the provided profile

expiry - The expiration date

Returns:

true if the profile was successfully cached, otherwise false

add

boolean add(GameProfile profile,
            boolean overwrite,
            @Nullable
            Instant expiry)

Add an entry to this cache, with an optional expiration date.

Parameters:

profile - The profile to cache

overwrite - If we should overwrite the cache entry for the provided profile

expiry - The expiration date

Returns:

true if the profile was successfully cached, otherwise false

remove

boolean remove(GameProfile profile)

Remove an entry from this cache.

Parameters:

profile - The profile to remove from the cache

Returns:

true if the profile was successfully removed, otherwise false

remove

Collection<GameProfile> remove(Iterable<GameProfile> profiles)

Remove entries from this cache in bulk.

Parameters:

profiles - The profiles to remove from the cache

Returns:

A collection of profiles successfully removed

clear

void clear()

Clear all entries from this cache.

getById

Optional<GameProfile> getById(UUID uniqueId)

Gets a GameProfile from this cache by its unique id.

Parameters:

uniqueId - The unique id of the profile

Returns:

The profile, if present, or Optional.empty() if the cache did not contain a profile with the provided id

getByIds

Map<UUID,Optional<GameProfile>> getByIds(Iterable<UUID> uniqueIds)

Gets GameProfiles in bulk by their unique id.

Parameters:

uniqueIds - The unique ids

Returns:

A collection of successfully found up profiles

lookupById

Optional<GameProfile> lookupById(UUID uniqueId)

Looks a GameProfile up by its unique id and loads it into this cache.

Parameters:

uniqueId - The unique id of the profile

Returns:

The profile, if present, or Optional.empty() if we couldn't find a profile with the provided id

lookupByIds

Map<UUID,Optional<GameProfile>> lookupByIds(Iterable<UUID> uniqueIds)

Looks up GameProfiles in bulk by their unique id and loads them into this cache.

Parameters:

uniqueIds - The unique ids

Returns:

A collection of successfully looked up profiles

getOrLookupById

Optional<GameProfile> getOrLookupById(UUID uniqueId)

Gets a GameProfile from this cache by its id if available, or lookups the profile by its unique id.

Parameters:

uniqueId - The unique id of the profile

Returns:

The profile, if present, or Optional.empty() if the cache did not contain a profile with the provided id and we couldn't lookup a profile with the provided id

getOrLookupByIds

Map<UUID,Optional<GameProfile>> getOrLookupByIds(Iterable<UUID> uniqueIds)

Gets GameProfiles in bulk from this cache by when available, and lookups the profiles by their unique id when not cached.

Parameters:

uniqueIds - The unique ids of the profiles

Returns:

A collection of successfully found profiles

getByName

Optional<GameProfile> getByName(String name)

Gets a GameProfile from this cache by its name.

Parameters:

name - The name of the profile

Returns:

The profile, if present, or Optional.empty() if the cache did not contain a profile with the provided name

getByNames

Map<String,Optional<GameProfile>> getByNames(Iterable<String> names)

Gets GameProfiles in bulk by their name.

Parameters:

names - The names

Returns:

A collection of successfully found up profiles

lookupByName

Optional<GameProfile> lookupByName(String name)

Looks a GameProfile up by its name and loads it into this cache.

Parameters:

name - The name of the profile

Returns:

The profile, if present, or Optional.empty() if we couldn't find a profile with the provided name

lookupByNames

Map<String,Optional<GameProfile>> lookupByNames(Iterable<String> names)

Looks up GameProfiles in bulk by their name and loads them into this cache.

Parameters:

names - The names

Returns:

A collection of successfully looked up profiles

getOrLookupByName

Optional<GameProfile> getOrLookupByName(String name)

Gets a GameProfile from this cache by its if available, or lookups the profile by its name.

Parameters:

name - The name of the profile

Returns:

The profile, if present, or Optional.empty() if the cache did not contain a profile with the provided name and we couldn't lookup a profile with the provided name

getOrLookupByNames

Map<String,Optional<GameProfile>> getOrLookupByNames(Iterable<String> names)

Gets GameProfiles in bulk from this cache by when available, and lookups the profiles by their unique id when not cached.

Parameters:

names - The names of the profiles

Returns:

A collection of successfully found profiles

fillProfile

default Optional<GameProfile> fillProfile(GameProfile profile)

Fills a GameProfile from cached values.

Parameters:

profile - The profile to fill

Returns:

The filled profile, if present, or Optional.empty() if we were unable to fill the profile

fillProfile

Optional<GameProfile> fillProfile(GameProfile profile,
                                  boolean signed)

Fills a GameProfile from cached values.

Parameters:

profile - The profile to fill

signed - true if we should request that the profile data be signed

Returns:

The filled profile, if present, or Optional.empty() if we were unable to fill the profile

getProfiles

Collection<GameProfile> getProfiles()

Gets a collection of all cached GameProfiles.

Returns:

A Collection of cached GameProfiles

match

Collection<GameProfile> match(String name)

Returns a collection of matching cached GameProfiles whose last known names start with the given string (case-insensitive).

This collection may also contain profiles of players who never played on the server!

Use UserStorageService.match(String) for a collection that only contains GameProfiles with attached User data.

This method only searches the local cache, so the data may not be up to date.

Parameters:

name - The name

Returns:

A Collection of matching GameProfiles