286N/A/*
286N/A * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved.
286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
286N/A *
286N/A * This code is free software; you can redistribute it and/or modify it
286N/A * under the terms of the GNU General Public License version 2 only, as
286N/A * published by the Free Software Foundation. Oracle designates this
286N/A * particular file as subject to the "Classpath" exception as provided
286N/A * by Oracle in the LICENSE file that accompanied this code.
286N/A *
286N/A * This code is distributed in the hope that it will be useful, but WITHOUT
286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
286N/A * version 2 for more details (a copy is included in the LICENSE file that
286N/A * accompanied this code).
286N/A *
286N/A * You should have received a copy of the GNU General Public License version
286N/A * 2 along with this work; if not, write to the Free Software Foundation,
286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
286N/A *
286N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
286N/A * or visit www.oracle.com if you need additional information or have any
286N/A * questions.
286N/A */
286N/A
286N/A// SAX DTD handler.
286N/A// http://www.saxproject.org
286N/A// No warranty; no copyright -- use this as you will.
286N/A// $Id: DTDHandler.java,v 1.2 2004/11/03 22:44:51 jsuttor Exp $
286N/A
286N/Apackage org.xml.sax;
286N/A
286N/A/**
286N/A * Receive notification of basic DTD-related events.
286N/A *
286N/A * <blockquote>
286N/A * <em>This module, both source code and documentation, is in the
286N/A * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
286N/A * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
286N/A * for further information.
286N/A * </blockquote>
286N/A *
286N/A * <p>If a SAX application needs information about notations and
286N/A * unparsed entities, then the application implements this
286N/A * interface and registers an instance with the SAX parser using
286N/A * the parser's setDTDHandler method. The parser uses the
286N/A * instance to report notation and unparsed entity declarations to
286N/A * the application.</p>
286N/A *
286N/A * <p>Note that this interface includes only those DTD events that
286N/A * the XML recommendation <em>requires</em> processors to report:
286N/A * notation and unparsed entity declarations.</p>
286N/A *
286N/A * <p>The SAX parser may report these events in any order, regardless
286N/A * of the order in which the notations and unparsed entities were
286N/A * declared; however, all DTD events must be reported after the
286N/A * document handler's startDocument event, and before the first
286N/A * startElement event.
286N/A * (If the {@link org.xml.sax.ext.LexicalHandler LexicalHandler} is
286N/A * used, these events must also be reported before the endDTD event.)
286N/A * </p>
286N/A *
286N/A * <p>It is up to the application to store the information for
286N/A * future use (perhaps in a hash table or object tree).
286N/A * If the application encounters attributes of type "NOTATION",
286N/A * "ENTITY", or "ENTITIES", it can use the information that it
286N/A * obtained through this interface to find the entity and/or
286N/A * notation corresponding with the attribute value.</p>
286N/A *
286N/A * @since SAX 1.0
286N/A * @author David Megginson
286N/A * @see org.xml.sax.XMLReader#setDTDHandler
286N/A */
286N/Apublic interface DTDHandler {
286N/A
286N/A
286N/A /**
286N/A * Receive notification of a notation declaration event.
286N/A *
286N/A * <p>It is up to the application to record the notation for later
286N/A * reference, if necessary;
286N/A * notations may appear as attribute values and in unparsed entity
286N/A * declarations, and are sometime used with processing instruction
286N/A * target names.</p>
286N/A *
286N/A * <p>At least one of publicId and systemId must be non-null.
286N/A * If a system identifier is present, and it is a URL, the SAX
286N/A * parser must resolve it fully before passing it to the
286N/A * application through this event.</p>
286N/A *
286N/A * <p>There is no guarantee that the notation declaration will be
286N/A * reported before any unparsed entities that use it.</p>
286N/A *
286N/A * @param name The notation name.
286N/A * @param publicId The notation's public identifier, or null if
286N/A * none was given.
286N/A * @param systemId The notation's system identifier, or null if
286N/A * none was given.
286N/A * @exception org.xml.sax.SAXException Any SAX exception, possibly
286N/A * wrapping another exception.
286N/A * @see #unparsedEntityDecl
286N/A * @see org.xml.sax.Attributes
286N/A */
286N/A public abstract void notationDecl (String name,
286N/A String publicId,
286N/A String systemId)
286N/A throws SAXException;
286N/A
286N/A
286N/A /**
286N/A * Receive notification of an unparsed entity declaration event.
286N/A *
286N/A * <p>Note that the notation name corresponds to a notation
286N/A * reported by the {@link #notationDecl notationDecl} event.
286N/A * It is up to the application to record the entity for later
286N/A * reference, if necessary;
286N/A * unparsed entities may appear as attribute values.
286N/A * </p>
286N/A *
286N/A * <p>If the system identifier is a URL, the parser must resolve it
286N/A * fully before passing it to the application.</p>
286N/A *
286N/A * @exception org.xml.sax.SAXException Any SAX exception, possibly
286N/A * wrapping another exception.
286N/A * @param name The unparsed entity's name.
286N/A * @param publicId The entity's public identifier, or null if none
286N/A * was given.
286N/A * @param systemId The entity's system identifier.
286N/A * @param notationName The name of the associated notation.
286N/A * @see #notationDecl
286N/A * @see org.xml.sax.Attributes
286N/A */
286N/A public abstract void unparsedEntityDecl (String name,
286N/A String publicId,
286N/A String systemId,
286N/A String notationName)
286N/A throws SAXException;
286N/A
286N/A}
286N/A
286N/A// end of DTDHandler.java