XmlStreamReader.java

/*
 * Copyright (c) 2007-2008, debug-commons team
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.rubyforge.debugcommons.reader;

import java.io.IOException;
import org.rubyforge.debugcommons.Util;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;

public abstract class XmlStreamReader {
    
    protected final XmlPullParser xpp;
    
    public XmlStreamReader(XmlPullParser xpp) {
        this.xpp = xpp;
    }

    protected void ensureEndTag(final String name) throws XmlPullParserException, IOException {
        ensureEndTag(xpp, name);
    }

    public static void ensureEndTag(XmlPullParser xpp, final String name) throws XmlPullParserException, IOException {
        xpp.next();
        ensureAtEndTag(xpp, name);
    }

    protected static void ensureAtEndTag(XmlPullParser xpp, final String name) throws XmlPullParserException, IOException {
        if (xpp.getEventType() != XmlPullParser.END_TAG && !name.equals(xpp.getName())) {
            throw new IllegalStateException(
                    "Unexpected event. Expecting " + name + " end tag." + xpp.getName());
        }
    }

    /**
     * Works like {@link XmlPullParser#next} but skips all {@link
     * XmlPullParser#TEXT} events.
     */
    protected int nextEvent() throws XmlPullParserException, IOException {
        int eventType = -1;
        while ((eventType = xpp.next()) == XmlPullParser.TEXT) {
            // skip, just log
            Util.logEvent(xpp);
        }
        Util.logEvent(xpp);
        return eventType;
    }
    
    protected String getAttributeValue(final String attrName) {
        return xpp.getAttributeValue("", attrName);
    }
    
    protected int getAttributeIntValue(final String attrName) {
        return Integer.parseInt(getAttributeValue(attrName));
    }
    
    protected boolean getAttributeBoolValue(final String attrName) {
        return "true".equals(getAttributeValue(attrName));
    }
    
}