org.outerrim.snippad.service.config.Configuration.java Source code

Introduction

Here is the source code for org.outerrim.snippad.service.config.Configuration.java

Source

/*
 * Filename : Configuration.java
 * Created on Oct 8, 2004
 *
 * Copyright (c)2004 Michael Osterlie
 *
 * This file is part of snippad.
 *
 * snippad is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * snippad is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Foobar; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package org.outerrim.snippad.service.config;

import java.io.IOException;
import java.util.Iterator;

import org.apache.commons.collections.buffer.CircularFifoBuffer;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.PreferenceStore;
import org.eclipse.swt.graphics.Point;
import org.outerrim.snippad.SnipPadConstants;

/**
 * Utility class to hold all configurable variables.
 *
 * @author darkjedi
 */
public class Configuration {
    /** */
    public static final String CSS_LOCATION = "css_location";

    /** */
    public static final String SHOW_EDITOR = "show_editor";

    /** */
    public static final String INITIAL_SIZE_X = "initial_size_x";

    /** */
    public static final String INITIAL_SIZE_Y = "initial_size_y";

    /** */
    public static final String SAVE_AS_LOCATION = "save_as_location";

    /** */
    public static final String RECENT_DOCUMENT = "recentDocument";

    /** */
    public static final String NUMBER_RECENT = "numberRecent";

    private static PreferenceStore store = new PreferenceStore(SnipPadConstants.PREFERENCE_FILENAME);

    private CircularFifoBuffer recentDocuments;

    private static final Log LOG = LogFactory.getLog(Configuration.class);

    /**
     */
    public Configuration() {
        init();
    }

    /**
     * @throws ConfigurationException On error
     */
    public void save() throws ConfigurationException {
        try {
            Iterator it = recentDocuments.iterator();
            for (int i = 1; it.hasNext(); ++i) {
                store.setValue(RECENT_DOCUMENT + "." + i, (String) it.next());
            }

            store.save();
        } catch (IOException e) {
            throw new ConfigurationException(e);
        }
    }

    /**
     * @throws ConfigurationException On error
     */
    public void load() throws ConfigurationException {
        try {
            store.load();

            int recent = store.getInt(NUMBER_RECENT);
            for (int i = 0; i < recent; ++i) {
                String file = store.getString(RECENT_DOCUMENT + "." + i);
                if (!file.equals("")) {
                    recentDocuments.add(file);
                }
            }
        } catch (IOException e) {
            throw new ConfigurationException(e);
        }
    }

    public IPreferenceStore getStore() {
        return store;
    }

    public Iterator getRecentDocumentsIterator() {
        return recentDocuments.iterator();
    }

    public int getRecentNumber() {
        return store.getInt(NUMBER_RECENT);
    }

    public String getCssLocation() {
        return store.getString(CSS_LOCATION);
    }

    public String getDefaultSaveAsLocation() {
        return store.getString(SAVE_AS_LOCATION);
    }

    /**
     * @return true if the editor should be shown
     */
    public boolean showEditor() {
        return store.getBoolean(SHOW_EDITOR);
    }

    public Point getInitialSize() {
        return new Point(store.getInt(INITIAL_SIZE_X), store.getInt(INITIAL_SIZE_Y));
    }

    /**
     * @param file File to add
     */
    public void addRecentDocument(final String file) {
        int storeSize = store.getInt(NUMBER_RECENT);
        if (storeSize != recentDocuments.maxSize()) {
            LOG.debug("Preference Store Recent Documents size has changed, " + "updating data structure");
            resizeRecentDocuments(storeSize);
        }

        if (recentDocuments.contains(file)) {
            LOG.debug("Document is already in the list, " + "removing before adding");
            recentDocuments.remove(file);
        }
        recentDocuments.add(file);
    }

    /**
     * @param loc default location
     */
    public void setDefaultSaveAsLocation(final String loc) {
        store.setValue(SAVE_AS_LOCATION, loc);
    }

    /**
     * @param x x
     * @param y y
     */
    public void setInitialSize(final int x, final int y) {
        store.setValue(INITIAL_SIZE_X, x);
        store.setValue(INITIAL_SIZE_Y, y);
    }

    // public void setCssLocation( String css ) { store.setValue( CSS_LOCATION,
    // css ); }
    // public void setShowEditor( boolean show ) { store.setValue( SHOW_EDITOR,
    // show ); }

    private void init() {
        store.setDefault(CSS_LOCATION, "http://snippad.berlios.de/snippad.css");
        store.setDefault(SHOW_EDITOR, true);
        store.setDefault(INITIAL_SIZE_X, 1024);
        store.setDefault(INITIAL_SIZE_Y, 600);
        store.setDefault(SAVE_AS_LOCATION, System.getProperty("user.home"));
        store.setDefault(NUMBER_RECENT, 4);

        recentDocuments = new CircularFifoBuffer(store.getInt(NUMBER_RECENT));
    }

    /**
     * Resizes the Recent Documents list.
     *
     * @param newSize
     *            the new size of the list
     */
    private void resizeRecentDocuments(final int newSize) {
        CircularFifoBuffer newBuffer = new CircularFifoBuffer(newSize);

        for (Iterator it = recentDocuments.iterator(); it.hasNext();) {
            newBuffer.add(it.next());
        }

        recentDocuments = newBuffer;
    }
}