/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.sun.org.apache.xerces.internal.impl;

import java.io.IOException;

import com.sun.org.apache.xerces.internal.xni.Augmentations;

import com.sun.org.apache.xerces.internal.xni.XMLResourceIdentifier;

import com.sun.org.apache.xerces.internal.xni.XNIException;

/**

 * The entity handler interface defines methods to report information

 * about the start and end of entities.

 *

 * @xerces.internal

 *

 * @see com.sun.org.apache.xerces.internal.impl.XMLEntityScanner

 *

 * @author Andy Clark, IBM

 *

 */

public interface XMLEntityHandler {

    //

    // XMLEntityHandler methods

    //

    /**

     * This method notifies of the start of an entity. The DTD has the

     * pseudo-name of "[dtd]" parameter entity names start with '%'; and

     * general entities are just specified by their name.

     *

     * @param name     The name of the entity.

     * @param identifier The resource identifier.

     * @param encoding The auto-detected IANA encoding name of the entity

     *                 stream. This value will be null in those situations

     *                 where the entity encoding is not auto-detected (e.g.

     *                 internal entities or a document entity that is

     *                 parsed from a java.io.Reader).

     * @param augs     Additional information that may include infoset augmentations

     *

     * @throws XNIException Thrown by handler to signal an error.

     */

    public void startEntity(String name,

                            XMLResourceIdentifier identifier,

                            String encoding, Augmentations augs) throws XNIException;

    /**

     * This method notifies the end of an entity. The DTD has the pseudo-name

     * of "[dtd]" parameter entity names start with '%'; and general entities

     * are just specified by their name.

     *

     * @param name The name of the entity.

     * @param augs Additional information that may include infoset augmentations

     *

     * @throws IOException This exception might be thrown when there is premature end of entity

     * @throws XNIException Thrown by handler to signal an error.

     */

    public void endEntity(String name, Augmentations augs) throws IOException, XNIException;

} // interface XMLEntityHandler