Class ProjectScope
- All Implemented Interfaces:
IScopeContext
org.eclipse.core.runtime.IPreferencesService
APIs) or for determining the correct preference node to set values in the store.
Project preferences are stored on a per project basis in the
project's content area as specified by IProject#getLocation.
The path for preferences defined in the project scope hierarchy
is as follows: /project/<projectName>/<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 StringString constant (value of"project") used for the scope name for this preference scope.Fields inherited from interface org.eclipse.core.runtime.preferences.IScopeContext
BUNDLE_SCOPE_FILTER, PROPERTY_TYPE, TYPE_BUNDLE -
Constructor Summary
ConstructorsConstructorDescriptionProjectScope(IProject context) Create and return a new project scope for the given project. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturn 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.inthashCode()
-
Field Details
-
SCOPE
String constant (value of"project") used for the scope name for this preference scope.- See Also:
-
-
Constructor Details
-
ProjectScope
Create and return a new project scope for the given project. The given project must not benull.- Parameters:
context- the project- Throws:
IllegalArgumentException- if the project isnull
-
-
Method Details
-
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:
-
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.- 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.- Returns:
- the name of the scope
-
equals
- Overrides:
equalsin classorg.eclipse.core.internal.preferences.AbstractScope
-
hashCode
public int hashCode()- Overrides:
hashCodein classorg.eclipse.core.internal.preferences.AbstractScope
-