Class UserScope

java.lang.Object
org.eclipse.core.runtime.preferences.AbstractScope
org.eclipse.core.runtime.preferences.UserScope
All Implemented Interfaces:
IScopeContext

public class UserScope extends AbstractScope
Since:
3.11
  • Field Details

    • SCOPE

      public static final String SCOPE
      String constant (value of "user") used for the scope name for the user preference scope.
      See Also:
    • INSTANCE

      public static final IScopeContext INSTANCE
      Singleton instance of a User Scope object. Typical usage is: UserScope.INSTANCE.getNode(...);
      Since:
      3.4
  • Method Details

    • getName

      public String getName()
      Description copied from interface: IScopeContext
      Return the name of the scope that this context is associated with. Must not be null.
      Returns:
      the name of the scope
    • getLocation

      public IPath getLocation()
      Description copied from interface: IScopeContext
      Return a path to a location in the file-system where clients are able to write files that will have the same sharing/scope properties as preferences defined in this scope.

      Implementors may return null if the location is not known, is unavailable, or is not applicable to this scope.

      Returns:
      a writable location in the file system or null