com.comphenix.protocol.wrappers

Class WrappedGameProfile

java.lang.Object

com.comphenix.protocol.wrappers.AbstractWrapper

com.comphenix.protocol.wrappers.WrappedGameProfile

public class WrappedGameProfile
extends AbstractWrapper

Represents a wrapper for a game profile.

Author:

Kristian

Field Summary

Fields inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

handle, handleType

Constructor Summary

Constructors

Constructor and Description
WrappedGameProfile(java.lang.String id, java.lang.String name) Construct a new game profile with the given properties.
WrappedGameProfile(java.util.UUID uuid, java.lang.String name) Construct a new game profile with the given properties.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static WrappedGameProfile	fromHandle(java.lang.Object handle) Construct a wrapper around an existing game profile.
java.lang.String	getId() Retrieve the UUID of the player.
java.lang.String	getName() Retrieve the name of the player.
int	hashCode()
boolean	isComplete() Determine if the game profile contains both an UUID and a name.
java.lang.String	toString()
WrappedGameProfile	withId(java.lang.String id) Construct a new game profile with the same name, but different id.
WrappedGameProfile	withName(java.lang.String name) Construct a new game profile with the same ID, but different name.

Methods inherited from class com.comphenix.protocol.wrappers.AbstractWrapper

getHandle, getHandleType, setHandle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WrappedGameProfile

public WrappedGameProfile(java.lang.String id,
                  java.lang.String name)

Construct a new game profile with the given properties.

Note that this constructor is very lenient when parsing UUIDs for backwards compatibility reasons. Thus - "", " ", "0" and "0-0-0-0" are all equivalent to the the UUID "00000000-0000-0000-0000-000000000000".

Parameters:

id - - the UUID of the player.

name - - the name of the player.

WrappedGameProfile

public WrappedGameProfile(java.util.UUID uuid,
                  java.lang.String name)

Construct a new game profile with the given properties.

Note that at least one of the parameters must be non-null.

Parameters:

uuid - - the UUID of the player, or NULL.

name - - the name of the player, or NULL.

Method Detail

fromHandle

public static WrappedGameProfile fromHandle(java.lang.Object handle)

Construct a wrapper around an existing game profile.

Parameters:

profile - - the underlying profile, or NULL.

getId

public java.lang.String getId()

Retrieve the UUID of the player.

Returns:

The UUID of the player, or NULL if not computed.

getName

public java.lang.String getName()

Retrieve the name of the player.

Returns:

The player name.

withName

public WrappedGameProfile withName(java.lang.String name)

Construct a new game profile with the same ID, but different name.

Parameters:

name - - the new name of the profile to create.

Returns:

The new game profile.

withId

public WrappedGameProfile withId(java.lang.String id)

Construct a new game profile with the same name, but different id.

Parameters:

id - - the new id of the profile to create.

Returns:

The new game profile.

isComplete

public boolean isComplete()

Determine if the game profile contains both an UUID and a name.

Returns:

TRUE if it does, FALSE otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object