Package org.eclipse.equinox.p2.engine
Class ProfileScope
java.lang.Object
org.eclipse.equinox.p2.engine.ProfileScope
- All Implemented Interfaces:
IScopeContext
A profile scope contains the preferences associated with a particular profile
in a provisioned system.
- Since:
- 2.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringString constant (value of"profile") 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
ConstructorsConstructorDescriptionProfileScope(IAgentLocation agentLocation, String profileId) Creates and returns a profile scope for the given profile id and agent. -
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"profile") used for the scope name for this preference scope.- See Also:
-
-
Constructor Details
-
ProfileScope
Creates and returns a profile scope for the given profile id and agent.- Parameters:
agentLocation- The location of the provisioning agent to obtain profile preferences forprofileId- The id of the profile to obtain preferences for
-
-
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- 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- 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- Parameters:
qualifier- a qualifier for the preference name- Returns:
- the node containing the plug-in preferences or
null - See Also:
-
equals
-
hashCode
public int hashCode()
-