manifestpreferencestore.java

eclipseme的最新版本的source,欢迎j2me程序员使用

/**
 * Copyright (c) 2003-2005 Craig Setera
 * All Rights Reserved.
 * Licensed under the Eclipse Public License - v 1.0
 * For more information see http://www.eclipse.org/legal/epl-v10.html
 */
package eclipseme.ui.internal.utils;

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.Reader;

import org.eclipse.jface.preference.IPersistentPreferenceStore;
import org.eclipse.jface.preference.PreferenceStore;
import org.eclipse.jface.util.IPropertyChangeListener;

/**
 * An IPreferenceStore implementation that reads and writes
 * the information as a Manifest format file.
 * <p />
 * Copyright (c) 2003-2005 Craig Setera<br>
 * All Rights Reserved.<br>
 * Licensed under the Eclipse Public License - v 1.0<p/>
 * <br>
 * $Revision: 1.4 $
 * <br>
 * $Date: 2005/08/04 01:48:07 $
 * <br>
 * @author Craig Setera
 */
public class ManifestPreferenceStore implements IPersistentPreferenceStore
{
	// We need to track our own dirty flag instead of using
	// the one in the wrapped preference store.
	private boolean dirty;
	
	// The name of the file to be used for storage
	private String filename;
	
	// Wrap a JFace preference store to do the hard work and delegate most
	// functions
	private PreferenceStore wrappedPrefStore;
	 
	/**
	 * Creates an empty preference store that loads from and saves to the
	 * a file.
	 * <p>
	 * Use the methods <code>load()</code> and <code>save()</code> to load and store this
	 * preference store.
	 * </p>
	 *
	 * @param filename the file name
	 * @see #load()
	 * @see #save()
	 */
	public ManifestPreferenceStore() {
		this(null);
	}

