Copyright (c) 2009, 2015 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
/*******************************************************************************
 * Copyright (c) 2009, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.runtime.preferences;

import org.eclipse.core.internal.preferences.AbstractScope;
import org.eclipse.core.runtime.IPath;

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

The bundle defaults are the defaults are default values which have
been set either by the bundle's preference initializer or by a customization
file supplied with the bundle.

Bundle default preferences are not persisted to disk.


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


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

Since:
3.3/**
 * Object representing the bundle defaults 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.
 * <p>
 * The bundle defaults are the defaults are default values which have
 * been set either by the bundle's preference initializer or by a customization
 * file supplied with the bundle.
 * <p>
 * Bundle default preferences are not persisted to disk.
 * </p>
 * <p>
 * The path for preferences defined in the bundle defaults scope hierarchy
 * is as follows: <code>/bundle_defaults/&lt;qualifier&gt;</code>
 * </p>
 * <p>
 * This class is not intended to be subclassed. This class may be instantiated.
 * </p>
 * @since 3.3
 */
public final class BundleDefaultsScope extends AbstractScope {

	
String constant (value of "default") used for the
scope name for the default preference scope.
/**
	 * String constant (value of <code>"default"</code>) used for the
	 * scope name for the default preference scope.
	 */
	public static final String SCOPE = "bundle_defaults"; //$NON-NLS-1$

	
Singleton instance of a Bundle Defaults Scope object. Typical usage is:
BundleDefaultsScope.INSTANCE.getNode(...);
Since:
3.4/**
	 * Singleton instance of a Bundle Defaults Scope object. Typical usage is:
	 * <code>BundleDefaultsScope.INSTANCE.getNode(...);</code>
	 *
	 * @since 3.4
	 */
	public static final IScopeContext INSTANCE = new BundleDefaultsScope();

	
Create and return a new default scope instance.
Deprecated:
use BundleDefaultsScope.INSTANCE instead/**
	 * Create and return a new default scope instance.
	 * @deprecated use <code>BundleDefaultsScope.INSTANCE</code> instead
	 */
	public BundleDefaultsScope() {
		super();
	}


	@Override
	public String getName() {
		return SCOPE;
	}


	@Override
	public IEclipsePreferences getNode(String qualifier) {
		return super.getNode(qualifier);
	}


	@Override
	public IPath getLocation() {
		// We don't persist defaults so return null.
		return null;
	}
}