Class ConfigurationScope
- All Implemented Interfaces:
IScopeContext
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: /configuration/<qualifier>
This class is not intended to be subclassed. This class may be instantiated.
- Since:
- 3.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IScopeContext
Singleton instance of a Configuration Scope object.static final String
String constant (value of"configuration"
) used for the scope name for the configuration preference scope.Fields inherited from interface org.eclipse.core.runtime.preferences.IScopeContext
BUNDLE_SCOPE_FILTER, PROPERTY_TYPE, TYPE_BUNDLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn 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.Return the preferences node that contains the preferences for the given qualifier ornull
if the node cannot be determined.Methods inherited from class org.eclipse.core.internal.preferences.AbstractScope
equals, hashCode
-
Field Details
-
SCOPE
String constant (value of"configuration"
) used for the scope name for the configuration preference scope.- See Also:
-
INSTANCE
Singleton instance of a Configuration Scope object. Typical usage is:ConfigurationScope.INSTANCE.getNode(...);
- Since:
- 3.4
-
-
Constructor Details
-
ConfigurationScope
public ConfigurationScope()Deprecated.useConfigurationScope.INSTANCE
insteadCreate and return a new configuration scope instance.
-
-
Method Details
-
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
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:
-
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
-
ConfigurationScope.INSTANCE
instead