com.github.steveice10.mc.auth.data

Class GameProfile

java.lang.Object

com.github.steveice10.mc.auth.data.GameProfile

public class GameProfile
extends Object

Information about a user profile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GameProfile.Property A property belonging to a profile.
static class	GameProfile.Texture A texture contained within a profile.
static class	GameProfile.TextureModel The model used for a profile texture.
static class	GameProfile.TextureType The type of a profile texture.

Constructor Summary

Constructors

Constructor and Description
GameProfile(String id, String name) Creates a new GameProfile instance.
GameProfile(UUID id, String name) Creates a new GameProfile instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
UUID	getId() Gets the ID of the profile.
String	getIdAsString() Gets the ID of the profile as a String.
String	getName() Gets the name of the profile.
List<GameProfile.Property>	getProperties() Gets an immutable list of properties contained in the profile.
GameProfile.Property	getProperty(String name) Gets a property contained in the profile.
GameProfile.Texture	getTexture(GameProfile.TextureType type) Gets a texture contained in the profile.
GameProfile.Texture	getTexture(GameProfile.TextureType type, boolean requireSecure) Gets a texture contained in the profile.
Map<GameProfile.TextureType,GameProfile.Texture>	getTextures() Gets an immutable map of texture types to textures contained in the profile.
Map<GameProfile.TextureType,GameProfile.Texture>	getTextures(boolean requireSecure) Gets an immutable map of texture types to textures contained in the profile.
int	hashCode()
boolean	isComplete() Gets whether the profile is complete.
void	setProperties(List<GameProfile.Property> properties) Sets the properties of this profile.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GameProfile

public GameProfile(String id,
                   String name)

Creates a new GameProfile instance.

Parameters:

id - ID of the profile.

name - Name of the profile.

GameProfile

public GameProfile(UUID id,
                   String name)

Creates a new GameProfile instance.

Parameters:

id - ID of the profile.

name - Name of the profile.

Method Detail

isComplete

public boolean isComplete()

Gets whether the profile is complete.

Returns:

Whether the profile is complete.

getId

public UUID getId()

Gets the ID of the profile.

Returns:

The profile's ID.

getIdAsString

public String getIdAsString()

Gets the ID of the profile as a String.

Returns:

The profile's ID as a string.

getName

public String getName()

Gets the name of the profile.

Returns:

The profile's name.

getProperties

public List<GameProfile.Property> getProperties()

Gets an immutable list of properties contained in the profile.

Returns:

The profile's properties.

setProperties

public void setProperties(List<GameProfile.Property> properties)

Sets the properties of this profile.

Parameters:

properties - Properties belonging to this profile.

getProperty

public GameProfile.Property getProperty(String name)

Gets a property contained in the profile.

Parameters:

name - Name of the property.

Returns:

The property with the specified name.

getTextures

public Map<GameProfile.TextureType,GameProfile.Texture> getTextures()
                                                             throws PropertyException

Gets an immutable map of texture types to textures contained in the profile.

Returns:

The profile's textures.

Throws:

PropertyException - If an error occurs decoding the profile's texture property.

getTextures

public Map<GameProfile.TextureType,GameProfile.Texture> getTextures(boolean requireSecure)
                                                             throws PropertyException

Gets an immutable map of texture types to textures contained in the profile.

Parameters:

requireSecure - Whether to require the profile's texture payload to be securely signed.

Returns:

The profile's textures.

Throws:

PropertyException - If an error occurs decoding the profile's texture property.

getTexture

public GameProfile.Texture getTexture(GameProfile.TextureType type)
                               throws PropertyException

Gets a texture contained in the profile.

Parameters:

type - Type of texture to get.

Returns:

The texture of the specified type.

Throws:

PropertyException - If an error occurs decoding the profile's texture property.

getTexture

public GameProfile.Texture getTexture(GameProfile.TextureType type,
                                      boolean requireSecure)
                               throws PropertyException

Gets a texture contained in the profile.

Parameters:

type - Type of texture to get.

requireSecure - Whether to require the profile's texture payload to be securely signed.

Returns:

The texture of the specified type.

Throws:

PropertyException - If an error occurs decoding the profile's texture property.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object