org.eclipse.core.runtime.preferences.ConfigurationScope Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*******************************************************************************
 * Copyright (c) 2004, 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 java.net.URL;
import org.eclipse.core.internal.preferences.AbstractScope;
import org.eclipse.core.internal.preferences.PreferencesOSGiUtils;
import org.eclipse.core.runtime.IPath;
import org.eclipse.osgi.service.datalocation.Location;

/**
 * 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. (The configuration area typically
 * contains the list of plug-ins available for use, various settings
 * (those shared across different instances of the same configuration)
 * and any other such data needed by plug-ins.)
 * 
 * 
 * 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.
 * 
 * @see Location#CONFIGURATION_FILTER
 * @since 3.0
 */
public final class ConfigurationScope extends AbstractScope {

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

	/**
	 * Singleton instance of a Configuration Scope object. Typical usage is:
	 * ConfigurationScope.INSTANCE.getNode(...);
	 *
	 * @since 3.4
	 */
	public static final IScopeContext INSTANCE = new ConfigurationScope();

	/**
	 * Create and return a new configuration scope instance.
	 * @deprecated use ConfigurationScope.INSTANCE instead
	 */
	public ConfigurationScope() {
		super();
	}


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


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


	@Override
	public IPath getLocation() {
		IPath result = null;
		Location location = PreferencesOSGiUtils.getDefault().getConfigurationLocation();
		if (!location.isReadOnly()) {
			URL url = location.getURL();
			if (url != null) {
				result = IPath.fromOSString(url.getFile());
				if (result.isEmpty())
					result = null;
			}
		}
		return result;
	}
}