org.onosproject.ui

Interface UiPreferencesService

public interface UiPreferencesService

Service for tracking user interface preferences.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.node.ObjectNode	getPreference(String username, String key) Returns the named preference for the specified user.
Map<String,com.fasterxml.jackson.databind.node.ObjectNode>	getPreferences(String userName) Returns an immutable copy of the preferences for the specified user.
Set<String>	getUserNames() Returns the list of user names that have user preferences available.
void	setPreference(String username, String key, com.fasterxml.jackson.databind.node.ObjectNode value) Sets or clears the named preference for the specified user.

Method Detail

getUserNames

Set<String> getUserNames()

Returns the list of user names that have user preferences available.

Returns:

list of user names

getPreferences

Map<String,com.fasterxml.jackson.databind.node.ObjectNode> getPreferences(String userName)

Returns an immutable copy of the preferences for the specified user.

Parameters:

userName - user name

Returns:

map of user preferences

getPreference

com.fasterxml.jackson.databind.node.ObjectNode getPreference(String username,
                                                             String key)

Returns the named preference for the specified user. If no such preferences exist, null will be returned.

Parameters:

username - user name

key - preference key

Returns:

named preference

setPreference

void setPreference(String username,
                   String key,
                   com.fasterxml.jackson.databind.node.ObjectNode value)

Sets or clears the named preference for the specified user.

Parameters:

username - user name

key - preference key

value - preference value; if null it will be cleared