Class ToTextStream
- All Implemented Interfaces:
DOMSerializer
,ExtendedContentHandler
,ExtendedLexicalHandler
,SerializationHandler
,Serializer
,ContentHandler
,DTDHandler
,ErrorHandler
,DeclHandler
,LexicalHandler
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >static final String
The constant "]]>"static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Define the XML version.Fields inherited from class org.apache.xml.serializer.SerializerBase
PKG_NAME, PKG_PATH
Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler
HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(String name, String value) From XSLTCvoid
addAttribute
(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute) Adds the given attribute to the set of collected attributes , but only if there is a currently open element.void
addUniqueAttribute
(String qName, String value, int flags) Add a unique attributevoid
cdata
(char[] ch, int start, int length) Receive notification of cdata.void
characters
(char[] ch, int start, int length) Receive notification of character data.void
characters
(String characters) From XSLTCvoid
charactersRaw
(char[] ch, int start, int length) If available, when the disable-output-escaping attribute is used, output raw text without escaping.void
comment
(char[] ch, int start, int length) Report an XML comment anywhere in the document.void
Called when a Comment is to be constructed.void
endCDATA()
Report the end of a CDATA section.void
Receive notification of the end of a document.void
endElement
(String elemName) Receive notification of the end of an element.void
endElement
(String namespaceURI, String localName, String name) Receive notification of the end of an element.void
entityReference
(String name) Receive notivication of a entityReference.void
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.void
ignorableWhitespace
(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.void
namespaceAfterStartElement
(String prefix, String uri) This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement().void
processingInstruction
(String target, String data) Receive notification of a processing instruction.void
startElement
(String elementNamespaceURI, String elementLocalName, String elementName) From XSLTCvoid
startElement
(String namespaceURI, String localName, String name, Attributes atts) Receive notification of the beginning of an element.void
startPrefixMapping
(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping just before another element is about to start.boolean
startPrefixMapping
(String prefix, String uri, boolean shouldFlush) Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow.Methods inherited from class org.apache.xml.serializer.ToStream
addAttributeAlways, addCdataSectionElements, attributeDecl, elementDecl, endDTD, endNonEscaping, endPrefixMapping, externalEntityDecl, getIndentAmount, getOutputFormat, getOutputStream, getWriter, internalEntityDecl, notationDecl, processAttributes, reset, serialize, setCdataSectionElements, setContentHandler, setDTDEntityExpansion, setEncoding, setEscaping, setIndentAmount, setLineSepUse, setNewLine, setOutputFormat, setOutputStream, setTransformer, setWriter, skippedEntity, startCDATA, startDTD, startElement, startEntity, startNonEscaping, unparsedEntityDecl, writeAttrString
Methods inherited from class org.apache.xml.serializer.SerializerBase
addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, characters, close, documentIsEmpty, endEntity, error, fatalError, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getStandalone, getTransformer, getVersion, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setVersion, startDocument, warning
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.xml.sax.ContentHandler
declaration
-
Field Details
-
CDATA_CONTINUE
To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >- See Also:
-
CDATA_DELIMITER_CLOSE
The constant "]]>"- See Also:
-
CDATA_DELIMITER_OPEN
- See Also:
-
EMPTYSTRING
- See Also:
-
ENTITY_AMP
- See Also:
-
ENTITY_CRLF
- See Also:
-
ENTITY_GT
- See Also:
-
ENTITY_LT
- See Also:
-
ENTITY_QUOT
- See Also:
-
XML_PREFIX
- See Also:
-
XMLNS_PREFIX
- See Also:
-
XMLNS_URI
- See Also:
-
DEFAULT_SAX_SERIALIZER
-
XMLVERSION11
Define the XML version.- See Also:
-
XMLVERSION10
- See Also:
-
-
Constructor Details
-
ToTextStream
public ToTextStream()Default constructor.
-
-
Method Details
-
endDocument
Receive notification of the end of a document.The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
startElement
public void startElement(String namespaceURI, String localName, String name, Attributes atts) throws SAXException Receive notification of the beginning of an element.The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.
If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.
- Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classToStream
- Parameters:
namespaceURI
- The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.name
- The qualified name (with prefix), or the empty string if qualified names are not available.atts
- The attributes attached to the element, if any.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
- See Also:
-
endElement
Receive notification of the end of an element.The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).
If the element name has a namespace prefix, the prefix will still be attached to the name.
- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classToStream
- Parameters:
namespaceURI
- The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.name
- The qualified name (with prefix), or the empty string if qualified names are not available.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
characters
Receive notification of character data.The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classToStream
- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
charactersRaw
If available, when the disable-output-escaping attribute is used, output raw text without escaping.- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.
-
cdata
Receive notification of cdata.The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).
- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
ignorableWhitespace
Receive notification of ignorable whitespace in element content.Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.
The application must not attempt to read from the array outside of the specified range.
- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Overrides:
ignorableWhitespace
in classToStream
- Parameters:
ch
- The characters from the XML document.start
- The start position in the array.length
- The number of characters to read from the array.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
- See Also:
-
processingInstruction
Receive notification of a processing instruction.The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.
- Parameters:
target
- The processing instruction target.data
- The processing instruction data, or null if none was supplied.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
comment
Called when a Comment is to be constructed. Note that Xalan will normally invoke the other version of this method. %REVIEW% In fact, is this one ever needed, or was it a mistake?- Specified by:
comment
in interfaceExtendedLexicalHandler
- Overrides:
comment
in classSerializerBase
- Parameters:
data
- The comment data.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
comment
Report an XML comment anywhere in the document. This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).- Specified by:
comment
in interfaceLexicalHandler
- Overrides:
comment
in classToStream
- Parameters:
ch
- An array holding the characters in the comment.start
- The starting position in the array.length
- The number of characters to use from the array.- Throws:
SAXException
- The application may raise an exception.
-
entityReference
Receive notivication of a entityReference.- Specified by:
entityReference
in interfaceExtendedContentHandler
- Overrides:
entityReference
in classSerializerBase
- Parameters:
name
- non-null reference to the name of the entity.- Throws:
SAXException
-
addAttribute
public void addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute) Description copied from class:SerializerBase
Adds the given attribute to the set of collected attributes , but only if there is a currently open element. An element is currently open if a startElement() notification has occured but the start of the element has not yet been written to the output. In the stream case this means that we have not yet been forced to close the elements opening tag by another notification, such as a character notification.- Specified by:
addAttribute
in interfaceExtendedContentHandler
- Overrides:
addAttribute
in classSerializerBase
- Parameters:
uri
- the URI of the attributelocalName
- the local name of the attributerawName
- the qualified name of the attributetype
- the type of the attribute (probably CDATA)value
- the value of the attributeXSLAttribute
- true if this attribute is coming from an xsl:attriute element- See Also:
-
endCDATA
Description copied from class:ToStream
Report the end of a CDATA section.- Specified by:
endCDATA
in interfaceLexicalHandler
- Overrides:
endCDATA
in classToStream
- Throws:
SAXException
- The application may raise an exception.- See Also:
-
endElement
Description copied from class:ToStream
Receive notification of the end of an element.- Specified by:
endElement
in interfaceExtendedContentHandler
- Overrides:
endElement
in classToStream
- Parameters:
elemName
- The element type name- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
startElement
public void startElement(String elementNamespaceURI, String elementLocalName, String elementName) throws SAXException From XSLTC- Specified by:
startElement
in interfaceExtendedContentHandler
- Overrides:
startElement
in classToStream
- Parameters:
elementNamespaceURI
- The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.elementLocalName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.elementName
- The element type name.- Throws:
SAXException
- See Also:
-
characters
From XSLTC- Specified by:
characters
in interfaceExtendedContentHandler
- Overrides:
characters
in classToStream
- Parameters:
characters
- The string of characters to process.- Throws:
SAXException
-
addAttribute
From XSLTC- Specified by:
addAttribute
in interfaceExtendedContentHandler
- Overrides:
addAttribute
in classSerializerBase
- Parameters:
name
- the attribute's qualified namevalue
- the value of the attribute
-
addUniqueAttribute
Add a unique attribute- Parameters:
qName
- the fully qualified attribute name.value
- the attribute valueflags
- a bitwise flag- Throws:
SAXException
-
startPrefixMapping
public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush) throws SAXException Description copied from class:ToStream
Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow. Need to close any open start tag to make sure than any name space attributes due to this event are associated wih the up comming element, not the current one.- Specified by:
startPrefixMapping
in interfaceExtendedContentHandler
- Overrides:
startPrefixMapping
in classToStream
- Parameters:
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.shouldFlush
- true if any open tags need to be closed first, this will impact which element the mapping applies to (open parent, or its up comming child)- Returns:
- returns true if the call made a change to the current namespace information, false if it did not change anything, e.g. if the prefix/namespace mapping was already in scope from before.
- Throws:
SAXException
- The client may throw an exception during processing.- See Also:
-
startPrefixMapping
Description copied from class:ToStream
Begin the scope of a prefix-URI Namespace mapping just before another element is about to start. This call will close any open tags so that the prefix mapping will not apply to the current element, but the up comming child.- Specified by:
startPrefixMapping
in interfaceContentHandler
- Overrides:
startPrefixMapping
in classToStream
- Parameters:
prefix
- The Namespace prefix being declared.uri
- The Namespace URI the prefix is mapped to.- Throws:
SAXException
- The client may throw an exception during processing.- See Also:
-
namespaceAfterStartElement
Description copied from class:SerializerBase
This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement(). startPrefixMapping(prefix,uri) would be used before the startElement() call.- Specified by:
namespaceAfterStartElement
in interfaceExtendedContentHandler
- Overrides:
namespaceAfterStartElement
in classSerializerBase
- Parameters:
prefix
- the URI of the namespaceuri
- the prefix associated with the given URI.- Throws:
SAXException
- See Also:
-
flushPending
Description copied from class:ToStream
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.- Specified by:
flushPending
in interfaceSerializationHandler
- Overrides:
flushPending
in classToStream
- Throws:
SAXException
-