XmlParser.java

/*******************************************************************************
 * Copyright (c) 2008, 2009 Bug Labs, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    - Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *    - Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    - Neither the name of Bug Labs, Inc. nor the names of its contributors may be
 *      used to endorse or promote products derived from this software without
 *      specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *******************************************************************************/
package com.buglabs.util.xml;

import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;

/**
 * <code>XMLParser</code> is a highly-simplified XML DOM parser, that uses xpp for parsing.
 * 
 * @deprecated This class simply calls static parse methods on com.buglabs.util.xml.XmlNode.
 */
public class XmlParser {

	private final boolean ignoreNamespaces;

	public XmlParser() {
		ignoreNamespaces = false;
	}

	public XmlParser(boolean ignoreNamespaces) {
		this.ignoreNamespaces = ignoreNamespaces;	
	}

	/**
	 * Parse a string containing XML into a tree of XMLElement nodes.
	 * 
	 * @param xml
	 * @return XMLElement
	 * @throws IOException
	 */
	public static XmlNode parse(String xml) throws IOException {
		return XmlNode.parse(xml);
	}

	/**
	 * Parse a string containing XML into a tree of XMLElement nodes.
	 * 
	 * @param xml
	 * @return XMLElement
	 * @throws IOException
	 */
	public static XmlNode parse(String xml, boolean ignoreNamespaces) throws IOException {
		return XmlNode.parse(new StringReader(xml), !ignoreNamespaces);
	}

	/**
	 * Parse a string containing XML into a tree of XMLElement nodes.
	 * 
	 * @param xml
	 * @return XMLElement
	 * @throws IOException
	 */
	public static XmlNode parse(Reader reader, boolean ignoreNamespaces) throws IOException {
		return XmlNode.parse(reader, !ignoreNamespaces);
	}

	public XmlNode parse(Reader reader) throws IOException {
		return XmlNode.parse(reader, ignoreNamespaces);
	}
}