PluginParameterCodec.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.plugin.parameter;
 
import net.sf.gridarta.model.archetype.Archetype;
import net.sf.gridarta.model.gameobject.GameObject;
import net.sf.gridarta.model.maparchobject.MapArchObject;
import net.sf.gridarta.utils.XmlUtils;
import nu.xom.Element;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class PluginParameterCodec<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> {
 
    @NotNull
    private final PluginParameterVisitor<G, A, R, Element> toXML = new PluginParameterVisitor<G, A, R, Element>() {
 
        @NotNull
        private Element toXML(@NotNull final PluginParameter<G, A, R, ?> parameter) {
            final Element e = new Element("parameter");
            final Element n = new Element("name");
            final Element d = new Element("description");
            final Element t = new Element("type");
            n.appendChild(parameter.getName());
            d.appendChild(parameter.getDescription());
            t.appendChild(parameter.getParameterType());
            e.appendChild(n);
            e.appendChild(d);
            e.appendChild(t);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final ArchetypeParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element v = new Element("value");
            v.appendChild(parameter.getStringValue());
            e.appendChild(v);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final BooleanParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element v = new Element("value");
            v.appendChild(parameter.getStringValue());
            e.appendChild(v);
            final Element yes = new Element("trueText");
            yes.appendChild(parameter.getTrueText());
            final Element no = new Element("falseText");
            no.appendChild(parameter.getFalseText());
            e.appendChild(yes);
            e.appendChild(no);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final DoubleParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element v = new Element("value");
            v.appendChild(parameter.getStringValue());
            e.appendChild(v);
            final Element min = new Element("minimum");
            final Element max = new Element("maximum");
            min.appendChild(Double.toString(parameter.getMin()));
            max.appendChild(Double.toString(parameter.getMax()));
            e.appendChild(min);
            e.appendChild(max);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final IntegerParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element v = new Element("value");
            v.appendChild(parameter.getStringValue());
            e.appendChild(v);
            final Element min = new Element("minimum");
            final Element max = new Element("maximum");
            min.appendChild(Integer.toString(parameter.getMin()));
            max.appendChild(Integer.toString(parameter.getMax()));
            e.appendChild(min);
            e.appendChild(max);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final MapParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element v = new Element("value");
            v.appendChild(parameter.isCurrentMap() ? "" : parameter.getStringValue());
            e.appendChild(v);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final MapPathParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element s = new Element("value");
            s.appendChild(parameter.getStringValue());
            e.appendChild(s);
            return e;
        }
 
        @NotNull
        @Override
        public Element visit(@NotNull final StringParameter<G, A, R> parameter) {
            final Element e = toXML(parameter);
            final Element s = new Element("value");
            s.appendChild(parameter.getStringValue());
            e.appendChild(s);
            return e;
        }
 
    };
 
    @NotNull
    private final PluginParameterVisitor<G, A, R, PluginParameter<G, A, R, ?>> fromXML = new PluginParameterVisitor<G, A, R, PluginParameter<G, A, R, ?>>() {
 
        private void fromXML(@NotNull final PluginParameter<G, A, R, ?> parameter) {
            parameter.setName(getChildText("name", "undefined"));
            parameter.setDescription(getChildText("description", ""));
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final ArchetypeParameter<G, A, R> parameter) {
            fromXML(parameter);
            parameter.setStringValue(getChildText("value", ""));
            return parameter;
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final BooleanParameter<G, A, R> parameter) {
            fromXML(parameter);
            parameter.setStringValue(getChildText("value", ""));
            parameter.setTrueText(getChildText("trueText", "Yes"));
            parameter.setFalseText(getChildText("falseText", "No"));
            return parameter;
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final DoubleParameter<G, A, R> parameter) {
            fromXML(parameter);
            try {
                parameter.setMin(Double.parseDouble(getChildText("minimum", "0.0")));
            } catch (final NumberFormatException ignored) {
            }
            try {
                parameter.setMax(Double.parseDouble(getChildText("maximum", "1.0")));
            } catch (final NumberFormatException ignored) {
            }
            parameter.setStringValue(getChildText("value", ""));
            return parameter;
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final IntegerParameter<G, A, R> parameter) {
            fromXML(parameter);
            try {
                parameter.setMin(Integer.parseInt(getChildText("minimum", Integer.toString(Integer.MIN_VALUE))));
            } catch (final NumberFormatException ignored) {
            }
            try {
                parameter.setMax(Integer.parseInt(getChildText("maximum", Integer.toString(Integer.MAX_VALUE))));
            } catch (final NumberFormatException ignored) {
            }
            parameter.setStringValue(XmlUtils.getChild(e, "value").getValue().trim());
            return parameter;
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final MapParameter<G, A, R> parameter) {
            fromXML(parameter);
            parameter.setStringValue(getChildText("value", ""));
            return parameter;
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final MapPathParameter<G, A, R> parameter) {
            fromXML(parameter);
            parameter.setStringValue(getChildText("value", ""));
            return parameter;
        }
 
        @NotNull
        @Override
        public PluginParameter<G, A, R, ?> visit(@NotNull final StringParameter<G, A, R> parameter) {
            fromXML(parameter);
            parameter.setStringValue(getChildText("value", ""));
            return parameter;
        }
 
    };
 
    @Nullable
    private Element e;
 
    @NotNull
    public Element toXML(@NotNull final PluginParameter<G, A, R, ?> parameter) {
        return parameter.visit(toXML);
    }
 
    public void fromXML(@NotNull final PluginParameter<G, A, R, ?> parameter, @NotNull final Element e) {
        this.e = e;
        parameter.visit(fromXML);
        this.e = null;
    }
 
    @NotNull
    private String getChildText(@NotNull final String key, @NotNull final String defaultValue) {
        assert e != null;
        final String value = XmlUtils.getChild(e, key).getValue().trim();
        return value == null ? defaultValue : value;
    }
 
}