org.apache.xml.serializer
public abstract class ToStream extends SerializerBase
UNKNOWN: internal
Constructor Summary | |
---|---|
ToStream()
Default constructor |
Method Summary | |
---|---|
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 | attributeDecl(String eName, String aName, String type, String valueDefault, String value)
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 namespaceURI, String localName, String name)
Receive notification of the end of an element.
|
void | endElement(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. |
void | externalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.
|
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. |
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.
|
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 | 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) |
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) |
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 | 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) |
void | setWriter(Writer writer)
Specifies a writer to which the document should be serialized.
|
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 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 | 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 elementName) |
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 .
|
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.
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.
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException
See Also: ToStream org.xml.sax.Locator
Parameters: s The string of characters to process.
Throws: org.xml.sax.SAXException
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: org.xml.sax.SAXException The application may raise an exception.
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.
Throws: org.xml.sax.SAXException The application may raise an exception.
See Also: ToStream
Throws: org.xml.sax.SAXException The application may raise an exception.
See Also: ToStream
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException
Parameters: name The element type name
Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
Throws: org.xml.sax.SAXException
See Also: ToStream
Parameters: prefix The prefix that was being mapping.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
See Also: org.xml.sax.ContentHandler#endPrefixMapping
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: ToStream org.xml.sax.DTDHandler#unparsedEntityDecl
Returns: int
Returns: The output format in use
Returns: reference to the result stream, or null of only a writer was set.
Returns: Reference to the result Writer, or null.
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException
See Also: ToStream
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: ToStream org.xml.sax.DTDHandler#unparsedEntityDecl
See Also: org.xml.sax.DTDHandler#notationDecl(java.lang.String, java.lang.String, java.lang.String)
Parameters: writer the writer to write processed attributes to. nAttrs the number of attributes in m_attributes to be processed
Throws: java.io.IOException org.xml.sax.SAXException
Returns: true if the class was successfuly reset.
Parameters: node Node to serialize.
Throws: IOException An I/O exception occured while serializing
Parameters: URI_and_localNames a vector of pairs of Strings (URI/local)
Parameters: encoding the character encoding
See Also: SerializationHandler
Parameters: m_indentAmount The m_indentAmount to set
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.
Parameters: format The output format to use
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
See Also: setTransformer
Parameters: writer The output writer stream
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
See Also: org.xml.sax.ContentHandler#skippedEntity
Throws: org.xml.sax.SAXException The application may raise an exception.
See Also: ToStream
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: org.xml.sax.SAXException The application may raise an exception.
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException
See Also: org.xml.sax.ContentHandler#startElement org.xml.sax.ContentHandler#endElement org.xml.sax.AttributeList
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException
See Also: org.xml.sax.ContentHandler#startElement org.xml.sax.ContentHandler#endElement org.xml.sax.AttributeList
Parameters: name The name of the entity. If it is a parameter entity, the name will begin with '%'.
Throws: org.xml.sax.SAXException The application may raise an exception.
See Also: ToStream org.xml.sax.ext.DeclHandler#internalEntityDecl org.xml.sax.ext.DeclHandler#externalEntityDecl
The contents of the un-escaping section will be delivered through the regular characters event.
Throws: org.xml.sax.SAXException
Parameters: prefix The Namespace prefix being declared. uri The Namespace URI the prefix is mapped to.
Throws: org.xml.sax.SAXException The client may throw an exception during processing.
See Also: org.xml.sax.ContentHandler#startPrefixMapping
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: org.xml.sax.SAXException The client may throw an exception during processing.
See Also: ExtendedContentHandler
See Also: org.xml.sax.DTDHandler#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
&#xnn
.
Parameters: string String to convert to XML format. encoding CURRENTLY NOT IMPLEMENTED.
Throws: java.io.IOException