io.github.nucleuspowered.nucleus.api.service

Interface NucleusUserPreferenceService.PreferenceKey<T>

Type Parameters:

T - The type of key.

Enclosing interface:

NucleusUserPreferenceService

public static interface NucleusUserPreferenceService.PreferenceKey<T>

Represents a NucleusUserPreferenceService.PreferenceKey

Keys will only be accepted by the Nucleus system that are generated by it.

Method Summary

Modifier and Type	Method and Description
boolean	canAccess(org.spongepowered.api.entity.living.player.User user) Tests whether a user can change their preference.
Optional<T>	getDefaultValue() The default value for a preference, if any.
String	getDescription() The description of the preference.
String	getID() The ID of the key.
Class<T>	getValueClass() The type of value.

Method Detail

getID

String getID()

The ID of the key. Must be unique amongst all keys.

Returns:

The ID

getDefaultValue

Optional<T> getDefaultValue()

The default value for a preference, if any.

Returns:

The default value, if any.

getValueClass

Class<T> getValueClass()

The type of value.

Returns:

The Class

canAccess

boolean canAccess(org.spongepowered.api.entity.living.player.User user)

Tests whether a user can change their preference.

Parameters:

user - The user to check

Returns:

If they have permission

getDescription

String getDescription()

The description of the preference.

Returns:

The description.