org.eclipse.core.internal.preferences

Class AbstractScope

java.lang.Object

org.eclipse.core.internal.preferences.AbstractScope

All Implemented Interfaces:

IScopeContext

Direct Known Subclasses:

BundleDefaultsScope, ConfigurationScope, DefaultScope, InstanceScope

public abstract class AbstractScope
extends java.lang.Object
implements IScopeContext

Abstract super-class for scope context object contributed by the Platform.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
AbstractScope()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
abstract 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.
abstract 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.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractScope

public AbstractScope()

Method Detail

getName

public abstract java.lang.String getName()

Description copied from interface: IScopeContext

Return the name of the scope that this context is associated with. Must not be null.

Specified by:

getName in interface IScopeContext

Returns:

the name of the scope

getNode

public IEclipsePreferences getNode(java.lang.String qualifier)

Description copied from interface: IScopeContext

Return the preferences node that contains the preferences for the given qualifier or 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.

Specified by:

getNode in interface IScopeContext

Parameters:

qualifier - a qualifier for the preference name

Returns:

the node containing the plug-in preferences or null

See Also:

IPreferencesService

getLocation

public abstract IPath getLocation()

Description copied from interface: IScopeContext

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.

Implementors may return null if the location is not known, is unavailable, or is not applicable to this scope.

Specified by:

getLocation in interface IScopeContext

Returns:

a writable location in the file system or null

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object