io.github.nucleuspowered.nucleus.api.core

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
java.util.Optional<T>	getDefaultValue() The default value for a preference, if any.
java.lang.String	getID() The ID of the key.
java.lang.Class<T>	getValueClass() The type of value.

Method Detail

getID

java.lang.String getID()

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

Returns:

The ID

getDefaultValue

java.util.Optional<T> getDefaultValue()

The default value for a preference, if any.

Returns:

The default value, if any.

getValueClass

java.lang.Class<T> getValueClass()

The type of value.

Returns:

The Class