Package org.spongepowered.api.profile.property

Interface ProfileProperty

All Superinterfaces:

DataSerializable

public interface ProfileProperty
extends DataSerializable

Represents a property in a GameProfile's profile property map.

This interface should not be implemented by third parties - use of(String, String) or of(String, String, String) to create instances instead.

See Also:

of(String, String), of(String, String, String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProfileProperty.Factory	A factory for ProfilePropertys.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TEXTURES	The name of the textures property.

Method Summary

Modifier and Type	Method	Description
default boolean	hasSignature()	Tests if this property has a signature.
String	name()	Gets the name of this property.
static ProfileProperty	of(String name, String value)	Creates a new property.
static ProfileProperty	of(String name, String value, @Nullable String signature)	Creates a new signed property.
Optional<String>	signature()	Gets the signature of this property.
String	value()	Gets the value of this property.

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

contentVersion, toContainer

Field Detail

TEXTURES

static final String TEXTURES

The name of the textures property.

This is used with Keys.SKIN_PROFILE_PROPERTY to set the skin of a Humanoid.

See Also:

Constant Field Values

Method Detail

of

static ProfileProperty of(String name,
                          String value)

Creates a new property.

Parameters:

name - The name for the property

value - The value of the property

Returns:

The new property

of

static ProfileProperty of(String name,
                          String value,
                          @Nullable String signature)

Creates a new signed property.

Depending on the property name, if the signature is provided it must originate from Mojang.

Parameters:

name - The name for the property

value - The value of the property

signature - The signature of the property

Returns:

The new property

name

String name()

Gets the name of this property.

Returns:

The name

value

String value()

Gets the value of this property.

Returns:

The value

signature

Optional<String> signature()

Gets the signature of this property.

Depending on the property name, if the signature is provided it must originate from Mojang.

Returns:

The signature, or Optional.empty() if not present

hasSignature

default boolean hasSignature()

Tests if this property has a signature.

Returns:

Whether this property has a signature