java.lang.Object

org.apache.xml.serializer.SerializerBase

org.apache.xml.serializer.ToStream

All Implemented Interfaces:: DOMSerializer, ExtendedContentHandler, ExtendedLexicalHandler, SerializationHandler, Serializer, ContentHandler, DTDHandler, ErrorHandler, DeclHandler, LexicalHandler

Direct Known Subclasses:: ToHTMLStream, ToTextStream, ToXMLStream

public abstract class ToStream
extends SerializerBase

This abstract class is a base class for other stream serializers (xml, html, text ...) that write output to a stream.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CDATA_CONTINUE`	To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
`static String`	`CDATA_DELIMITER_CLOSE`	The constant "]]>"
`static String`	`CDATA_DELIMITER_OPEN`
`static String`	`DEFAULT_SAX_SERIALIZER`
`static String`	`EMPTYSTRING`
`static String`	`ENTITY_AMP`
`static String`	`ENTITY_CRLF`
`static String`	`ENTITY_GT`
`static String`	`ENTITY_LT`
`static String`	`ENTITY_QUOT`
`protected boolean`	`m_cdataStartCalled`	remembers if we are in between the startCDATA() and endCDATA() callbacks
`protected org.apache.xml.serializer.CharInfo`	`m_charInfo`	Map that tells which characters should have special treatment, and it provides character to entity name lookup.
`protected org.apache.xml.serializer.ToStream.BoolStack`	`m_disableOutputEscapingStates`	Stack to keep track of disabling output escaping.
`protected boolean`	`m_escaping`	Taken from XSLTC
`protected boolean`	`m_inDoctype`	Tells if we're in an internal document type subset.
`protected boolean`	`m_ispreserve`	State flag to tell if preservation of whitespace is important.
`protected boolean`	`m_isprevtext`	State flag that tells if the previous node processed was text, so we can tell if we should preserve whitespace.
`protected char[]`	`m_lineSep`	The system line separator for writing out line breaks.
`protected int`	`m_lineSepLen`	The length of the line seperator, since the write is done one character at a time.
`protected boolean`	`m_lineSepUse`	True if the the system line separator is to be used.
`protected org.apache.xml.serializer.ToStream.BoolStack`	`m_preserves`	Stack to keep track of whether or not we need to preserve whitespace.
`protected boolean`	`m_spaceBeforeClose`	Add space before '/>' for XHTML.
`static String`	`XML_PREFIX`
`static String`	`XMLNS_PREFIX`
`static String`	`XMLNS_URI`
`static String`	`XMLVERSION10`
`static String`	`XMLVERSION11`	Define the XML version.

Fields inherited from class org.apache.xml.serializer.SerializerBase

m_attrBuff, m_attributes, m_CdataElems, m_cdataTagOpen, m_charsBuff, m_doctypePublic, m_doctypeSystem, m_doIndent, m_elemContext, m_indentAmount, m_inEntityRef, m_inExternalDTD, m_mediatype, m_needToCallStartDocument, m_prefixMap, m_shouldNotWriteXMLHeader, m_sourceLocator, m_standaloneWasSpecified, m_StringOfCDATASections, m_tracer, m_version, m_writer, PKG_NAME, PKG_PATH

Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler

HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS

Constructor Summary

Constructors

Constructor Description

ToStream()
Default constructor

Method Summary

Modifier and Type	Method	Description
`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.
`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`	`attributeDecl(String eName, String aName, String type, String valueDefault, String value)`	Report an attribute type declaration.
`protected void`	`cdata(char[] ch, int start, int length)`	Receive notification of cdata.
`void`	`characters(char[] chars, int start, int length)`	Receive notification of character data.
`void`	`characters(String s)`	Receive notification of character data.
`protected void`	`charactersRaw(char[] ch, int start, int length)`	If available, when the disable-output-escaping attribute is used, output raw text without escaping.
`protected void`	`closeCDATA()`	This helper method to writes out "]]>" when closing a CDATA section.
`protected void`	`closeStartTag()`	For the enclosing elements starting tag write out out any attributes followed by ">"
`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`	`endNonEscaping()`	Ends an un-escaping section.
`void`	`endPrefixMapping(String prefix)`	End the scope of a prefix-URI Namespace mapping.
`protected String`	`ensureAttributesNamespaceIsDeclared(String ns, String localName, String rawName)`	Makes sure that the namespace URI for the given qualified attribute name is declared.
`protected boolean`	`escapingNotNeeded(char ch)`	Tell if this character can be written without escaping.
`void`	`externalEntityDecl(String name, String publicId, String systemId)`	Report a parsed external entity declaration.
`protected void`	`firePseudoAttributes()`	To fire off the pseudo characters of attributes, as they currently exist.
`void`	`flushPending()`	This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.
`protected void`	`flushWriter()`	Flush the formatter's result stream.
`int`	`getIndentAmount()`	Returns the m_indentAmount.
`Properties`	`getOutputFormat()`	Returns the output format for this serializer.
`OutputStream`	`getOutputStream()`	Get the output stream where the events will be serialized to.
`Writer`	`getWriter()`	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.
`protected void`	`indent()`	Indent at the current element nesting depth.
`protected void`	`indent(int depth)`	Might print a newline character and the indentation amount of the given depth.
`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.
`protected void`	`outputLineSep()`	Output a system-dependent line break.
`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`	`serialize(Node node)`	Serializes the DOM node.
`void`	`setCdataSectionElements(Vector URI_and_localNames)`	Remembers the cdata sections specified in the cdata-section-elements.
`void`	`setContentHandler(ContentHandler ch)`	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 serialization
`void`	`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 serializer
`void`	`setWriter(Writer writer)`	Specifies a writer to which the document should be serialized.
`protected boolean`	`shouldIndent()`	Tell if, based on space preservation constraints and the doIndent property, if an indent should occur.
`void`	`skippedEntity(String name)`	Receive notification of a skipped entity.
`void`	`startCDATA()`	Report the start of a CDATA section.
`void`	`startDTD(String name, String publicId, String systemId)`	Report the start of DTD declarations, if any.
`void`	`startElement(String elementName)`	This method is used to notify of the start of an element
`void`	`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`	`startNonEscaping()`	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`.
`protected int`	`writeUTF16Surrogate(char c, char[] ch, int i, int end)`	Once a surrogate has been detected, write out the pair of characters if it is in the encoding, or if there is no encoding, otherwise write out an entity reference of the value of the unicode code point of the character represented by the high/low surrogate pair.

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, fireCDATAEvent, fireCharEvent, fireCommentEvent, fireEndDoc, fireEndElem, fireEndEntity, fireEntityReference, fireEscapingEvent, fireStartDoc, fireStartElem, fireStartEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getLocalName, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getPrefixPart, getStandalone, getTransformer, getVersion, initCDATA, isCdataSection, namespaceAfterStartElement, patchName, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setStandaloneInternal, setVersion, startDocument, startDocumentInternal, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

endDocument, processingInstruction

Methods inherited from interface org.apache.xml.serializer.ExtendedContentHandler

addUniqueAttribute

Field Details
- m_disableOutputEscapingStates
  
  protected org.apache.xml.serializer.ToStream.BoolStack m_disableOutputEscapingStates
  
  Stack to keep track of disabling output escaping.
- m_preserves
  
  protected org.apache.xml.serializer.ToStream.BoolStack m_preserves
  
  Stack to keep track of whether or not we need to preserve whitespace. Used to push/pop values used for the field m_ispreserve, but m_ispreserve is only relevant if m_doIndent is true. If m_doIndent is false this field has no impact.
- m_ispreserve
  
  protected boolean m_ispreserve
  
  State flag to tell if preservation of whitespace is important. Used only in shouldIndent() but only if m_doIndent is true. If m_doIndent is false this flag has no impact.
- m_isprevtext
  
  protected boolean m_isprevtext
  
  State flag that tells if the previous node processed was text, so we can tell if we should preserve whitespace. Used in endDocument() and shouldIndent() but only if m_doIndent is true. If m_doIndent is false this flag has no impact.
- m_lineSep
  
  protected char[] m_lineSep
  
  The system line separator for writing out line breaks. The default value is from the system property, but this value can be set through the xsl:output extension attribute xalan:line-separator.
- m_lineSepUse
  
  protected boolean m_lineSepUse
  
  True if the the system line separator is to be used.
- m_lineSepLen
  
  protected int m_lineSepLen
  
  The length of the line seperator, since the write is done one character at a time.
- m_charInfo
  
  protected org.apache.xml.serializer.CharInfo m_charInfo
  
  Map that tells which characters should have special treatment, and it provides character to entity name lookup.
- m_spaceBeforeClose
  
  protected boolean m_spaceBeforeClose
  
  Add space before '/>' for XHTML.
- m_inDoctype
  
  protected boolean m_inDoctype
  
  Tells if we're in an internal document type subset.
- m_cdataStartCalled
  
  protected boolean m_cdataStartCalled
  
  remembers if we are in between the startCDATA() and endCDATA() callbacks
- m_escaping
  
  protected boolean m_escaping
  
  Taken from XSLTC
- CDATA_CONTINUE
  
  static final String CDATA_CONTINUE
  
  To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
  
  See Also:
  
  Constant Field Values
- CDATA_DELIMITER_CLOSE
  
  static final String CDATA_DELIMITER_CLOSE
  
  The constant "]]>"
  
  See Also:
  
  Constant Field Values
- CDATA_DELIMITER_OPEN
  
  static final String CDATA_DELIMITER_OPEN
  
  See Also:
  
  Constant Field Values
- EMPTYSTRING
  
  static final String EMPTYSTRING
  
  See Also:
  
  Constant Field Values
- ENTITY_AMP
  
  static final String ENTITY_AMP
  
  See Also:
  
  Constant Field Values
- ENTITY_CRLF
  
  static final String ENTITY_CRLF
  
  See Also:
  
  Constant Field Values
- ENTITY_GT
  
  static final String ENTITY_GT
  
  See Also:
  
  Constant Field Values
- ENTITY_LT
  
  static final String ENTITY_LT
  
  See Also:
  
  Constant Field Values
- ENTITY_QUOT
  
  static final String ENTITY_QUOT
  
  See Also:
  
  Constant Field Values
- XML_PREFIX
  
  static final String XML_PREFIX
  
  See Also:
  
  Constant Field Values
- XMLNS_PREFIX
  
  static final String XMLNS_PREFIX
  
  See Also:
  
  Constant Field Values
- XMLNS_URI
  
  static final String XMLNS_URI
  
  See Also:
  
  Constant Field Values
- DEFAULT_SAX_SERIALIZER
  
  static final String DEFAULT_SAX_SERIALIZER
- XMLVERSION11
  
  static final String XMLVERSION11
  
  Define the XML version.
  
  See Also:
  
  Constant Field Values
- XMLVERSION10
  
  static final String XMLVERSION10
  
  See Also:
  
  Constant Field Values
Constructor Details
- ToStream
  
  public ToStream()
  
  Default constructor
Method Details
- closeCDATA
  
  protected void closeCDATA() throws SAXException
  
  This helper method to writes out "]]>" when closing a CDATA section.
  
  Throws:
  
  SAXException
- serialize
  
  public void serialize(Node node) throws IOException
  
  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
- flushWriter
  
  protected final void flushWriter() throws SAXException
  
  Flush the formatter's result stream.
  
  Throws:
  
  SAXException
- getOutputStream
  
  public OutputStream 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
  
  public void elementDecl(String name, String model) throws SAXException
  
  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
  
  public void internalEntityDecl(String name, String value) throws SAXException
  
  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:
  
  externalEntityDecl(java.lang.String, java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
- outputLineSep
  
  protected final void outputLineSep() throws IOException
  
  Output a system-dependent line break.
  
  Throws:
  
  SAXException
  
  IOException
- setOutputFormat
  
  public void setOutputFormat(Properties format)
  
  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
  
  public Properties getOutputFormat()
  
  Returns the output format for this serializer.
  
  Returns:
  
  The output format in use
- setWriter
  
  public void setWriter(Writer writer)
  
  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
  
  public void setOutputStream(OutputStream output)
  
  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:
  
  SerializationHandler.setEscaping(boolean)
- indent
  
  protected void indent(int depth) throws IOException
  
  Might print a newline character and the indentation amount of the given depth.
  
  Parameters:
  
  depth - the indentation depth (element nesting depth)
  
  Throws:
  
  SAXException - if an error occurs during writing.
  
  IOException
- indent
  
  protected void indent() throws IOException
  
  Indent at the current element nesting depth.
  
  Throws:
  
  IOException
- 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
  
  public Writer getWriter()
  
  Get the character stream where the events will be serialized to.
  
  Returns:
  
  Reference to the result Writer, or null.
- externalEntityDecl
  
  public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException
  
  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:
  
  internalEntityDecl(java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
- escapingNotNeeded
  
  protected boolean escapingNotNeeded(char ch)
  
  Tell if this character can be written without escaping.
- writeUTF16Surrogate
  
  protected int writeUTF16Surrogate(char c, char[] ch, int i, int end) throws IOException
  
  Once a surrogate has been detected, write out the pair of characters if it is in the encoding, or if there is no encoding, otherwise write out an entity reference of the value of the unicode code point of the character represented by the high/low surrogate pair.
  An exception is thrown if there is no low surrogate in the pair, because the array ends unexpectely, or if the low char is there but its value is such that it is not a low surrogate.
  
  Parameters:
  
  c - the first (high) part of the surrogate, which must be confirmed before calling this method.
  
  ch - Character array.
  
  i - position Where the surrogate was detected.
  
  end - The end index of the significant characters.
  
  Returns:
  
  0 if the pair of characters was written out as-is, the unicode code point of the character represented by the surrogate pair if an entity reference with that value was written out.
  
  Throws:
  
  IOException
  
  SAXException - if invalid UTF-16 surrogate detected.
- endNonEscaping
  
  public void endNonEscaping() throws SAXException
  
  Ends an un-escaping section.
  
  Throws:
  
  SAXException
  
  See Also:
  
  startNonEscaping()
- startNonEscaping
  
  public void startNonEscaping() throws SAXException
  
  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
- cdata
  
  protected void cdata(char[] ch, int start, int length) throws SAXException
  
  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.
  
  SAXException
  
  See Also:
  
  ignorableWhitespace(char[], int, int), Locator
- charactersRaw
  
  protected void charactersRaw(char[] ch, int start, int length) throws SAXException
  
  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
- characters
  
  public void characters(char[] chars, int start, int length) throws SAXException
  
  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:
  
  ignorableWhitespace(char[], int, int), Locator
- characters
  
  public void characters(String s) throws SAXException
  
  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:
  
  ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), AttributeList
- 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:
  
  ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), AttributeList
- startElement
  
  public void startElement(String elementName) throws SAXException
  
  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
  
  public void processAttributes(Writer writer, int nAttrs) throws IOException, SAXException
  
  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
  
  public void writeAttrString(Writer writer, String string, String encoding) throws IOException
  
  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
  
  public void endElement(String namespaceURI, String localName, String name) throws SAXException
  
  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
  
  public void endElement(String name) throws SAXException
  
  Receive notification of the end of an element.
  
  Parameters:
  
  name - The element type name
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
- startPrefixMapping
  
  public void startPrefixMapping(String prefix, String uri) throws SAXException
  
  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:
  
  ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)
- 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:
  
  ExtendedContentHandler.startPrefixMapping(java.lang.String, java.lang.String, boolean)
- comment
  
  public void comment(char[] ch, int start, int length) throws SAXException
  
  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
  
  public void endCDATA() throws SAXException
  
  Report the end of a CDATA section.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  startCDATA()
- endDTD
  
  public void endDTD() throws SAXException
  
  Report the end of DTD declarations.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  startDTD(java.lang.String, java.lang.String, java.lang.String)
- endPrefixMapping
  
  public void endPrefixMapping(String prefix) throws SAXException
  
  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:
  
  ContentHandler.endPrefixMapping(java.lang.String)
- ignorableWhitespace
  
  public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
  
  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:
  
  characters(char[], int, int)
- skippedEntity
  
  public void skippedEntity(String name) throws SAXException
  
  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:
  
  ContentHandler.skippedEntity(java.lang.String)
- startCDATA
  
  public void startCDATA() throws SAXException
  
  Report the start of a CDATA section.
  
  Throws:
  
  SAXException - The application may raise an exception.
  
  See Also:
  
  endCDATA()
- startEntity
  
  public void startEntity(String name) throws SAXException
  
  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:
  
  SerializerBase.endEntity(java.lang.String), DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)
- closeStartTag
  
  protected void closeStartTag() throws SAXException
  
  For the enclosing elements starting tag write out out any attributes followed by ">"
  
  Throws:
  
  SAXException
- startDTD
  
  public void startDTD(String name, String publicId, String systemId) throws SAXException
  
  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:
  
  endDTD(), startEntity(java.lang.String)
- getIndentAmount
  
  public int getIndentAmount()
  
  Returns the m_indentAmount.
  
  Overrides:
  
  getIndentAmount in class SerializerBase
  
  Returns:
  
  int
- setIndentAmount
  
  public void setIndentAmount(int m_indentAmount)
  
  Sets the m_indentAmount.
  
  Specified by:
  
  setIndentAmount in interface SerializationHandler
  
  Overrides:
  
  setIndentAmount in class SerializerBase
  
  Parameters:
  
  m_indentAmount - The m_indentAmount to set
- shouldIndent
  
  protected boolean shouldIndent()
  
  Tell if, based on space preservation constraints and the doIndent property, if an indent should occur.
  
  Returns:
  
  True if an indent should occur.
- setCdataSectionElements
  
  public void setCdataSectionElements(Vector URI_and_localNames)
  
  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)
- ensureAttributesNamespaceIsDeclared
  
  protected String ensureAttributesNamespaceIsDeclared(String ns, String localName, String rawName) throws SAXException
  
  Makes sure that the namespace URI for the given qualified attribute name is declared.
  
  Parameters:
  
  ns - the namespace URI
  
  rawName - the qualified name
  
  Returns:
  
  returns null if no action is taken, otherwise it returns the prefix used in declaring the namespace.
  
  Throws:
  
  SAXException
- flushPending
  
  public void flushPending() throws SAXException
  
  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
  
  public void setContentHandler(ContentHandler ch)
  
  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:
  
  Serializer.asContentHandler(), ToSAXHandler
- 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 class SerializerBase
  
  Parameters:
  
  uri - the URI of the attribute
  
  localName - the local name of the attribute
  
  rawName - the qualified name of the attribute
  
  type - the type of the attribute (probably CDATA)
  
  value - the value of the attribute
  
  xslAttribute - 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.
- firePseudoAttributes
  
  protected void firePseudoAttributes()
  
  To fire off the pseudo characters of attributes, as they currently exist. This method should be called everytime an attribute is added, or when an attribute value is changed, or an element is created.
- setTransformer
  
  public void setTransformer(Transformer transformer)
  
  Description copied from class: SerializerBase
  
  Sets the transformer associated with this serializer
  
  Specified by:
  
  setTransformer in interface SerializationHandler
  
  Overrides:
  
  setTransformer in class SerializerBase
  
  Parameters:
  
  transformer - the transformer associated with this serializer.
  
  See Also:
  
  SerializationHandler.setTransformer(Transformer)
- 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 interface Serializer
  
  Overrides:
  
  reset in class SerializerBase
  
  Returns:
  
  true if the class was successfuly reset.
- setEncoding
  
  public void setEncoding(String encoding)
  
  Sets the character encoding coming from the xsl:output encoding stylesheet attribute.
  
  Overrides:
  
  setEncoding in class SerializerBase
  
  Parameters:
  
  encoding - the character encoding
- notationDecl
  
  public void notationDecl(String name, String pubID, String sysID) 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:
  
  notationDecl in interface DTDHandler
  
  Overrides:
  
  notationDecl in class SerializerBase
  
  Parameters:
  
  name - The notation name.
  
  pubID - The notation's public identifier, or null if none was given.
  
  sysID - The notation's system identifier, or null if none was given.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
- 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 interface DTDHandler
  
  Overrides:
  
  unparsedEntityDecl in class SerializerBase
  
  Parameters:
  
  name - The unparsed entity's name.
  
  pubID - The entity's public identifier, or null if none was given.
  
  sysID - The entity's system identifier.
  
  notationName - The name of the associated notation.
  
  Throws:
  
  SAXException - Any SAX exception, possibly wrapping another exception.
  
  See Also:
  
  DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
- 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 interface SerializationHandler
  
  Overrides:
  
  setDTDEntityExpansion in class SerializerBase
  
  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
  
  public 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. 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"

Class ToStream

Field Summary

Fields inherited from class org.apache.xml.serializer.SerializerBase

Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler

Constructor Summary

Method Summary

Methods inherited from class org.apache.xml.serializer.SerializerBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.xml.sax.ContentHandler

Methods inherited from interface org.apache.xml.serializer.ExtendedContentHandler

Field Details

m_disableOutputEscapingStates

m_preserves

m_ispreserve

m_isprevtext

m_lineSep

m_lineSepUse

m_lineSepLen

m_charInfo

m_spaceBeforeClose

m_inDoctype

m_cdataStartCalled

m_escaping

CDATA_CONTINUE

CDATA_DELIMITER_CLOSE

CDATA_DELIMITER_OPEN

EMPTYSTRING

ENTITY_AMP

ENTITY_CRLF

ENTITY_GT

ENTITY_LT

ENTITY_QUOT

XML_PREFIX

XMLNS_PREFIX

XMLNS_URI

DEFAULT_SAX_SERIALIZER

XMLVERSION11

XMLVERSION10

Constructor Details

ToStream

Method Details

closeCDATA

serialize

flushWriter

getOutputStream

elementDecl

internalEntityDecl

outputLineSep

setOutputFormat

getOutputFormat

setWriter

setLineSepUse

setOutputStream

setEscaping

indent

indent

attributeDecl

getWriter

externalEntityDecl

escapingNotNeeded

writeUTF16Surrogate

endNonEscaping

startNonEscaping

cdata

charactersRaw

characters

characters

startElement

startElement

startElement

processAttributes

writeAttrString

endElement

endElement

startPrefixMapping

startPrefixMapping

comment

endCDATA

endDTD

endPrefixMapping