org.spongepowered.api.profile

Interface GameProfile

All Superinterfaces:

DataSerializable, Identifiable

public interface GameProfile
extends Identifiable, DataSerializable

Represents a profile of a user.

Use the UserStorageService service to obtain the stored data associated with a profile.

Method Summary

Modifier and Type	Method and Description
default GameProfile	addProperty(ProfileProperty property) Adds a profile property to this game profile.
default GameProfile	addProperty(String name, ProfileProperty property) Adds a profile property to this game profile.
Optional<String>	getName() Gets the name associated with this profile.
Multimap<String,ProfileProperty>	getPropertyMap() Gets the property map for this profile.
boolean	isFilled() Checks if this profile is filled.
static GameProfile	of(UUID uniqueId) Creates a GameProfile from the provided ID.
static GameProfile	of(UUID uniqueId, String name) Creates a GameProfile from the provided ID and name.
default boolean	removeProperty(ProfileProperty property) Removes a profile property to this game profile.
default boolean	removeProperty(String name, ProfileProperty property) Removes a profile property to this game profile.

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Method Detail

of

static GameProfile of(UUID uniqueId)

Creates a GameProfile from the provided ID.

The name of the created profile will be null.

Parameters:

uniqueId - The unique id

Returns:

The created profile

of

static GameProfile of(UUID uniqueId,
                      @Nullable
                      String name)

Creates a GameProfile from the provided ID and name.

Parameters:

uniqueId - The unique id

name - The name

Returns:

The created profile

getName

Optional<String> getName()

Gets the name associated with this profile.

Returns:

The associated name if present, otherwise Optional.empty()

getPropertyMap

Multimap<String,ProfileProperty> getPropertyMap()

Gets the property map for this profile.

This is a mutable map.

Returns:

The property map

addProperty

default GameProfile addProperty(ProfileProperty property)

Adds a profile property to this game profile.

The name of the property is used when adding the profile property to the property map.

Parameters:

property - The profile property

Returns:

The game profile

addProperty

default GameProfile addProperty(String name,
                                ProfileProperty property)

Adds a profile property to this game profile.

Parameters:

name - The name of the property

property - The profile property

Returns:

The game profile

removeProperty

default boolean removeProperty(ProfileProperty property)

Removes a profile property to this game profile.

The name of the property is used when removing the profile property from the property map.

Parameters:

property - The profile property

Returns:

true if the property map changed

removeProperty

default boolean removeProperty(String name,
                               ProfileProperty property)

Removes a profile property to this game profile.

Parameters:

name - The name of the property

property - The profile property

Returns:

true if the property map changed

isFilled

boolean isFilled()

Checks if this profile is filled.

A filled profile contains both a unique id and name.

Returns:

true if this profile is filled

See Also:

GameProfileManager.fill(GameProfile), GameProfileManager.fill(GameProfile, boolean), GameProfileManager.fill(GameProfile, boolean, boolean)