com.thoughtworks.xstream.io.xml.xppdom.XppDom Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xstream Show documentation
There is a newer version: 1.4.21
/*
 * Copyright (C) 2009, 2011 XStream Committers.
 * All rights reserved.
 *
 * The software in this package is published under the terms of the BSD
 * style license a copy of which has been included with this distribution in
 * the LICENSE.txt file.
 * 
 * Created on 02. May 2009 by Joerg Schaible
 */
package com.thoughtworks.xstream.io.xml.xppdom;

import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;

import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;


/**
 * Simple Document Object Model for XmlPullParser implementations.
 * 
 * @author Jason van Zyl
 * @author Joe Walnes
 * @author Jörg Schaible
 * @since 1.4
 */
public class XppDom implements Serializable {
    private static final long serialVersionUID = 1L;
    
    private String name;
    private String value;
    private Map attributes;
    private List childList;
    transient private Map childMap;
    private XppDom parent;

    public XppDom(String name) {
        this.name = name;
        childList = new ArrayList();
        childMap = new HashMap();
    }

    // ----------------------------------------------------------------------
    // Name handling
    // ----------------------------------------------------------------------

    public String getName() {
        return name;
    }

    // ----------------------------------------------------------------------
    // Value handling
    // ----------------------------------------------------------------------

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    // ----------------------------------------------------------------------
    // Attribute handling
    // ----------------------------------------------------------------------

    public String[] getAttributeNames() {
        if (null == attributes) {
            return new String[0];
        } else {
            return (String[])attributes.keySet().toArray(new String[0]);
        }
    }

    public String getAttribute(String name) {
        return (null != attributes) ? (String)attributes.get(name) : null;
    }

    public void setAttribute(String name, String value) {
        if (null == attributes) {
            attributes = new HashMap();
        }

        attributes.put(name, value);
    }

    // ----------------------------------------------------------------------
    // Child handling
    // ----------------------------------------------------------------------

    public XppDom getChild(int i) {
        return (XppDom)childList.get(i);
    }

    public XppDom getChild(String name) {
        return (XppDom)childMap.get(name);
    }

    public void addChild(XppDom xpp3Dom) {
        xpp3Dom.setParent(this);
        childList.add(xpp3Dom);
        childMap.put(xpp3Dom.getName(), xpp3Dom);
    }

    public XppDom[] getChildren() {
        if (null == childList) {
            return new XppDom[0];
        } else {
            return (XppDom[])childList.toArray(new XppDom[0]);
        }
    }

    public XppDom[] getChildren(String name) {
        if (null == childList) {
            return new XppDom[0];
        } else {
            ArrayList children = new ArrayList();
            int size = this.childList.size();

            for (int i = 0; i < size; i++ ) {
                XppDom configuration = (XppDom)this.childList.get(i);
                if (name.equals(configuration.getName())) {
                    children.add(configuration);
                }
            }

            return (XppDom[])children.toArray(new XppDom[0]);
        }
    }

    public int getChildCount() {
        if (null == childList) {
            return 0;
        }

        return childList.size();
    }

    // ----------------------------------------------------------------------
    // Parent handling
    // ----------------------------------------------------------------------

    public XppDom getParent() {
        return parent;
    }

    public void setParent(XppDom parent) {
        this.parent = parent;
    }

    // ----------------------------------------------------------------------
    // Serialization
    // ----------------------------------------------------------------------

    Object readResolve() {
        childMap = new HashMap();
        for (final Iterator iter = childList.iterator(); iter.hasNext();) {
            final XppDom element = (XppDom)iter.next();
            childMap.put(element.getName(), element);
        }
        return this;
    }

    // ----------------------------------------------------------------------
    // DOM builder
    // ----------------------------------------------------------------------

    /**
     * Build an XPP DOM hierarchy. The {@link java.io.InputStream} or {@link java.io.Reader}
     * used by the parser must have already been set. The method does not close it after reading
     * the document's end.
     * 
     * @param parser the XPP instance
     * @throws XmlPullParserException if the parser turns into an invalid state or reads invalid
     *             XML
     * @throws IOException if the data cannot be read
     */
    public static XppDom build(XmlPullParser parser) throws XmlPullParserException, IOException {
        List elements = new ArrayList();
        List values = new ArrayList();
        XppDom node = null;

        int eventType = parser.getEventType();
        while (eventType != XmlPullParser.END_DOCUMENT) {
            if (eventType == XmlPullParser.START_TAG) {
                String rawName = parser.getName();

                // Use XppDom when deprecated Xpp3Dom is removed
                XppDom child = new Xpp3Dom(rawName);

                int depth = elements.size();
                if (depth > 0) {
                    XppDom parent = (XppDom)elements.get(depth - 1);
                    parent.addChild(child);
                }

                elements.add(child);
                values.add(new StringBuffer());

                int attributesSize = parser.getAttributeCount();
                for (int i = 0; i < attributesSize; i++ ) {
                    String name = parser.getAttributeName(i);
                    String value = parser.getAttributeValue(i);
                    child.setAttribute(name, value);
                }
            } else if (eventType == XmlPullParser.TEXT) {
                int depth = values.size() - 1;
                StringBuffer valueBuffer = (StringBuffer)values.get(depth);
                valueBuffer.append(parser.getText());
            } else if (eventType == XmlPullParser.END_TAG) {
                int depth = elements.size() - 1;
                XppDom finalNode = (XppDom)elements.remove(depth);
                String accumulatedValue = (values.remove(depth)).toString();

                String finishedValue;
                if (0 == accumulatedValue.length()) {
                    finishedValue = null;
                } else {
                    finishedValue = accumulatedValue;
                }

                finalNode.setValue(finishedValue);
                if (0 == depth) {
                    node = finalNode;
                }
            }

            eventType = parser.next();
        }

        return node;
    }
}