Eclipse Platform
Release 3.1

org.eclipse.core.runtime.preferences
Class DefaultScope

java.lang.Object
  extended by org.eclipse.core.internal.preferences.AbstractScope
      extended by org.eclipse.core.runtime.preferences.DefaultScope
All Implemented Interfaces:
IScopeContext

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

Object representing the default 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.

Default preferences are not persisted to disk.

The path for preferences defined in the default scope hierarchy is as follows: /default/<qualifier>

Note about product preference customization: Clients who define their own IProduct are able to specify a product key of "preferenceCustomization". (defined as a constant in IProductConstants) Its value is either a URL or a file-system path to a file whose contents are used to customize default preferences.

This class is not intended to be subclassed. This class may be instantiated.

Since:
3.0

Field Summary
static java.lang.String SCOPE
          String constant (value of "default") used for the scope name for the default preference scope.
 
Constructor Summary
DefaultScope()
          Create and return a new default 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.
 
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 java.lang.String SCOPE
String constant (value of "default") used for the scope name for the default preference scope.

See Also:
Constant Field Values
Constructor Detail

DefaultScope

public DefaultScope()
Create and return a new default scope instance.

Method Detail

getName

public 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
Specified by:
getName in class org.eclipse.core.internal.preferences.AbstractScope
Returns:
the name of the scope

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.

Specified by:
getLocation in interface IScopeContext
Specified by:
getLocation in class org.eclipse.core.internal.preferences.AbstractScope
Returns:
a writable location in the filesystem or null

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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