|
Eclipse Platform Release 3.6 |
|||||||||
| 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.InstanceScope
public final class InstanceScope
Object representing the instance 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.
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.
Location.INSTANCE_FILTER| Field Summary | |
|---|---|
static java.lang.String |
SCOPE
String constant (value of "instance") used for the
scope name for the instance preference scope. |
| Constructor Summary | |
|---|---|
InstanceScope()
Create and return a new instance 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. |
java.lang.String |
getName()
Return the name of the scope that this context is associated with. |
IEclipsePreferences |
getNode(java.lang.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 java.lang.String SCOPE
"instance") used for the
scope name for the instance preference scope.
| Constructor Detail |
|---|
public InstanceScope()
| Method Detail |
|---|
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 IScopeContextgetLocation in class org.eclipse.core.internal.preferences.AbstractScopenullpublic java.lang.String getName()
IScopeContextnull.
getName in interface IScopeContextgetName in class org.eclipse.core.internal.preferences.AbstractScopepublic IEclipsePreferences getNode(java.lang.String qualifier)
IScopeContextnull 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 IScopeContextgetNode in class org.eclipse.core.internal.preferences.AbstractScopequalifier - a qualifier for the preference name
nullIPreferencesService
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.