OptionManager.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.settings.options;
 
import com.realtime.crossfire.jxclient.settings.Settings;
import com.realtime.crossfire.jxclient.settings.SettingsEntry;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.jetbrains.annotations.NotNull;
 
public class OptionManager {
 
    @NotNull
    private final Map<String, Entry> options = new HashMap<>();
 
    @NotNull
    private final Settings settings;
 
    public OptionManager(@NotNull final Settings settings) {
        this.settings = settings;
    }
 
    public void addOption(@NotNull final String optionName, @NotNull final String documentation, @NotNull final Option option) throws OptionException {
        if (options.containsKey(optionName)) {
            throw new OptionException("duplicate option name: "+optionName);
        }
 
        options.put(optionName, new Entry(option, documentation));
    }
 
    public void removeOption(@NotNull final String optionName) {
        options.remove(optionName);
    }
 
    @NotNull
    public Map<String, Entry> getOptions() {
        return Collections.unmodifiableMap(options);
    }
 
    @NotNull
    public CheckBoxOption getCheckBoxOption(@NotNull final String optionName) throws OptionException {
        final Entry entry = options.get(optionName);
        if (entry == null || !(entry.getOption() instanceof CheckBoxOption)) {
            throw new OptionException("Unknown option '"+optionName+"'");
        }
 
        return (CheckBoxOption)entry.getOption();
    }
 
    public void loadOptions() {
        for (Map.Entry<String, Entry> e : options.entrySet()) {
            final String optionName = e.getKey();
            final Object option = e.getValue().getOption();
            if (option instanceof CheckBoxOption) {
                final CheckBoxOption checkBoxOption = (CheckBoxOption)option;
                final boolean checked = settings.getBoolean(new SettingsEntry<>(optionName, checkBoxOption.isDefaultChecked(), null));
                if (checkBoxOption.isChecked() == checked) {
                    // make sure the appropriate option command is executed
                    checkBoxOption.fireStateChangedEvent();
                } else {
                    checkBoxOption.setChecked(checked);
                }
            } else {
                throw new AssertionError();
            }
        }
    }
 
    public void saveOptions() {
        for (Map.Entry<String, Entry> e : options.entrySet()) {
            final String optionName = e.getKey();
            final Entry entry = e.getValue();
            final Option option = entry.getOption();
            if (!option.inhibitSave()) {
                if (option instanceof CheckBoxOption) {
                    final CheckBoxOption checkBoxOption = (CheckBoxOption)option;
                    settings.putBoolean(new SettingsEntry<>(optionName, false, entry.getDocumentation()), checkBoxOption.isChecked());
                } else {
                    throw new AssertionError();
                }
            }
        }
    }
 
    public static class Entry {
 
        @NotNull
        private final Option option;
 
        @NotNull
        private final String documentation;
 
        private Entry(@NotNull final Option option, @NotNull final String documentation) {
            this.option = option;
            this.documentation = documentation;
        }
 
        @NotNull
        public Option getOption() {
            return option;
        }
 
        @NotNull
        public String getDocumentation() {
            return documentation;
        }
 
    }
 
}