FilePreferences.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2023 The Gridarta Developers.
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
package net.sf.gridarta.preferences;
 
import java.util.Arrays;
import java.util.prefs.AbstractPreferences;
import java.util.prefs.BackingStoreException;
import java.util.prefs.Preferences;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class FilePreferences extends AbstractPreferences {
 
    @NotNull
    private static final Category LOG = Logger.getLogger(FilePreferences.class);
 
    @NotNull
    private final NodeType nodeType;
 
    @NotNull
    private final String fullName;
 
    @NotNull
    private final Storage storage;
 
    protected FilePreferences(@Nullable final AbstractPreferences parent, @NotNull final String name, @NotNull final NodeType nodeType, @NotNull final Storage storage) {
        super(parent, name);
        this.nodeType = nodeType;
        this.storage = storage;
 
        final StringBuilder sb = new StringBuilder(name);
        for (Preferences p = parent; p != null; p = p.parent()) {
            sb.insert(0, '_').insert(0, p.name());
        }
        sb.insert(0, nodeType.getPrefix());
        fullName = sb.toString();
        storage.newNode(fullName);
    }
 
    @NotNull
    protected Storage getStorage() {
        return storage;
    }
 
    @NotNull
    @Override
    protected String @NotNull [] childrenNamesSpi() {
        final String[] result = storage.childrenNames(fullName);
        if (LOG.isDebugEnabled()) {
            LOG.debug("childrenNamesSpi(" + fullName + ")=" + Arrays.toString(result));
        }
        return result;
    }
 
    @Override
    protected AbstractPreferences childSpi(@NotNull final String name) {
        return new FilePreferencesNode(this, name, nodeType);
    }
 
    @Override
    protected void flushSpi() {
        throw new InternalError();
    }
 
    @Override
    public void flush() throws BackingStoreException {
        if (LOG.isDebugEnabled()) {
            LOG.debug("flush(" + fullName + ")");
        }
 
        storage.sync(false);
    }
 
    @Nullable
    @Override
    public String get(@NotNull final String key, @Nullable final String def) {
        //noinspection ConstantConditions
        if (key == null) {
            throw new IllegalArgumentException("null key");
        }
 
        String value;
        synchronized (lock) {
            if (isRemoved()) {
                if (LOG.isDebugEnabled()) {
                    LOG.debug("get(" + fullName + ", " + key + ") called for removed node");
                }
 
                throw new IllegalStateException("removed node");
            }
 
            //noinspection CatchGenericClass
            try {
                value = getSpi(key);
            } catch (final Exception ignored) {
                //noinspection AssignmentToNull
                value = null;
            }
            if (value == null) {
                if (def != null) {
                    putSpi(key, def);
                }
 
                value = def;
            }
        }
        if (LOG.isDebugEnabled()) {
            LOG.debug("get(" + fullName + ", " + key + ", " + def + ")=" + value);
        }
        return value;
    }
 
    @Override
    public boolean getBoolean(@NotNull final String key, final boolean def) {
        final boolean result = super.getBoolean(key, def);
        putSpi(key, Boolean.toString(result));
        return result;
    }
 
    @Override
    public double getDouble(@NotNull final String key, final double def) {
        final double result = super.getDouble(key, def);
        putSpi(key, Double.toString(result));
        return result;
    }
 
    @Override
    public float getFloat(@NotNull final String key, final float def) {
        final float result = super.getFloat(key, def);
        putSpi(key, Float.toString(result));
        return result;
    }
 
    @Override
    public int getInt(@NotNull final String key, final int def) {
        final int result = super.getInt(key, def);
        putSpi(key, Integer.toString(result));
        return result;
    }
 
    @Override
    public long getLong(@NotNull final String key, final long def) {
        final long result = super.getLong(key, def);
        putSpi(key, Long.toString(result));
        return result;
    }
 
    @Nullable
    @Override
    protected String getSpi(@NotNull final String key) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("getSpi(" + fullName + ", key=" + key + ")");
        }
 
        return storage.getValue(fullName, key);
    }
 
    @NotNull
    @Override
    protected String @NotNull [] keysSpi() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("keysSpi(" + fullName + ")");
        }
 
        return storage.getKeys(fullName);
    }
 
    @Override
    protected void putSpi(@NotNull final String key, @NotNull final String value) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("putSpi(" + fullName + ", key=" + key + ", value=" + value + ")");
        }
 
        storage.putValue(fullName, key, value);
    }
 
    @Override
    protected void removeNodeSpi() {
        if (LOG.isDebugEnabled()) {
            LOG.debug("removeNodeSpi(" + fullName + ")");
        }
 
        storage.removeNode(fullName);
    }
 
    @Override
    protected void removeSpi(@NotNull final String key) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("removeSpi(" + fullName + ", key=" + key + ")");
        }
 
        storage.removeValue(fullName, key);
    }
 
    @Override
    protected void syncSpi() {
        throw new InternalError();
    }
 
    @Override
    public void sync() throws BackingStoreException {
        if (LOG.isDebugEnabled()) {
            LOG.debug("sync(" + fullName + ")");
        }
 
        storage.sync(true);
    }
 
}