Package org.osgi.service.prefs

Interface PreferencesService

public interface PreferencesService
The Preferences Service.

Each bundle using this service has its own set of preference trees: one for system preferences, and one for each user.

A PreferencesService object is specific to the bundle which obtained it from the service registry. If a bundle wishes to allow another bundle to access its preferences, it should pass its PreferencesService object to that bundle.

"Consumers of this API must not implement this interface"

  • Method Details

    • getSystemPreferences

      Preferences getSystemPreferences()
      Returns the root system node for the calling bundle.
      Returns:
      The root system node for the calling bundle.

    • getUserPreferences

      Preferences getUserPreferences(String name)
      Returns the root node for the specified user and the calling bundle.
      Parameters:
      name - The user for which to return the preference root node.
      Returns:
      The root node for the specified user and the calling bundle.

    • getUsers

      String[] getUsers()
      Returns the names of users for which node trees exist.
      Returns:
      The names of users for which node trees exist.