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 theLocation.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:
Location.INSTANCE_FILTER
-
-
Field Summary
Fields Modifier and Type Field Description static IScopeContext
INSTANCE
Singleton instance of an Instance Scope object.static 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.callInstanceScope.INSTANCE
instead.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.IEclipsePreferences
getNode(String qualifier)
Return the preferences node that contains the preferences for the given qualifier ornull
if the node cannot be determined.
-
-
-
Field Detail
-
SCOPE
public static final String SCOPE
String constant (value of"instance"
) used for the scope name for the instance preference scope.- See Also:
- Constant Field Values
-
INSTANCE
public static final IScopeContext INSTANCE
Singleton instance of an Instance Scope object. Typical usage is:InstanceScope.INSTANCE.getNode(...);
- Since:
- 3.4
-
-
Method Detail
-
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.- Specified by:
getLocation
in interfaceIScopeContext
- Specified by:
getLocation
in classorg.eclipse.core.internal.preferences.AbstractScope
- 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 benull
.- Specified by:
getName
in interfaceIScopeContext
- Specified by:
getName
in classorg.eclipse.core.internal.preferences.AbstractScope
- Returns:
- the name of the scope
-
getNode
public IEclipsePreferences getNode(String qualifier)
Description copied from interface:IScopeContext
Return the preferences node that contains the preferences for the given qualifier ornull
if the node cannot be determined. The given qualifier must not benull
but may be a path to a sub-node within the scope.An example of a qualifier in Eclipse 2.1 would be the plug-in identifier that the preference is associated with (e.g. the "org.eclipse.core.resources" plug-in defines the "description.autobuild" preference).
This method can be used to determine the appropriate preferences node to aid in setting key/value pairs. For instance:
new InstanceScope().getNode("org.eclipse.core.resources");
returns the preference node in the instance scope where the preferences for "org.eclipse.core.resources" are stored.- Specified by:
getNode
in interfaceIScopeContext
- Overrides:
getNode
in classorg.eclipse.core.internal.preferences.AbstractScope
- Parameters:
qualifier
- a qualifier for the preference name- Returns:
- the node containing the plug-in preferences or
null
- See Also:
IPreferencesService
-
-