http://www.eclipse.org/platform: Eclipse Preferences Mechanism (Eclipse Foundation) 
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

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


Abstract class used to aid in default preference value initialization.
Clients who extend the org.eclipse.equinox.preferences.preferences
or the org.eclipse.core.runtime.preferences
extension point are able to specify a class within an initializer
element.

Since:3.0
/**
 * Abstract class used to aid in default preference value initialization.
 * Clients who extend the <code>org.eclipse.equinox.preferences.preferences</code>
 * or the <code>org.eclipse.core.runtime.preferences</code>
 * extension point are able to specify a class within an <code>initializer</code>
 * element.
 *
 * @since 3.0
 */
public abstract class AbstractPreferenceInitializer {

	
Default constructor for the class.

/**
	 * Default constructor for the class.
	 */
	public AbstractPreferenceInitializer() {
		super();
	}

	
This method is called by the preference initializer to initialize default
preference values. Clients should get the correct node for their
bundle and then set the default values on it. For example:

		public void initializeDefaultPreferences() {
			Preferences node = new DefaultScope().getNode("my.bundle.id");
			node.put(key, value);
		}




Note: Clients should only set default preference values for their
own bundle.




Note: Clients should not call this method. It will be called
automatically by the preference initializer when the appropriate default
preference node is accessed.



/**
	 * This method is called by the preference initializer to initialize default
	 * preference values. Clients should get the correct node for their
	 * bundle and then set the default values on it. For example:
	 * <pre>
	 *			public void initializeDefaultPreferences() {
	 *				Preferences node = new DefaultScope().getNode("my.bundle.id");
	 *				node.put(key, value);
	 *			}
	 * </pre>
	 * <p>
	 * <em>Note: Clients should only set default preference values for their
	 * own bundle.</em>
	 * </p>
	 * <p>
	 * <em>Note:</em> Clients should not call this method. It will be called
	 * automatically by the preference initializer when the appropriate default
	 * preference node is accessed.
	 * </p>
	 */
	public abstract void initializeDefaultPreferences();

}