Package org.eclipse.core.runtime.preferences

Class InstanceScope

java.lang.Object
org.eclipse.core.internal.preferences.AbstractScope
org.eclipse.core.runtime.preferences.InstanceScope
All Implemented Interfaces:
IScopeContext
public final class InstanceScope extends org.eclipse.core.internal.preferences.AbstractScope
Object representing the instance scope in the Eclipse preferences hierarchy. Can be used as a context for searching for preference values (in the IPreferencesService APIs) or for determining the correct preference node to set values in the store.

Instance preferences are stored on a per instance basis in the platform's instance area as specified by the Location class and the Location.INSTANCE_FILTER filter.

The path for preferences defined in the instance scope hierarchy is as follows: /instance/<qualifier>

This class is not intended to be subclassed. This class may be instantiated.

Since:
3.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final IScopeContext
    INSTANCE
    Singleton instance of an Instance Scope object.
    static final String
    SCOPE
    String constant (value of "instance") used for the scope name for the instance preference scope.

    Fields inherited from interface org.eclipse.core.runtime.preferences.IScopeContext

    BUNDLE_SCOPE_FILTER, PROPERTY_TYPE, TYPE_BUNDLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    InstanceScope()
    Deprecated.
    call InstanceScope.INSTANCE instead.

  • Method Summary

    Modifier and Type
    Method
    Description
    IPath
    getLocation()
    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.
    String
    getName()
    Return the name of the scope that this context is associated with.

    Methods inherited from class org.eclipse.core.internal.preferences.AbstractScope

    equals, getNode, hashCode

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SCOPE

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

    • INSTANCE

      public static final IScopeContext INSTANCE
      Singleton instance of an Instance Scope object. Typical usage is: InstanceScope.INSTANCE.getNode(...);
      Since:
      3.4

  • Constructor Details

    • InstanceScope

      @Deprecated public InstanceScope()
      Deprecated.
      call InstanceScope.INSTANCE instead.
      Create and return a new instance scope instance.

  • Method Details

    • 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

    • 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