Package org.nuxeo.user.preferences.api

Interface UserPreferences

public interface UserPreferences
A collection of UserPreference.
Since:
2025.16

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getPreference(String key)
    Gets the preference value associated with the given key.
    default boolean
    isEmpty()
     
    Map<String,String>
    preferences()
    Gets the preferences complex property value of the document as a map.
    default int
    size()
     

  • Method Details

    • getPreference

      default String getPreference(String key)
      Gets the preference value associated with the given key.
      Parameters:
      key - the key
      Returns:
      the value

    • isEmpty

      default boolean isEmpty()
      Returns:
      true if the collection contains no preferences.

    • preferences

      @Nonnull Map<String,String> preferences()
      Gets the preferences complex property value of the document as a map.

      If the value is null, then an empty map is returned.

      Returns:
      the map of key / value preferences

    • size

      default int size()
      Returns:
      the number of preferences