jdk7u.jaxp.org.apache.xerces.external.util

Class TeeXMLDocumentFilterImpl

java.lang.Object

jdk7u.jaxp.org.apache.xerces.external.util.TeeXMLDocumentFilterImpl

All Implemented Interfaces:

XMLDocumentFilter, XMLDocumentSource, XMLDocumentHandler

public class TeeXMLDocumentFilterImpl
extends Object
implements XMLDocumentFilter

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Constructor Summary

Constructors

Constructor and Description
TeeXMLDocumentFilterImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(XMLString text, Augmentations augs) Character content.
void	comment(XMLString text, Augmentations augs) A comment.
void	doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) Notifies of the presence of the DOCTYPE line in the document.
void	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) An empty element.
void	endCDATA(Augmentations augs) The end of a CDATA section.
void	endDocument(Augmentations augs) The end of the document.
void	endElement(QName element, Augmentations augs) The end of an element.
void	endGeneralEntity(String name, Augmentations augs) This method notifies the end of a general entity.
XMLDocumentHandler	getDocumentHandler() Returns the document handler
XMLDocumentSource	getDocumentSource() Returns the document source.
XMLDocumentHandler	getSide()
void	ignorableWhitespace(XMLString text, Augmentations augs) Ignorable whitespace.
void	processingInstruction(String target, XMLString data, Augmentations augs) A processing instruction.
void	setDocumentHandler(XMLDocumentHandler handler) Sets the document handler.
void	setDocumentSource(XMLDocumentSource source) Sets the document source.
void	setSide(XMLDocumentHandler side)
void	startCDATA(Augmentations augs) The start of a CDATA section.
void	startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) The start of the document.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs) The start of an element.
void	startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) This method notifies the start of a general entity.
void	textDecl(String version, String encoding, Augmentations augs) Notifies of the presence of a TextDecl line in an entity.
void	xmlDecl(String version, String encoding, String standalone, Augmentations augs) Notifies of the presence of an XMLDecl line in the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TeeXMLDocumentFilterImpl

public TeeXMLDocumentFilterImpl()

Method Detail

getSide

public XMLDocumentHandler getSide()

setSide

public void setSide(XMLDocumentHandler side)

getDocumentSource

public XMLDocumentSource getDocumentSource()

Description copied from interface: XMLDocumentHandler

Returns the document source.

Specified by:

getDocumentSource in interface XMLDocumentHandler

setDocumentSource

public void setDocumentSource(XMLDocumentSource source)

Description copied from interface: XMLDocumentHandler

Sets the document source.

Specified by:

setDocumentSource in interface XMLDocumentHandler

getDocumentHandler

public XMLDocumentHandler getDocumentHandler()

Description copied from interface: XMLDocumentSource

Returns the document handler

Specified by:

getDocumentHandler in interface XMLDocumentSource

setDocumentHandler

public void setDocumentHandler(XMLDocumentHandler handler)

Description copied from interface: XMLDocumentSource

Sets the document handler.

Specified by:

setDocumentHandler in interface XMLDocumentSource

characters

public void characters(XMLString text,
              Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

Character content.

Specified by:

characters in interface XMLDocumentHandler

Parameters:

text - The content.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

comment

public void comment(XMLString text,
           Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

A comment.

Specified by:

comment in interface XMLDocumentHandler

Parameters:

text - The text in the comment.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by application to signal an error.

doctypeDecl

public void doctypeDecl(String rootElement,
               String publicId,
               String systemId,
               Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

Notifies of the presence of the DOCTYPE line in the document.

Specified by:

doctypeDecl in interface XMLDocumentHandler

Parameters:

rootElement - The name of the root element.

publicId - The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.

systemId - The system identifier if an external DTD, null otherwise.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

emptyElement

public void emptyElement(QName element,
                XMLAttributes attributes,
                Augmentations augs)
                  throws XNIException

Description copied from interface: XMLDocumentHandler

An empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

attributes - The element attributes.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(Augmentations augs)
              throws XNIException

Description copied from interface: XMLDocumentHandler

The end of a CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
                 throws XNIException

Description copied from interface: XMLDocumentHandler

The end of the document.

Specified by:

endDocument in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endElement

public void endElement(QName element,
              Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

The end of an element.

Specified by:

endElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endGeneralEntity

public void endGeneralEntity(String name,
                    Augmentations augs)
                      throws XNIException

Description copied from interface: XMLDocumentHandler

This method notifies the end of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.

Specified by:

endGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(XMLString text,
                       Augmentations augs)
                         throws XNIException

Description copied from interface: XMLDocumentHandler

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.

Specified by:

ignorableWhitespace in interface XMLDocumentHandler

Parameters:

text - The ignorable whitespace.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

processingInstruction

public void processingInstruction(String target,
                         XMLString data,
                         Augmentations augs)
                           throws XNIException

Description copied from interface: XMLDocumentHandler

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.

Specified by:

processingInstruction in interface XMLDocumentHandler

Parameters:

target - The target.

data - The data or null if none specified.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA(Augmentations augs)
                throws XNIException

Description copied from interface: XMLDocumentHandler

The start of a CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startDocument

public void startDocument(XMLLocator locator,
                 String encoding,
                 NamespaceContext namespaceContext,
                 Augmentations augs)
                   throws XNIException

Description copied from interface: XMLDocumentHandler

The start of the document.

Specified by:

startDocument in interface XMLDocumentHandler

Parameters:

locator - The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.

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).

namespaceContext - The namespace context in effect at the start of this document. This object 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.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startElement

public void startElement(QName element,
                XMLAttributes attributes,
                Augmentations augs)
                  throws XNIException

Description copied from interface: XMLDocumentHandler

The start of an element.

Specified by:

startElement in interface XMLDocumentHandler

Parameters:

element - The name of the element.

attributes - The element attributes.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startGeneralEntity

public void startGeneralEntity(String name,
                      XMLResourceIdentifier identifier,
                      String encoding,
                      Augmentations augs)
                        throws XNIException

Description copied from interface: XMLDocumentHandler

This method notifies the start of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.

Specified by:

startGeneralEntity in interface XMLDocumentHandler

Parameters:

name - The name of the general entity.

identifier - The resource identifier.

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).

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

textDecl

public void textDecl(String version,
            String encoding,
            Augmentations augs)
              throws XNIException

Description copied from interface: XMLDocumentHandler

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.

Specified by:

textDecl in interface XMLDocumentHandler

Parameters:

version - The XML version, or null if not specified.

encoding - The IANA encoding name of the entity.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(String version,
           String encoding,
           String standalone,
           Augmentations augs)
             throws XNIException

Description copied from interface: XMLDocumentHandler

Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.

Specified by:

xmlDecl in interface XMLDocumentHandler

Parameters:

version - The XML version.

encoding - The IANA encoding name of the document, or null if not specified.

standalone - The standalone value, or null if not specified.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.