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

/*******************************************************************************
 * 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;

/**
 * Represents a node in the preference hierarchy which is used in
 * the import/export mechanism.
 * 
 * This interface is not intended to be implemented by clients.
 * 
 * @since 3.0
 * @noextend This interface is not intended to be extended by clients.
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IExportedPreferences extends IEclipsePreferences {

	/**
	 * Return true if this node was an export root
	 * when the preferences were exported, and false
	 * otherwise.  This information is used during the import to clear
	 * nodes when importing a node's (and its children's) preferences.
	 *
	 * @return true if this node is an export root
	 * 	and false otherwise
	 */
	public boolean isExportRoot();

}