|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.internal.preferences.AbstractScope
org.eclipse.core.runtime.preferences.ConfigurationScope
Object 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: /configuration/<qualifier>
This class is not intended to be subclassed. This class may be instantiated.
Location.CONFIGURATION_FILTER
Field Summary | |
---|---|
static String |
SCOPE
String constant (value of "configuration" ) used for the
scope name for the configuration preference scope. |
Constructor Summary | |
---|---|
ConfigurationScope()
Create and return a new configuration scope instance. |
Method Summary | |
---|---|
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. |
String |
getName()
Return the name of the scope that this context is associated with. |
IEclipsePreferences |
getNode(String qualifier)
Return the preferences node that contains the preferences for the given qualifier or null if the node cannot be determined.
|
Methods inherited from class org.eclipse.core.internal.preferences.AbstractScope |
---|
equals, hashCode |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String SCOPE
"configuration"
) used for the
scope name for the configuration preference scope.
Constructor Detail |
public ConfigurationScope()
Method Detail |
public String getName()
IScopeContext
null
.
getName
in interface IScopeContext
public IEclipsePreferences getNode(String qualifier)
IScopeContext
null
if the node cannot be determined.
The given qualifier must not be null
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.
getNode
in interface IScopeContext
public IPath getLocation()
IScopeContext
Implementors may return null
if the location is not known,
is unavailable, or is not applicable to this scope.
getLocation
in interface IScopeContext
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.