Top Fields Constructors Methods
com.sun.org.apache.xerces.internal.util

public Class TeeXMLDocumentFilterImpl

extends Object
implements XMLDocumentFilter
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentFilter, com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource, com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler
Imports
com.sun.org.apache.xerces.internal.xni.Augmentations, .NamespaceContext, .QName, .XMLAttributes, .XMLDocumentHandler, .XMLLocator, .XMLResourceIdentifier, .XMLString, .XNIException, com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentFilter, .XMLDocumentSource

Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
private XMLDocumentHandler
next

The next component in the pipeline who receives the event.

private XMLDocumentHandler
side

The component who intercepts events.

private XMLDocumentSource
source

The source of the event.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
characters(XMLString
The content.
text
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.characters.

Character content.

public void
comment(XMLString
The text in the comment.
text
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.comment.

A comment.

public void
doctypeDecl(String
The name of the root element.
rootElement
,
String
The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
publicId
,
String
The system identifier if an external DTD, null otherwise.
systemId
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.doctypeDecl.

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

public void
emptyElement(QName
The name of the element.
element
,
XMLAttributes
The element attributes.
attributes
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.emptyElement.

An empty element.

public void
endCDATA(Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endCDATA.

The end of a CDATA section.

public void
endDocument(Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endDocument.

The end of the document.

public void
endElement(QName
The name of the element.
element
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endElement.

The end of an element.

public void
endGeneralEntity(String
The name of the entity.
name
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endGeneralEntity.

This method notifies the end of a general entity.

public XMLDocumentHandler
public XMLDocumentSource
public XMLDocumentHandler
public void
ignorableWhitespace(XMLString
The ignorable whitespace.
text
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.ignorableWhitespace.

Ignorable whitespace.

public void
processingInstruction(String
The target.
target
,
XMLString
The data or null if none specified.
data
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.processingInstruction.

A processing instruction.

public void
public void
public void
public void
startCDATA(Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startCDATA.

The start of a CDATA section.

public void
startDocument(XMLLocator
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.
locator
,
String
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).
encoding
,
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.
namespaceContext
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startDocument.

The start of the document.

public void
startElement(QName
The name of the element.
element
,
XMLAttributes
The element attributes.
attributes
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startElement.

The start of an element.

public void
startGeneralEntity(String
The name of the general entity.
name
,
XMLResourceIdentifier
The resource identifier.
identifier
,
String
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).
encoding
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startGeneralEntity.

This method notifies the start of a general entity.

public void
textDecl(String
The XML version, or null if not specified.
version
,
String
The IANA encoding name of the entity.
encoding
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.textDecl.

Notifies of the presence of a TextDecl line in an entity.

public void
xmlDecl(String
The XML version.
version
,
String
The IANA encoding name of the document, or null if not specified.
encoding
,
String
The standalone value, or null if not specified.
standalone
,
Augmentations
Additional information that may include infoset augmentations
augs
)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.xmlDecl.

Notifies of the presence of an XMLDecl line in the document.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nextback to summary
private XMLDocumentHandler next

The next component in the pipeline who receives the event. This component receives events after the "side" handler receives them.

sideback to summary
private XMLDocumentHandler side

The component who intercepts events.

sourceback to summary
private XMLDocumentSource source

The source of the event.

Constructor Detail

TeeXMLDocumentFilterImplback to summary
public TeeXMLDocumentFilterImpl()

Method Detail

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

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.characters.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.characters.

Character content.

Parameters
text:XMLString

The content.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
commentback to summary
public void comment(XMLString text, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.comment.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.comment.

A comment.

Parameters
text:XMLString

The text in the comment.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by application to signal an error.
doctypeDeclback to summary
public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.doctypeDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.doctypeDecl.

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

Parameters
rootElement:String

The name of the root element.

publicId:String

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

systemId:String

The system identifier if an external DTD, null otherwise.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
emptyElementback to summary
public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.emptyElement.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.emptyElement.

An empty element.

Parameters
element:QName

The name of the element.

attributes:XMLAttributes

The element attributes.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
endCDATAback to summary
public void endCDATA(Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endCDATA.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endCDATA.

The end of a CDATA section.

Parameters
augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
endDocumentback to summary
public void endDocument(Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endDocument.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endDocument.

The end of the document.

Parameters
augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
endElementback to summary
public void endElement(QName element, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endElement.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endElement.

The end of an element.

Parameters
element:QName

The name of the element.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
endGeneralEntityback to summary
public void endGeneralEntity(String name, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endGeneralEntity.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.endGeneralEntity.

This method notifies the end of a general entity.

Note

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

Parameters
name:String

The name of the entity.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
getDocumentHandlerback to summary
public XMLDocumentHandler getDocumentHandler()

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource.getDocumentHandler.

Doc from com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource.getDocumentHandler.

Returns the document handler

getDocumentSourceback to summary
public XMLDocumentSource getDocumentSource()

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.getDocumentSource.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.getDocumentSource.

Returns the document source.

getSideback to summary
public XMLDocumentHandler getSide()
ignorableWhitespaceback to summary
public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.ignorableWhitespace.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.ignorableWhitespace.

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.

Parameters
text:XMLString

The ignorable whitespace.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
processingInstructionback to summary
public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.processingInstruction.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.processingInstruction.

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.

Parameters
target:String

The target.

data:XMLString

The data or null if none specified.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
setDocumentHandlerback to summary
public void setDocumentHandler(XMLDocumentHandler handler)

Implements com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource.setDocumentHandler.

Doc from com.sun.org.apache.xerces.internal.xni.parser.XMLDocumentSource.setDocumentHandler.

Sets the document handler.

setDocumentSourceback to summary
public void setDocumentSource(XMLDocumentSource source)

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.setDocumentSource.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.setDocumentSource.

Sets the document source.

setSideback to summary
public void setSide(XMLDocumentHandler side)
startCDATAback to summary
public void startCDATA(Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startCDATA.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startCDATA.

The start of a CDATA section.

Parameters
augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
startDocumentback to summary
public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startDocument.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startDocument.

The start of the document.

Parameters
locator:XMLLocator

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:String

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: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:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
startElementback to summary
public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startElement.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startElement.

The start of an element.

Parameters
element:QName

The name of the element.

attributes:XMLAttributes

The element attributes.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
startGeneralEntityback to summary
public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startGeneralEntity.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.startGeneralEntity.

This method notifies the start of a general entity.

Note

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

Parameters
name:String

The name of the general entity.

identifier:XMLResourceIdentifier

The resource identifier.

encoding:String

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:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
textDeclback to summary
public void textDecl(String version, String encoding, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.textDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.textDecl.

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.

Parameters
version:String

The XML version, or null if not specified.

encoding:String

The IANA encoding name of the entity.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.
xmlDeclback to summary
public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException

Implements com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.xmlDecl.

Doc from com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler.xmlDecl.

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

Parameters
version:String

The XML version.

encoding:String

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

standalone:String

The standalone value, or null if not specified.

augs:Augmentations

Additional information that may include infoset augmentations

Exceptions
XNIException:
Thrown by handler to signal an error.