Class TypedPreference<T>

  • Type Parameters:
    T - the type of the value

    public class TypedPreference<T>
    extends java.lang.Object
    A preference key with a default value. Note that the configured value is not stored in the preference. Instead an IPreferenceValueProvider is used to get values.
    • Field Detail

      • identifier

        private final java.lang.String identifier
      • name

        private final java.lang.String name
      • description

        private final java.lang.String description
      • defaultValue

        private final T defaultValue
    • Constructor Detail

      • TypedPreference

        public TypedPreference​(java.lang.String identifier,
                               java.lang.String name,
                               java.lang.String description,
                               IPersister<T> persister,
                               T defaultValue)
        Parameters:
        identifier - preference identifier
        name - preference name
        description - a longer description of the preference
        persister - a persister that can parse and format values
        defaultValue - if a value for this preference has not been set, then use this default value
    • Method Detail

      • getIdentifier

        public java.lang.String getIdentifier()
        Returns:
        preference identifier
      • getName

        public java.lang.String getName()
        Returns:
        preference name
      • getDescription

        public java.lang.String getDescription()
        Returns:
        preference description
      • getPersister

        public IPersister<T> getPersister()
        Get a persister that can be used to convert between the preference value type and strings.
        Returns:
        value persister
      • getDefaultValue

        public T getDefaultValue()
        Returns:
        the default value for this preference
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object