/*

 * Copyright (c) 2004, 2019, Oracle and/or its affiliates. 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.  Oracle designates this

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

 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package org.xml.sax.ext;

import java.io.IOException;

import org.xml.sax.InputSource;

import org.xml.sax.SAXException;

import org.xml.sax.helpers.DefaultHandler;

/**

 * This class extends the SAX2 base handler class to support the

 * SAX2 {@link LexicalHandler}, {@link DeclHandler}, and

 * {@link EntityResolver2} extensions.  Except for overriding the

 * original SAX1 {@link DefaultHandler#resolveEntity resolveEntity()}

 * method the added handler methods just return.  Subclassers may

 * override everything on a method-by-method basis.

 *

 * <p> <em>Note:</em> this class might yet learn that the

 * <em>ContentHandler.setDocumentLocator()</em> call might be passed a

 * {@link Locator2} object, and that the

 * <em>ContentHandler.startElement()</em> call might be passed a

 * {@link Attributes2} object.

 *

 * @since 1.5, SAX 2.0 (extensions 1.1 alpha)

 * @author David Brownell

 */

public class DefaultHandler2 extends DefaultHandler

    implements LexicalHandler, DeclHandler, EntityResolver2

{

    /** Constructs a handler which ignores all parsing events. */

    public DefaultHandler2 () { }

    // SAX2 ext-1.0 LexicalHandler

    public void startCDATA ()

    throws SAXException

        {}

    public void endCDATA ()

    throws SAXException

        {}

    public void startDTD (String name, String publicId, String systemId)

    throws SAXException

        {}

    public void endDTD ()

    throws SAXException

        {}

    public void startEntity (String name)

    throws SAXException

        {}

    public void endEntity (String name)

    throws SAXException

        {}

    public void comment (char ch [], int start, int length)

    throws SAXException

        { }

    // SAX2 ext-1.0 DeclHandler

    public void attributeDecl (String eName, String aName,

            String type, String mode, String value)

    throws SAXException

        {}

    public void elementDecl (String name, String model)

    throws SAXException

        {}

    public void externalEntityDecl (String name,

        String publicId, String systemId)

    throws SAXException

        {}

    public void internalEntityDecl (String name, String value)

    throws SAXException

        {}

    // SAX2 ext-1.1 EntityResolver2

    /**

     * Tells the parser that if no external subset has been declared

     * in the document text, none should be used.

     */

    public InputSource getExternalSubset (String name, String baseURI)

    throws SAXException, IOException

        { return null; }

    /**

     * Tells the parser to resolve the systemId against the baseURI

     * and read the entity text from that resulting absolute URI.

     * Note that because the older

     * {@link DefaultHandler#resolveEntity DefaultHandler.resolveEntity()},

     * method is overridden to call this one, this method may sometimes

     * be invoked with null <em>name</em> and <em>baseURI</em>, and

     * with the <em>systemId</em> already absolutized.

     */

    public InputSource resolveEntity (String name, String publicId,

            String baseURI, String systemId)

    throws SAXException, IOException

        { return null; }

    // SAX1 EntityResolver

    /**

     * Invokes

     * {@link EntityResolver2#resolveEntity EntityResolver2.resolveEntity()}

     * with null entity name and base URI.

     * You only need to override that method to use this class.

     */

    public InputSource resolveEntity (String publicId, String systemId)

    throws SAXException, IOException

        { return resolveEntity (null, publicId, null, systemId); }

}