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
- implements
IScopeContext
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:
-
Location.INSTANCE_FILTER
-
Restriction:
- This class is not intended to be subclassed by clients.
Field Summary
|
static
String
|
SCOPE
String constant (value of "instance" ) used for the
scope name for the instance preference scope. |
Constructor Summary
|
InstanceScope
()
Create and return a new instance scope instance. |
Method Summary
|
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 or null if the node cannot be determined. |
Methods inherited from class org.eclipse.core.internal.preferences.AbstractScope
|
equals, hashCode
|
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
InstanceScope
public InstanceScope()
- Create and return a new instance scope instance.
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 interface
IScopeContext
-
Specified by:
-
getLocation
in class org.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 be
null
.
-
-
Specified by:
-
getName
in interface
IScopeContext
-
Specified by:
-
getName
in class org.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 or
null
if the node cannot be determined.
The given qualifier must not be null
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 interface
IScopeContext
-
Overrides:
-
getNode
in class org.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
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.