Class ToStream
- All Implemented Interfaces:
DOMSerializer
,ExtendedContentHandler
,ExtendedLexicalHandler
,SerializationHandler
,Serializer
,ContentHandler
,DTDHandler
,ErrorHandler
,DeclHandler
,LexicalHandler
- Direct Known Subclasses:
ToHTMLStream
,ToTextStream
,ToXMLStream
-
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 TypeMethodDescriptionboolean
addAttributeAlways
(String uri, String localName, String rawName, String type, String value, boolean xslAttribute) Adds the given attribute to the set of attributes, even if there is no currently open element.void
addCdataSectionElements
(String URI_and_localNames) Remembers the cdata sections specified in the cdata-section-elements by appending the given cdata section elements to the list.void
Report an attribute type declaration.void
characters
(char[] chars, int start, int length) Receive notification of character data.void
characters
(String s) Receive notification of character data.void
comment
(char[] ch, int start, int length) Receive notification of an XML comment anywhere in the document.void
elementDecl
(String name, String model) Report an element type declaration.void
endCDATA()
Report the end of a CDATA section.void
endDTD()
Report the end of DTD declarations.void
endElement
(String name) 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
Ends an un-escaping section.void
endPrefixMapping
(String prefix) End the scope of a prefix-URI Namespace mapping.void
externalEntityDecl
(String name, String publicId, String systemId) Report a parsed external entity declaration.void
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.int
Returns the m_indentAmount.Returns the output format for this serializer.Get the output stream where the events will be serialized to.Get the character stream where the events will be serialized to.void
ignorableWhitespace
(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.void
internalEntityDecl
(String name, String value) Report an internal entity declaration.void
notationDecl
(String name, String pubID, String sysID) If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.void
processAttributes
(Writer writer, int nAttrs) Process the attributes, which means to write out the currently collected attributes to the writer.boolean
reset()
Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).void
Serializes the DOM node.void
setCdataSectionElements
(Vector URI_and_localNames) Remembers the cdata sections specified in the cdata-section-elements.void
Set the SAX Content handler that the serializer sends its output to.void
setDTDEntityExpansion
(boolean expand) If set to false the serializer does not expand DTD entities, but leaves them as is, the default value is true;void
setEncoding
(String encoding) Sets the character encoding coming from the xsl:output encoding stylesheet attribute.boolean
setEscaping
(boolean escape) Turns special character escaping on/off.void
setIndentAmount
(int m_indentAmount) Sets the m_indentAmount.boolean
setLineSepUse
(boolean use_sytem_line_break) Set if the operating systems end-of-line line separator should be used when serializing.void
setNewLine
(char[] eolChars) Sets the end of line characters to be used during serializationvoid
setOutputFormat
(Properties format) Specifies an output format for this serializer.void
setOutputStream
(OutputStream output) Specifies an output stream to which the document should be serialized.void
setTransformer
(Transformer transformer) Sets the transformer associated with this serializervoid
Specifies a writer to which the document should be serialized.void
skippedEntity
(String name) Receive notification of a skipped entity.void
Report the start of a CDATA section.void
Report the start of DTD declarations, if any.void
startElement
(String elementName) This method is used to notify of the start of an elementvoid
startElement
(String elementNamespaceURI, String elementLocalName, String elementName) Receive notification of the beginning of an element, additional namespace or attribute information can occur before or after this call, that is associated with this element.void
startElement
(String namespaceURI, String localName, String name, Attributes atts) Receive notification of the beginning of an element, although this is a SAX method additional namespace or attribute information can occur before or after this call, that is associated with this element.void
startEntity
(String name) Report the beginning of an entity.void
Starts an un-escaping section.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.void
unparsedEntityDecl
(String name, String pubID, String sysID, String notationName) If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.void
writeAttrString
(Writer writer, String string, String encoding) Returns the specified string after substituting specials, and UTF-16 surrogates for chracter references&#xnn
.Methods inherited from class org.apache.xml.serializer.SerializerBase
addAttribute, addAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, characters, close, comment, documentIsEmpty, endEntity, entityReference, error, fatalError, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getStandalone, getTransformer, getVersion, namespaceAfterStartElement, 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, endDocument, processingInstruction
Methods inherited from interface org.apache.xml.serializer.ExtendedContentHandler
addUniqueAttribute
-
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
-
ToStream
public ToStream()Default constructor
-
-
Method Details
-
serialize
Serializes the DOM node. Throws an exception only if an I/O exception occured while serializing.- Parameters:
node
- Node to serialize.- Throws:
IOException
- An I/O exception occured while serializing
-
getOutputStream
Get the output stream where the events will be serialized to.- Returns:
- reference to the result stream, or null of only a writer was set.
-
elementDecl
Report an element type declaration.The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all whitespace is removed,and will include the enclosing parentheses.
- Parameters:
name
- The element type name.model
- The content model as a normalized string.- Throws:
SAXException
- The application may raise an exception.
-
internalEntityDecl
Report an internal entity declaration.Only the effective (first) declaration for each entity will be reported.
- Parameters:
name
- The name of the entity. If it is a parameter entity, the name will begin with '%'.value
- The replacement text of the entity.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
setOutputFormat
Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.- Parameters:
format
- The output format to use
-
getOutputFormat
Returns the output format for this serializer.- Returns:
- The output format in use
-
setWriter
Specifies a writer to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.- Parameters:
writer
- The output writer stream
-
setLineSepUse
public boolean setLineSepUse(boolean use_sytem_line_break) Set if the operating systems end-of-line line separator should be used when serializing. If set false NL character (decimal 10) is left alone, otherwise the new-line will be replaced on output with the systems line separator. For example on UNIX this is NL, while on Windows it is two characters, CR NL, where CR is the carriage-return (decimal 13).- Parameters:
use_sytem_line_break
- True if an input NL is replaced with the operating systems end-of-line separator.- Returns:
- The previously set value of the serializer.
-
setOutputStream
Specifies an output stream to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.The encoding specified in the output properties is used, or if no encoding was specified, the default for the selected output method.
- Parameters:
output
- The output stream
-
setEscaping
public boolean setEscaping(boolean escape) Description copied from interface:SerializationHandler
Turns special character escaping on/off. Note that characters will never, even if this option is set to 'true', be escaped within CDATA sections in output XML documents.- Parameters:
escape
- true if escaping is to be set on.- See Also:
-
attributeDecl
public void attributeDecl(String eName, String aName, String type, String valueDefault, String value) throws SAXException Report an attribute type declaration.Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION", or a parenthesized token group with the separator "|" and all whitespace removed.
- Parameters:
eName
- The name of the associated element.aName
- The name of the attribute.type
- A string representing the attribute type.valueDefault
- A string representing the attribute default ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.value
- A string representing the attribute's default value, or null if there is none.- Throws:
SAXException
- The application may raise an exception.
-
getWriter
Get the character stream where the events will be serialized to.- Returns:
- Reference to the result Writer, or null.
-
externalEntityDecl
Report a parsed external entity declaration.Only the effective (first) declaration for each entity will be reported.
- Parameters:
name
- The name of the entity. If it is a parameter entity, the name will begin with '%'.publicId
- The declared public identifier of the entity, or null if none was declared.systemId
- The declared system identifier of the entity.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
endNonEscaping
Ends an un-escaping section.- Throws:
SAXException
- See Also:
-
startNonEscaping
Starts an un-escaping section. All characters printed within an un- escaping section are printed as is, without escaping special characters into entity references. Only XML and HTML serializers need to support this method.The contents of the un-escaping section will be delivered through the regular characters event.
- Throws:
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).
- Parameters:
chars
- 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:
-
characters
Receive notification of character data.- Parameters:
s
- The string of characters to process.- Throws:
SAXException
-
startElement
public void startElement(String namespaceURI, String localName, String name, Attributes atts) throws SAXException Receive notification of the beginning of an element, although this is a SAX method additional namespace or attribute information can occur before or after this call, that is associated with this element.- 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 element type name.atts
- The attributes attached to the element, if any.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
- See Also:
-
startElement
public void startElement(String elementNamespaceURI, String elementLocalName, String elementName) throws SAXException Receive notification of the beginning of an element, additional namespace or attribute information can occur before or after this call, that is associated with this element.- 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
- Any SAX exception, possibly wrapping another exception.SAXException
- See Also:
-
startElement
Description copied from interface:ExtendedContentHandler
This method is used to notify of the start of an element- Parameters:
elementName
- the fully qualified name of the element- Throws:
SAXException
-
processAttributes
Process the attributes, which means to write out the currently collected attributes to the writer. The attributes are not cleared by this method- Parameters:
writer
- the writer to write processed attributes to.nAttrs
- the number of attributes in m_attributes to be processed- Throws:
IOException
SAXException
-
writeAttrString
Returns the specified string after substituting specials, and UTF-16 surrogates for chracter references&#xnn
.- Parameters:
string
- String to convert to XML format.encoding
- CURRENTLY NOT IMPLEMENTED.- Throws:
IOException
-
endElement
Receive notification of the end of an element.- 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 element type name- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.SAXException
-
endElement
Receive notification of the end of an element.- Parameters:
name
- The element type name- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.
-
startPrefixMapping
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.- 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:
-
startPrefixMapping
public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush) throws SAXException 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.- 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:
-
comment
Receive notification of 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).- 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.
-
endCDATA
Report the end of a CDATA section.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
endDTD
Report the end of DTD declarations.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
endPrefixMapping
End the scope of a prefix-URI Namespace mapping.- Parameters:
prefix
- The prefix that was being mapping.- Throws:
SAXException
- The client may throw an exception during processing.- See Also:
-
ignorableWhitespace
Receive notification of ignorable whitespace in element content. Not sure how to get this invoked quite yet.- 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:
-
skippedEntity
Receive notification of a skipped entity.- Parameters:
name
- The name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]".- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
startCDATA
Report the start of a CDATA section.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
startEntity
Report the beginning of an entity. The start and end of the document entity are not reported. The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.- Parameters:
name
- The name of the entity. If it is a parameter entity, the name will begin with '%'.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
startDTD
Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.- Parameters:
name
- The document type name.publicId
- The declared public identifier for the external DTD subset, or null if none was declared.systemId
- The declared system identifier for the external DTD subset, or null if none was declared.- Throws:
SAXException
- The application may raise an exception.- See Also:
-
getIndentAmount
public int getIndentAmount()Returns the m_indentAmount.- Overrides:
getIndentAmount
in classSerializerBase
- Returns:
- int
-
setIndentAmount
public void setIndentAmount(int m_indentAmount) Sets the m_indentAmount.- Specified by:
setIndentAmount
in interfaceSerializationHandler
- Overrides:
setIndentAmount
in classSerializerBase
- Parameters:
m_indentAmount
- The m_indentAmount to set
-
setCdataSectionElements
Remembers the cdata sections specified in the cdata-section-elements. The "official way to set URI and localName pairs. This method should be used by both Xalan and XSLTC.- Parameters:
URI_and_localNames
- a vector of pairs of Strings (URI/local)
-
flushPending
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.- Throws:
SAXException
-
setContentHandler
Description copied from interface:SerializationHandler
Set the SAX Content handler that the serializer sends its output to. This method only applies to a ToSAXHandler, not to a ToStream serializer.- See Also:
-
addAttributeAlways
public boolean addAttributeAlways(String uri, String localName, String rawName, String type, String value, boolean xslAttribute) Adds the given attribute to the set of attributes, even if there is no currently open element. This is useful if a SAX startPrefixMapping() should need to add an attribute before the element name is seen. This method is a copy of its super classes method, except that some tracing of events is done. This is so the tracing is only done for stream serializers, not for SAX ones.- Overrides:
addAttributeAlways
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:attribute element.- Returns:
- true if the attribute value was added, false if the attribute already existed and the value was replaced with the new value.
-
setTransformer
Description copied from class:SerializerBase
Sets the transformer associated with this serializer- Specified by:
setTransformer
in interfaceSerializationHandler
- Overrides:
setTransformer
in classSerializerBase
- Parameters:
transformer
- the transformer associated with this serializer.- See Also:
-
reset
public boolean reset()Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).- Specified by:
reset
in interfaceSerializer
- Overrides:
reset
in classSerializerBase
- Returns:
- true if the class was successfuly reset.
-
setEncoding
Sets the character encoding coming from the xsl:output encoding stylesheet attribute.- Overrides:
setEncoding
in classSerializerBase
- Parameters:
encoding
- the character encoding
-
notationDecl
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.- Specified by:
notationDecl
in interfaceDTDHandler
- Overrides:
notationDecl
in classSerializerBase
- Throws:
SAXException
- See Also:
-
unparsedEntityDecl
public void unparsedEntityDecl(String name, String pubID, String sysID, String notationName) throws SAXException If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.- Specified by:
unparsedEntityDecl
in interfaceDTDHandler
- Overrides:
unparsedEntityDecl
in classSerializerBase
- Throws:
SAXException
- See Also:
-
setDTDEntityExpansion
public void setDTDEntityExpansion(boolean expand) If set to false the serializer does not expand DTD entities, but leaves them as is, the default value is true;- Specified by:
setDTDEntityExpansion
in interfaceSerializationHandler
- Overrides:
setDTDEntityExpansion
in classSerializerBase
- Parameters:
expand
- true if DTD entities are to be expanded, false if they are to be left as DTD entity references.
-
setNewLine
public void setNewLine(char[] eolChars) Sets the end of line characters to be used during serialization- Parameters:
eolChars
- A character array corresponding to the characters to be used.
-
addCdataSectionElements
Remembers the cdata sections specified in the cdata-section-elements by appending the given cdata section elements to the list. This method can be called multiple times, but once an element is put in the list of cdata section elements it can not be removed. This method should be used by both Xalan and XSLTC.- Parameters:
URI_and_localNames
- a whitespace separated list of element names, each element is a URI in curly braces (optional) and a local name. An example of such a parameter is: "{http://company.com}price {myURI2}book chapter"
-