/*

 * Copyright 2000-2005 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

// SAX parser factory.

// http://www.saxproject.org

// No warranty; no copyright -- use this as you will.

// $Id: ParserFactory.java,v 1.2 2004/11/03 22:53:09 jsuttor Exp $

package org.xml.sax.helpers;

import java.lang.ClassNotFoundException;

import java.lang.IllegalAccessException;

import java.lang.InstantiationException;

import java.lang.SecurityException;

import java.lang.ClassCastException;

import org.xml.sax.Parser;

/**

 * Java-specific class for dynamically loading SAX parsers.

 *

 * <blockquote>

 * <em>This module, both source code and documentation, is in the

 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>

 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>

 * for further information.

 * </blockquote>

 *

 * <p><strong>Note:</strong> This class is designed to work with the now-deprecated

 * SAX1 {@link org.xml.sax.Parser Parser} class.  SAX2 applications should use

 * {@link org.xml.sax.helpers.XMLReaderFactory XMLReaderFactory} instead.</p>

 *

 * <p>ParserFactory is not part of the platform-independent definition

 * of SAX; it is an additional convenience class designed

 * specifically for Java XML application writers.  SAX applications

 * can use the static methods in this class to allocate a SAX parser

 * dynamically at run-time based either on the value of the

 * `org.xml.sax.parser' system property or on a string containing the class

 * name.</p>

 *

 * <p>Note that the application still requires an XML parser that

 * implements SAX1.</p>

 *

 * @deprecated This class works with the deprecated

 *             {@link org.xml.sax.Parser Parser}

 *             interface.

 * @since SAX 1.0

 * @author David Megginson

 */

public class ParserFactory {

    /**

     * Private null constructor.

     */

    private ParserFactory ()

    {

    }

    /**

     * Create a new SAX parser using the `org.xml.sax.parser' system property.

     *

     * <p>The named class must exist and must implement the

     * {@link org.xml.sax.Parser Parser} interface.</p>

     *

     * @exception java.lang.NullPointerException There is no value

     *            for the `org.xml.sax.parser' system property.

     * @exception java.lang.ClassNotFoundException The SAX parser

     *            class was not found (check your CLASSPATH).

     * @exception IllegalAccessException The SAX parser class was

     *            found, but you do not have permission to load

     *            it.

     * @exception InstantiationException The SAX parser class was

     *            found but could not be instantiated.

     * @exception java.lang.ClassCastException The SAX parser class

     *            was found and instantiated, but does not implement

     *            org.xml.sax.Parser.

     * @see #makeParser(java.lang.String)

     * @see org.xml.sax.Parser

     */

    public static Parser makeParser ()

        throws ClassNotFoundException,

        IllegalAccessException,

        InstantiationException,

        NullPointerException,

        ClassCastException

    {

        String className = System.getProperty("org.xml.sax.parser");

        if (className == null) {

            throw new NullPointerException("No value for sax.parser property");

        } else {

            return makeParser(className);

        }

    }

    /**

     * Create a new SAX parser object using the class name provided.

     *

     * <p>The named class must exist and must implement the

     * {@link org.xml.sax.Parser Parser} interface.</p>

     *

     * @param className A string containing the name of the

     *                  SAX parser class.

     * @exception java.lang.ClassNotFoundException The SAX parser

     *            class was not found (check your CLASSPATH).

     * @exception IllegalAccessException The SAX parser class was

     *            found, but you do not have permission to load

     *            it.

     * @exception InstantiationException The SAX parser class was

     *            found but could not be instantiated.

     * @exception java.lang.ClassCastException The SAX parser class

     *            was found and instantiated, but does not implement

     *            org.xml.sax.Parser.

     * @see #makeParser()

     * @see org.xml.sax.Parser

     */

    public static Parser makeParser (String className)

        throws ClassNotFoundException,

        IllegalAccessException,

        InstantiationException,

        ClassCastException

    {

        return (Parser) NewInstance.newInstance (

                NewInstance.getClassLoader (), className);

    }

}