Interface IScopeContext
-
- All Known Implementing Classes:
org.eclipse.core.internal.preferences.AbstractScope,BundleDefaultsScope,ConfigurationScope,DefaultScope,InstanceScope,ProfileScope,ProjectScope
public interface IScopeContextClients implement this interface to provide context to a particular scope. Instances of implementations of this interface are passed to theIPreferencesServicefor use in preference searching.Clients may implement this interface.
- Since:
- 3.0
- See Also:
IPreferencesService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IPathgetLocation()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.StringgetName()Return the name of the scope that this context is associated with.IEclipsePreferencesgetNode(String qualifier)Return the preferences node that contains the preferences for the given qualifier ornullif the node cannot be determined.
-
-
-
Method Detail
-
getName
String getName()
Return the name of the scope that this context is associated with. Must not benull.- Returns:
- the name of the scope
-
getNode
IEclipsePreferences getNode(String qualifier)
Return the preferences node that contains the preferences for the given qualifier ornullif the node cannot be determined. The given qualifier must not benullbut 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.- Parameters:
qualifier- a qualifier for the preference name- Returns:
- the node containing the plug-in preferences or
null - See Also:
IPreferencesService
-
getLocation
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.Implementors may return
nullif the location is not known, is unavailable, or is not applicable to this scope.- Returns:
- a writable location in the file system or
null
-
-