	/**
	 * Creates an empty preference store that loads from and saves to the
	 * a file.
	 * <p>
	 * Use the methods <code>load()</code> and <code>save()</code> to load and store this
	 * preference store.
	 * </p>
	 *
	 * @param filename the file name
	 * @see #load()
	 * @see #save()
	 */
	public ManifestPreferenceStore(String filename) {
		this.filename = filename;
		wrappedPrefStore = new PreferenceStore();
		dirty = false;
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)
	 */
	public void addPropertyChangeListener(IPropertyChangeListener listener) {
		wrappedPrefStore.addPropertyChangeListener(listener);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#contains(java.lang.String)
	 */
	public boolean contains(String name) {
		return wrappedPrefStore.contains(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#firePropertyChangeEvent(java.lang.String, java.lang.Object, java.lang.Object)
	 */
	public void firePropertyChangeEvent(String name, Object oldValue, Object newValue) {
		wrappedPrefStore.firePropertyChangeEvent(name, oldValue, newValue);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getBoolean(java.lang.String)
	 */
	public boolean getBoolean(String name) {
		return wrappedPrefStore.getBoolean(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultBoolean(java.lang.String)
	 */
	public boolean getDefaultBoolean(String name) {
		return wrappedPrefStore.getDefaultBoolean(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultDouble(java.lang.String)
	 */
	public double getDefaultDouble(String name) {
		return wrappedPrefStore.getDefaultDouble(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultFloat(java.lang.String)
	 */
	public float getDefaultFloat(String name) {
		return wrappedPrefStore.getDefaultFloat(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultInt(java.lang.String)
	 */
	public int getDefaultInt(String name) {
		return wrappedPrefStore.getDefaultInt(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultLong(java.lang.String)
	 */
	public long getDefaultLong(String name) {
		return wrappedPrefStore.getDefaultLong(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultString(java.lang.String)
	 */
	public String getDefaultString(String name) {
		return wrappedPrefStore.getDefaultString(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getDouble(java.lang.String)
	 */
	public double getDouble(String name) {
		return wrappedPrefStore.getDouble(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getFloat(java.lang.String)
	 */
	public float getFloat(String name) {
		return wrappedPrefStore.getFloat(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getInt(java.lang.String)
	 */
	public int getInt(String name) {
		return wrappedPrefStore.getInt(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getLong(java.lang.String)
	 */
	public long getLong(String name) {
		return wrappedPrefStore.getLong(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#getString(java.lang.String)
	 */
	public String getString(String name) {
		return wrappedPrefStore.getString(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#isDefault(java.lang.String)
	 */
	public boolean isDefault(String name) {
		return wrappedPrefStore.isDefault(name);
	}

	/**
	 * Loads this preference store from the file established in the constructor 
	 * <code>PreferenceStore(java.lang.String)</code> (or by <code>setFileName</code>).
	 * Default preference values are not affected.
	 *
	 * @exception java.io.IOException if there is a problem loading this store
	 */
	public void load() throws IOException {
		if (filename == null)
			throw new IOException("File name not specified");//$NON-NLS-1$
			
		FileInputStream in = new FileInputStream(filename);
		load(in);
		in.close();
	}

	/**
	 * Loads this preference store from the given input stream. Default preference
	 * values are not affected.
	 *
	 * @param in the input stream
	 * @exception java.io.IOException if there is a problem loading this store
	 */
	public void load(InputStream in) throws IOException {
		Reader dataReader = new InputStreamReader(in, "UTF-8");
		BufferedReader bufferedReader = new BufferedReader(dataReader);
		
		String line = null;
		while ((line = bufferedReader.readLine()) != null) {
			// Find the first colon and break the string up
			int colonIndex = line.indexOf(':');
			if (colonIndex != -1) {
				String name = line.substring(0, colonIndex);
				String value = line.substring(colonIndex + 2);
				setValue(name, value);
			}
		}
		
		dirty = false;
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#needsSaving()
	 */
	public boolean needsSaving() {
		return dirty;
	}

	/**
	 * Returns an arry of all preferences known to this store which
	 * have current values other than their default value.
	 *
	 * @return an array of preference names 
	 */
	public String[] preferenceNames() {
		return wrappedPrefStore.preferenceNames();
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#putValue(java.lang.String, java.lang.String)
	 */
	public void putValue(String name, String value) {
		String oldValue = getString(name);
		if (oldValue == null || !oldValue.equals(value)) {
			wrappedPrefStore.putValue(name, value);
			dirty = true;
		}
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)
	 */
	public void removePropertyChangeListener(IPropertyChangeListener listener) {
		wrappedPrefStore.removePropertyChangeListener(listener);
	}

	/**
	 * @see org.eclipse.jface.preference.IPersistentPreferenceStore#save()
	 */
	public void save() throws IOException {
		if (filename == null)
			throw new IOException("File name not specified");//$NON-NLS-1$
			
		FileOutputStream out = null;
		try {
			out = new FileOutputStream(filename);
			save(out);
		} finally {
			if (out != null)
				out.close();
		}
	}
	
	/**
	 * Saves this preference store to the given output stream. The
	 * given string is inserted as header information.
	 *
	 * @param out the output stream
	 * @exception java.io.IOException if there is a problem saving this store
	 */
	public void save(OutputStream out) throws IOException {
		OutputStreamWriter osw = new OutputStreamWriter(out, "UTF-8");
		PrintWriter writer = new PrintWriter(osw);
		
		String[] prefNames = preferenceNames();
		for (int i = 0; i < prefNames.length; i++) {
			String name = prefNames[i];
			String value = getString(name);
			writer.println(name + ": " + value);
		}
		
		writer.flush();
		dirty = false;
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, double)
	 */
	public void setDefault(String name, double value) {
		wrappedPrefStore.setDefault(name, value);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, float)
	 */
	public void setDefault(String name, float value) {
		wrappedPrefStore.setDefault(name, value);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, int)
	 */
	public void setDefault(String name, int value) {
		wrappedPrefStore.setDefault(name, value);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, long)
	 */
	public void setDefault(String name, long value) {
		wrappedPrefStore.setDefault(name, value);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, java.lang.String)
	 */
	public void setDefault(String name, String defaultObject) {
		wrappedPrefStore.setDefault(name, defaultObject);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, boolean)
	 */
	public void setDefault(String name, boolean value) {
		wrappedPrefStore.setDefault(name, value);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setToDefault(java.lang.String)
	 */
	public void setToDefault(String name) {
		dirty = true;
		wrappedPrefStore.setToDefault(name);
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, double)
	 */
	public void setValue(String name, double value) {
		double oldValue = getDouble(name);
		if (value != oldValue) {
			dirty = true;
			wrappedPrefStore.setValue(name, value);
		}
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, float)
	 */
	public void setValue(String name, float value) {
		float oldValue = getFloat(name);
		if (value != oldValue) {
			dirty = true;
			wrappedPrefStore.setValue(name, value);
		}
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, int)
	 */
	public void setValue(String name, int value) {
		int oldValue = getInt(name);
		if (value != oldValue) {
			dirty = true;
			wrappedPrefStore.setValue(name, value);
		}
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, long)
	 */
	public void setValue(String name, long value) {
		long oldValue = getLong(name);
		if (value != oldValue) {
			dirty = true;
			wrappedPrefStore.setValue(name, value);
		}
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, java.lang.String)
	 */
	public void setValue(String name, String value) {
		String oldValue = getString(name);
		if (value != oldValue) {
			dirty = true;
			wrappedPrefStore.setValue(name, value);
		}
	}

	/**
	 * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, boolean)
	 */
	public void setValue(String name, boolean value) {
		boolean oldValue = getBoolean(name);
		if (value != oldValue) {
			dirty = true;
			wrappedPrefStore.setValue(name, value);
		}
	}
}