- All Implemented Interfaces:
public final class ConfigurationScope extends org.eclipse.core.internal.preferences.AbstractScopeObject representing the configuration 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.
Configuration preferences are stored on a per configuration basis in the platform's configuration area. (The configuration area typically contains the list of plug-ins available for use, various settings (those shared across different instances of the same configuration) and any other such data needed by plug-ins.)
The path for preferences defined in the configuration scope hierarchy is as follows:
This class is not intended to be subclassed. This class may be instantiated.
- See Also:
Constructors Constructor Description
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
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.
getName()Return the name of the scope that this context is associated with.
getNode(String qualifier)Return the preferences node that contains the preferences for the given qualifier or
nullif the node cannot be determined.
public static final String SCOPEString constant (value of
"configuration") used for the scope name for the configuration preference scope.
- See Also:
- Constant Field Values
public static final IScopeContext INSTANCESingleton instance of a Configuration Scope object. Typical usage is:
public String getName()Return the name of the scope that this context is associated with. Must not be
public IEclipsePreferences getNode(String qualifier)Return the preferences node that contains the preferences for the given qualifier or
nullif the node cannot be determined. The given qualifier must not be
nullbut 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.
public 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.