XMLSpellLoader.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 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.model.spells;

import net.sf.gridarta.model.errorview.ErrorViewCategory;
import net.sf.gridarta.model.errorview.ErrorViewCollector;
import net.sf.gridarta.utils.xml.ElementsIterable;
import nu.xom.Document;
import nu.xom.Element;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;

public class XMLSpellLoader {

    @NotNull
    private static final Category LOG = Logger.getLogger(XMLSpellLoader.class);

    private XMLSpellLoader() {
    }

    public static void load(@NotNull final ErrorViewCollector errorViewCollector, @NotNull final Document document, @NotNull final Spells<NumberSpell> spells) {
        // retrieve the spell data from the xml
        final Element root = document.getRootElement();
        if (root == null || !root.getLocalName().equals("spells")) {
            errorViewCollector.addWarning(ErrorViewCategory.SPELLS_ENTRY_INVALID, "root element 'spells' is missing");
        } else {
            // initialize array with appropriate size
            int numSpells = 0;
            for (final Element spellElem : new ElementsIterable(root.getChildElements("spell"))) {
                if (spellElem.getAttribute("id") == null) {
                    errorViewCollector.addWarning(ErrorViewCategory.SPELLS_ENTRY_INVALID, "found 'spell' element without 'id'");
                } else if (spellElem.getAttribute("name") == null) {
                    errorViewCollector.addWarning(ErrorViewCategory.SPELLS_ENTRY_INVALID, "found 'spell' element without 'name'");
                } else {
                    try {
                        // parse spell number and -name
                        spells.add(new NumberSpell(spellElem.getAttribute("name").getValue().trim(), Integer.parseInt(spellElem.getAttribute("id").getValue())));
                        numSpells++;
                    } catch (final NumberFormatException ignored) {
                        errorViewCollector.addWarning(ErrorViewCategory.SPELLS_ENTRY_INVALID, "parsing error: spell id '" + spellElem.getAttribute("id") + "' is not an integer.");
                    }
                }
            }

            // loading successful
            if (LOG.isInfoEnabled()) {
                LOG.info("Loaded " + numSpells + " defined spells.");
            }
            if (numSpells == 0) {
                errorViewCollector.addWarning(ErrorViewCategory.SPELLS_FILE_INVALID, "no content");
            }
        }
    }

}