tests/org.eclipse.core.tests.runtime/src/org/eclipse/core/tests/internal/preferences/TestScope.java

/*******************************************************************************
 * Copyright (c) 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.tests.internal.preferences;

import org.eclipse.core.internal.preferences.EclipsePreferences;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.preferences.*;
import org.osgi.service.prefs.BackingStoreException;

/**
 * @since 3.0
 */
public class TestScope extends EclipsePreferences implements IScopeContext {

	public static final String SCOPE = "test"; //$NON-NLS-1$

	public TestScope() {
		super(null, null);
	}

	private TestScope(IEclipsePreferences parent, String key) {
		super(parent, key);
	}

	public void flush() {
		// don't store the values but a side effect is that the nodes
		// are marked as not dirty.
		makeClean();
	}

	public IPath getLocation() {
		return null;
	}

	public String getName() {
		return SCOPE;
	}

	public IEclipsePreferences getNode(String qualifier) {
		return (IEclipsePreferences) Platform.getPreferencesService().getRootNode().node(SCOPE).node(qualifier);
	}

	protected EclipsePreferences internalCreate(IEclipsePreferences nodeParent, String nodeName) {
		return new TestScope(nodeParent, nodeName);
	}

	public boolean isDirty() {
		return dirty;
	}

	/**
	 * Recursively mark all nodes in this hierarchy as clean
	 *
	 */
	protected void makeClean() {
		IPreferenceNodeVisitor visitor = new IPreferenceNodeVisitor() {
			public boolean visit(IEclipsePreferences node) {
				((TestScope) node).setDirty(false);
				return true;
			}
		};
		try {
			accept(visitor);
		} catch (BackingStoreException e) {
			// shouldn't happen
		}
	}

	void setDirty(boolean value) {
		dirty = value;
	}

	public void sync() {
		// don't store the values but a side effect is that the nodes
		// are marked as not dirty.
		makeClean();
	}
}