me.lucko.helper.profiles

Interface ProfileRepository

public interface ProfileRepository

A repository of profiles, which can get or lookup Profile instances for given unique ids or names.

Methods which are prefixed with get perform a quick local search, and return no result if no value is cached locally.

Methods which are prefixed with lookup perform a more complete search, usually querying an underlying database.

Method Summary

Modifier and Type	Method and Description
Collection<Profile>	getKnownProfiles() Gets a collection of profiles known to the repository.
Optional<Profile>	getProfile(String name) Gets a profile from this repository, using the name as the base for the request.
Profile	getProfile(UUID uniqueId) Gets a profile from this repository, using the unique id as the base for the request.
default Map<UUID,Profile>	getProfiles(Iterable<UUID> uniqueIds) Populates a map of unique id to profile for the given iterable of unique ids.
default Map<String,Profile>	getProfilesByName(Iterable<String> names) Populates a map of name to profile for the given iterable of names.
Promise<Collection<Profile>>	lookupKnownProfiles() Gets a collection of profiles known to the repository.
Promise<Optional<Profile>>	lookupProfile(String name) Gets a profile from this repository, using the name as the base for the request.
Promise<Profile>	lookupProfile(UUID uniqueId) Gets a profile from this repository, using the unique id as the base for the request.
Promise<Map<UUID,Profile>>	lookupProfiles(Iterable<UUID> uniqueIds) Populates a map of unique id to profile for the given iterable of unique ids.
Promise<Map<String,Profile>>	lookupProfilesByName(Iterable<String> names) Populates a map of name to profile for the given iterable of names.

Method Detail

getProfile

@Nonnull
Profile getProfile(@Nonnull
                            UUID uniqueId)

Gets a profile from this repository, using the unique id as the base for the request.

If this repository does not contain a profile matching the unique id, a profile will still be returned, but will not be populated with a name.

Parameters:

uniqueId - the unique id to get a profile for

Returns:

a profile for the uuid

getProfile

@Nonnull
Optional<Profile> getProfile(@Nonnull
                                      String name)

Gets a profile from this repository, using the name as the base for the request.

If this repository does not contain a profile matching the name, an empty optional will be returned.

In the case that there is more than one profile in the repository matching the name, the most up-to-date record is returned.

Parameters:

name - the name to get a profile for

Returns:

a profile for the name

getKnownProfiles

@Nonnull
Collection<Profile> getKnownProfiles()

Gets a collection of profiles known to the repository.

Returned profiles will always be populated with both a unique id and a username.

Returns:

a collection of known profiles

getProfiles

@Nonnull
default Map<UUID,Profile> getProfiles(@Nonnull
                                               Iterable<UUID> uniqueIds)

Populates a map of unique id to profile for the given iterable of unique ids.

The map will only contain an entry for each given unique id if there is a corresponding profile for the unique id in the repository.

Parameters:

uniqueIds - the unique ids to get profiles for

Returns:

a map of uuid to profile, where possible, for each uuid in the iterable

See Also:

getProfile(UUID)

getProfilesByName

@Nonnull
default Map<String,Profile> getProfilesByName(@Nonnull
                                                       Iterable<String> names)

Populates a map of name to profile for the given iterable of names.

The map will only contain an entry for each given name if there is a corresponding profile for the name in the repository.

Parameters:

names - the names to get profiles for

Returns:

a map of name to profile, where possible, for each name in the iterable

See Also:

getProfile(String)

lookupProfile

@Nonnull
Promise<Profile> lookupProfile(@Nonnull
                                        UUID uniqueId)

Gets a profile from this repository, using the unique id as the base for the request.

If this repository does not contain a profile matching the unique id, a profile will still be returned, but will not be populated with a name.

Parameters:

uniqueId - the unique id to get a profile for

Returns:

a profile for the uuid

lookupProfile

@Nonnull
Promise<Optional<Profile>> lookupProfile(@Nonnull
                                                  String name)

Gets a profile from this repository, using the name as the base for the request.

If this repository does not contain a profile matching the name, an empty optional will be returned.

In the case that there is more than one profile in the repository matching the name, the most up-to-date record is returned.

Parameters:

name - the name to get a profile for

Returns:

a profile for the name

lookupKnownProfiles

@Nonnull
Promise<Collection<Profile>> lookupKnownProfiles()

Gets a collection of profiles known to the repository.

Returned profiles will always be populated with both a unique id and a username.

Returns:

a collection of known profiles

lookupProfiles

@Nonnull
Promise<Map<UUID,Profile>> lookupProfiles(@Nonnull
                                                   Iterable<UUID> uniqueIds)

Populates a map of unique id to profile for the given iterable of unique ids.

The map will only contain an entry for each given unique id if there is a corresponding profile for the unique id in the repository.

Parameters:

uniqueIds - the unique ids to get profiles for

Returns:

a map of uuid to profile, where possible, for each uuid in the iterable

See Also:

getProfile(UUID)

lookupProfilesByName

@Nonnull
Promise<Map<String,Profile>> lookupProfilesByName(@Nonnull
                                                           Iterable<String> names)

Populates a map of name to profile for the given iterable of names.

The map will only contain an entry for each given name if there is a corresponding profile for the name in the repository.

Parameters:

names - the names to get profiles for

Returns:

a map of name to profile, where possible, for each name in the iterable

See Also:

getProfile(String)