io.github.nucleuspowered.nucleus.api.core

Interface NucleusUserPreferenceService

public interface NucleusUserPreferenceService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusUserPreferenceService.Keys Contains NucleusUserPreferenceService.PreferenceKeys
static interface	NucleusUserPreferenceService.PreferenceKey<T> Represents a NucleusUserPreferenceService.PreferenceKey

Method Summary

Modifier and Type	Method and Description
boolean	canAccess(org.spongepowered.api.entity.living.player.User user, NucleusUserPreferenceService.PreferenceKey<?> key) Gets whether a User can use a given NucleusUserPreferenceService.PreferenceKey
java.lang.String	getDescription(NucleusUserPreferenceService.PreferenceKey<?> key) The description of the preference.
<T> java.util.Optional<T>	getPreferenceFor(org.spongepowered.api.entity.living.player.User user, NucleusUserPreferenceService.PreferenceKey<T> key) Gets the preference associated with the NucleusUserPreferenceService.PreferenceKey for the supplied User, if any is set.
NucleusUserPreferenceService.Keys	keys() Gets the user preference keys available for this user.
void	removePreferenceFor(org.spongepowered.api.entity.living.player.User user, NucleusUserPreferenceService.PreferenceKey<?> key) Removes a preference associated with a user, reverting it to a default value as determined by the consumer of the preference (which will usually take the value of NucleusUserPreferenceService.PreferenceKey.getDefaultValue(), if any is supplied).
<T> void	setPreferenceFor(org.spongepowered.api.entity.living.player.User user, NucleusUserPreferenceService.PreferenceKey<T> key, T value) Sets the preference associated with the NucleusUserPreferenceService.PreferenceKey for the supplied User.

Method Detail

keys

NucleusUserPreferenceService.Keys keys()

Gets the user preference keys available for this user.

Returns:

An interface that contains NucleusUserPreferenceService.Keys

getPreferenceFor

<T> java.util.Optional<T> getPreferenceFor(org.spongepowered.api.entity.living.player.User user,
                                           NucleusUserPreferenceService.PreferenceKey<T> key)

Gets the preference associated with the NucleusUserPreferenceService.PreferenceKey for the supplied User, if any is set.

Type Parameters:

T - The type of preference this is

Parameters:

user - The User

key - The NucleusUserPreferenceService.PreferenceKey to check against.

Returns:

The value, if one is set.

setPreferenceFor

<T> void setPreferenceFor(org.spongepowered.api.entity.living.player.User user,
                          NucleusUserPreferenceService.PreferenceKey<T> key,
                          T value)

Sets the preference associated with the NucleusUserPreferenceService.PreferenceKey for the supplied User.

Type Parameters:

T - The type of preference this is

Parameters:

user - The User

key - The NucleusUserPreferenceService.PreferenceKey value to set

value - The value to set

removePreferenceFor

void removePreferenceFor(org.spongepowered.api.entity.living.player.User user,
                         NucleusUserPreferenceService.PreferenceKey<?> key)

Removes a preference associated with a user, reverting it to a default value as determined by the consumer of the preference (which will usually take the value of NucleusUserPreferenceService.PreferenceKey.getDefaultValue(), if any is supplied).

Parameters:

user - The User

key - The NucleusUserPreferenceService.PreferenceKey

canAccess

boolean canAccess(org.spongepowered.api.entity.living.player.User user,
                  NucleusUserPreferenceService.PreferenceKey<?> key)

Gets whether a User can use a given NucleusUserPreferenceService.PreferenceKey

Parameters:

user - The user

key - The key

Returns:

true if so

getDescription

java.lang.String getDescription(NucleusUserPreferenceService.PreferenceKey<?> key)

The description of the preference.

Parameters:

key - The NucleusUserPreferenceService.PreferenceKey to check

Returns:

The description.