Eclipse Platform
Release 3.1

org.eclipse.core.runtime.preferences
Class ConfigurationScope

java.lang.Object
  extended byorg.eclipse.core.internal.preferences.AbstractScope
      extended byorg.eclipse.core.runtime.preferences.ConfigurationScope
All Implemented Interfaces:
IScopeContext

public final class ConfigurationScope
extends org.eclipse.core.internal.preferences.AbstractScope

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 as specified by Platform.getConfigurationLocation().

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.

Since:
3.0
See Also:
Platform.getConfigurationLocation()

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.
 
Methods inherited from class org.eclipse.core.internal.preferences.AbstractScope
equals, getNode, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCOPE

public static final String SCOPE
String constant (value of "configuration") used for the scope name for the configuration preference scope.

See Also:
Constant Field Values
Constructor Detail

ConfigurationScope

public ConfigurationScope()
Create and return a new configuration scope instance.

Method Detail

getName

public String getName()
Description copied from interface: IScopeContext
Return the name of the scope that this context is associated with. Must not be null.


getLocation

public 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 unapplicable to this scope.


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.