Class InstanceScope
- All Implemented Interfaces:
IScopeContext
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IScopeContextSingleton instance of an Instance Scope object.static final StringString constant (value of"instance") used for the scope name for the instance 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 ornullif the node cannot be determined.Methods inherited from class org.eclipse.core.internal.preferences.AbstractScope
equals, hashCode
-
Field Details
-
SCOPE
String constant (value of"instance") used for the scope name for the instance preference scope.- See Also:
-
INSTANCE
Singleton instance of an Instance Scope object. Typical usage is:InstanceScope.INSTANCE.getNode(...);- Since:
- 3.4
-
-
Constructor Details
-
InstanceScope
public InstanceScope()Deprecated.callInstanceScope.INSTANCEinstead.Create and return a new instance scope instance.
-
-
Method Details
-
getLocation
Description copied from interface:IScopeContextReturn 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.- Specified by:
getLocationin interfaceIScopeContext- Specified by:
getLocationin classorg.eclipse.core.internal.preferences.AbstractScope- Returns:
- a writable location in the file system or
null
-
getName
Description copied from interface:IScopeContextReturn the name of the scope that this context is associated with. Must not benull.- Specified by:
getNamein interfaceIScopeContext- Specified by:
getNamein classorg.eclipse.core.internal.preferences.AbstractScope- Returns:
- the name of the scope
-
getNode
Description copied from interface:IScopeContextReturn 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.- Specified by:
getNodein interfaceIScopeContext- Overrides:
getNodein 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:
-
InstanceScope.INSTANCEinstead.