public interface IScopeContext
IPreferencesService
for use in
preference searching.
Clients may implement this interface.
IPreferencesService
Modifier and Type | Method and 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 or
null if the node cannot be determined. |
String getName()
null
.IEclipsePreferences getNode(String qualifier)
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.
qualifier
- a qualifier for the preference namenull
IPreferencesService
IPath getLocation()
Implementors may return null
if the location is not known,
is unavailable, or is not applicable to this scope.
null
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.