org.opengis.cite.xerces.xni.XMLDocumentFragmentHandler Maven / Gradle / Ivy
Show all versions of xercesImpl-xsd11-shaded Show documentation
/*
* 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 org.apache.xerces.xni;
/**
* This handler interface contains methods necessary to receive
* information about document elements and content.
*
* Note: Some of these methods overlap methods
* found in the XMLDocumentHandler interface.
*
* @see XMLDocumentHandler
*
* @author Andy Clark, IBM
* @version $Id: XMLDocumentFragmentHandler.java 447247 2006-09-18 05:23:52Z mrglavas $
*/
public interface XMLDocumentFragmentHandler {
//
// XMLDocumentFragmentHandler methods
//
/**
* The start of the document fragment.
*
* @param locator The document locator, or null if the
* document location cannot be reported
* during the parsing of this fragment.
* However, it is strongly
* recommended that a locator be supplied
* that can at least report the base
* system identifier.
* @param namespaceContext The namespace context in effect at the
* start of this document fragment. This
* object only represents the current context.
* Implementors of this class are responsible
* for copying the namespace bindings from the
* the current context (and its parent contexts)
* if that information is important.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void startDocumentFragment(XMLLocator locator,
NamespaceContext namespaceContext,
Augmentations augmentations)
throws XNIException;
/**
* This method notifies the start of a general entity.
*
* Note: This method is not called for entity references
* appearing as part of attribute values.
*
* @param name The name of the general 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 augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
Augmentations augmentations) throws XNIException;
/**
* Notifies of the presence of a TextDecl line in an entity. If present,
* this method will be called immediately following the startEntity call.
*
* Note: This method will never be called for the
* document entity; it is only called for external general entities
* referenced in document content.
*
* Note: This method is not called for entity references
* appearing as part of attribute values.
*
* @param version The XML version, or null if not specified.
* @param encoding The IANA encoding name of the entity.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void textDecl(String version, String encoding,
Augmentations augmentations) throws XNIException;
/**
* This method notifies the end of a general entity.
*
* Note: This method is not called for entity references
* appearing as part of attribute values.
*
* @param name The name of the general entity.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void endGeneralEntity(String name, Augmentations augmentations)
throws XNIException;
/**
* A comment.
*
* @param text The text in the comment.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by application to signal an error.
*/
public void comment(XMLString text, Augmentations augmentations)
throws XNIException;
/**
* A processing instruction. Processing instructions consist of a
* target name and, optionally, text data. The data is only meaningful
* to the application.
*
* Typically, a processing instruction's data will contain a series
* of pseudo-attributes. These pseudo-attributes follow the form of
* element attributes but are not parsed or presented
* to the application as anything other than text. The application is
* responsible for parsing the data.
*
* @param target The target.
* @param data The data or null if none specified.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void processingInstruction(String target, XMLString data,
Augmentations augmentations)
throws XNIException;
/**
* The start of an element.
*
* @param element The name of the element.
* @param attributes The element attributes.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void startElement(QName element, XMLAttributes attributes,
Augmentations augmentations) throws XNIException;
/**
* An empty element.
*
* @param element The name of the element.
* @param attributes The element attributes.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void emptyElement(QName element, XMLAttributes attributes,
Augmentations augmentations) throws XNIException;
/**
* Character content.
*
* @param text The content.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void characters(XMLString text, Augmentations augmentations)
throws XNIException;
/**
* Ignorable whitespace. For this method to be called, the document
* source must have some way of determining that the text containing
* only whitespace characters should be considered ignorable. For
* example, the validator can determine if a length of whitespace
* characters in the document are ignorable based on the element
* content model.
*
* @param text The ignorable whitespace.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void ignorableWhitespace(XMLString text,
Augmentations augmentations)
throws XNIException;
/**
* The end of an element.
*
* @param element The name of the element.
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void endElement(QName element, Augmentations augmentations)
throws XNIException;
/**
* The start of a CDATA section.
*
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void startCDATA(Augmentations augmentations) throws XNIException;
/**
* The end of a CDATA section.
*
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void endCDATA(Augmentations augmentations) throws XNIException;
/**
* The end of the document fragment.
*
* @param augmentations Additional information that may include infoset
* augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
public void endDocumentFragment(Augmentations augmentations)
throws XNIException;
} // interface XMLDocumentFragmentHandler