|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.resources.ProjectScope
Object representing the project scope in the Eclipse preferences
hierarchy. Can be used as a context for searching for preference
values (in the 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.
IResource.getLocation()
Field Summary | |
---|---|
static String |
SCOPE
String constant (value of "project" ) used for the
scope name for this preference scope. |
Constructor Summary | |
---|---|
ProjectScope(IProject context)
Create and return a new project scope for the given project. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
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.
|
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String SCOPE
"project"
) used for the
scope name for this preference scope.
Constructor Detail |
public ProjectScope(IProject context)
null
.
context
- the project
IllegalArgumentException
- if the project is null
Method Detail |
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 subnode 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
qualifier
- a qualifier for the preference name
null
IPreferencesService
public IPath getLocation()
IScopeContext
Implementors may return null
if the location is not known,
is unavailable, or is unapplicable to this scope.
getLocation
in interface IScopeContext
null
public String getName()
IScopeContext
null
.
getName
in interface IScopeContext
public boolean equals(Object obj)
public int hashCode()
|
Eclipse Platform Release 3.1 |
|||||||||||
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, 2005. All rights reserved.