/*--

 Copyright (C) 2012 Jason Hunter & Brett McLaughlin.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions, and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions, and the disclaimer that follows
    these conditions in the documentation and/or other materials
    provided with the distribution.

 3. The name "JDOM" must not be used to endorse or promote products
    derived from this software without prior written permission.  For
    written permission, please contact <request_AT_jdom_DOT_org>.

 4. Products derived from this software may not be called "JDOM", nor
    may "JDOM" appear in their name, without prior written permission
    from the JDOM Project Management <request_AT_jdom_DOT_org>.

 In addition, we request (but do not require) that you include in the
 end-user documentation provided with the redistribution and/or in the
 software itself an acknowledgement equivalent to the following:
     "This product includes software developed by the
      JDOM Project (http://www.jdom.org/)."
 Alternatively, the acknowledgment may be graphical using the logos
 available at http://www.jdom.org/images/logos.

 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 JDOM AUTHORS OR THE PROJECT
 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.

 This software consists of voluntary contributions made by many
 individuals on behalf of the JDOM Project and was originally
 created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
 Brett McLaughlin <brett_AT_jdom_DOT_org>.  For more information
 on the JDOM Project, please see <http://www.jdom.org/>.

 */

package org.jdom2.input.sax;

import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;

import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;

import org.jdom2.JDOMException;

/**
 * Create XMLReaders directly from the javax.xml.parsers.SAXParserFactory API using an explicit
 * implementation of the parser instead of relying on the default JAXP search path.
 * <p>
 * If you want to rely on the default JAXP search mechanism you should instead use one of the simple
 * members of the {@link XMLReaders} enumeration, or use one of the simple constructors on
 * {@link XMLReaderXSDFactory} or {@link XMLReaderSchemaFactory}.
 * <p>
 * See the documentation for {@link SAXParserFactory} for the details on what the factoryClassName
 * and classLoader should be.
 * 
 * @see org.jdom2.input.sax
 * @since 2.0.3
 * @author Rolf Lear
 */
public class XMLReaderJAXPFactory implements XMLReaderJDOMFactory {

	private final SAXParserFactory instance;
	private final boolean validating;
	
	/**
	 * Create an XMLReaderJAXPFactory using the specified factory name, classloader, and
	 * dtdvalidating flag.
	 * @param factoryClassName The name of the implementation to use for the SAXParserFactory.
	 * @param classLoader The classloader to use for locating the SAXParserFactory (may be null).
	 * @param dtdvalidate Whether this should create DTD Validating XMLReaders.
	 */
	public XMLReaderJAXPFactory(final String factoryClassName, final ClassLoader classLoader,
			boolean dtdvalidate) {
		instance = SAXParserFactory.newInstance(factoryClassName, classLoader);
		instance.setNamespaceAware(true);
		instance.setValidating(dtdvalidate);
		validating = dtdvalidate;
	}

	@Override
	public XMLReader createXMLReader() throws JDOMException {
		try {
			return instance.newSAXParser().getXMLReader();
		} catch (SAXException e) {
			throw new JDOMException(
					"Unable to create a new XMLReader instance", e);
		} catch (ParserConfigurationException e) {
			throw new JDOMException(
					"Unable to create a new XMLReader instance", e);
		}
	}

	@Override
	public boolean isValidating() {
		return validating;
	}

}
