Save This Page
Home » Xerces-J-src.2.9.1 » org.apache.xml » serialize » [javadoc | source]
org.apache.xml.serialize
public class: XMLSerializer [javadoc | source]
java.lang.Object
   org.apache.xml.serialize.BaseMarkupSerializer
      org.apache.xml.serialize.XMLSerializer

All Implemented Interfaces:
    ContentHandler, DTDHandler, DocumentHandler, DeclHandler, Serializer, DOMSerializer, LexicalHandler

Direct Known Subclasses:
    XML11Serializer

Deprecated! This - class was deprecated in Xerces 2.9.0. It is recommended that new applications use the DOM Level 3 LSSerializer or JAXP's Transformation API for XML (TrAX) for serializing XML. See the Xerces documentation for more information.

Implements an XML serializer supporting both DOM and SAX pretty serializing. For usage instructions see Serializer .

If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.

The serializer supports both DOM and SAX. SAX serializing is done by firing SAX events and using the serializer as a document handler. DOM serializing is done by calling #serialize(Document) or by using DOM Level 3 org.w3c.dom.ls.LSSerializer and serializing with org.w3c.dom.ls.LSSerializer#write , org.w3c.dom.ls.LSSerializer#writeToString .

If an I/O exception occurs while serializing, the serializer will not throw an exception directly, but only throw it at the end of serializing (either DOM or SAX's org.xml.sax.DocumentHandler#endDocument .

For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.

Field Summary
protected static final  boolean DEBUG     
protected  NamespaceSupport fNSBinder    stores namespaces in scope 
protected  NamespaceSupport fLocalNSBinder    stores all namespace bindings on the current element 
protected  SymbolTable fSymbolTable    symbol table for serialization 
protected static final  String PREFIX     
protected  boolean fNamespaces    Controls whether namespace fixup should be performed during the serialization. NOTE: if this field is set to true the following fields need to be initialized: fNSBinder, fLocalNSBinder, fSymbolTable, XMLSymbols.EMPTY_STRING, fXmlSymbol, fXmlnsSymbol 
protected  boolean fNamespacePrefixes    Controls whether namespace prefixes will be printed out during serialization 
Fields inherited from org.apache.xml.serialize.BaseMarkupSerializer:
features,  fDOMErrorHandler,  fDOMError,  fDOMFilter,  _encodingInfo,  _started,  _prefixes,  _docTypePublicId,  _docTypeSystemId,  _format,  _printer,  _indenting,  fStrBuffer,  fCurrentNode
Constructor:
 public XMLSerializer() 
 public XMLSerializer(OutputFormat format) 
 public XMLSerializer(Writer writer,
    OutputFormat format) 
    Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.
    Parameters:
    writer - The writer to use
    format - The output format to use, null for the default
 public XMLSerializer(OutputStream output,
    OutputFormat format) 
    Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.
    Parameters:
    output - The output stream to use
    format - The output format to use, null for the default
Method from org.apache.xml.serialize.XMLSerializer Summary:
checkUnboundNamespacePrefixedNode,   endElement,   endElement,   endElementIO,   getEntityRef,   printEscaped,   printText,   printText,   printXMLChar,   reset,   serializeElement,   setNamespaces,   setOutputFormat,   startDocument,   startElement,   startElement
Methods from org.apache.xml.serialize.BaseMarkupSerializer:
asContentHandler,   asDOMSerializer,   asDocumentHandler,   attributeDecl,   characters,   characters,   checkUnboundNamespacePrefixedNode,   clearDocumentState,   comment,   comment,   content,   elementDecl,   endCDATA,   endDTD,   endDocument,   endEntity,   endNonEscaping,   endPrefixMapping,   endPreserving,   enterElementState,   externalEntityDecl,   fatalError,   getElementState,   getEntityRef,   getPrefix,   ignorableWhitespace,   internalEntityDecl,   isDocumentState,   leaveElementState,   modifyDOMError,   notationDecl,   prepare,   printCDATAText,   printDoctypeURL,   printEscaped,   printEscaped,   printHex,   printText,   printText,   processingInstruction,   processingInstructionIO,   reset,   serialize,   serialize,   serialize,   serializeElement,   serializeNode,   serializePreRoot,   setDocumentLocator,   setOutputByteStream,   setOutputCharStream,   setOutputFormat,   skippedEntity,   startCDATA,   startDTD,   startDocument,   startEntity,   startNonEscaping,   startPrefixMapping,   startPreserving,   surrogates,   unparsedEntityDecl
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xml.serialize.XMLSerializer Detail:
 protected  void checkUnboundNamespacePrefixedNode(Node node) throws IOException 
      Deprecated!
    DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.
 public  void endElement(String tagName) throws SAXException 
      Deprecated!
 public  void endElement(String namespaceURI,
    String localName,
    String rawName) throws SAXException 
      Deprecated!
 public  void endElementIO(String namespaceURI,
    String localName,
    String rawName) throws IOException 
      Deprecated!
 protected String getEntityRef(int ch) 
      Deprecated!
 protected  void printEscaped(String source) throws IOException 
      Deprecated!
 protected  void printText(String text,
    boolean preserveSpace,
    boolean unescaped) throws IOException 
      Deprecated!
 protected  void printText(char[] chars,
    int start,
    int length,
    boolean preserveSpace,
    boolean unescaped) throws IOException 
      Deprecated!
 protected  void printXMLChar(int ch) throws IOException 
      Deprecated!
    print text data
 public boolean reset() 
      Deprecated!
 protected  void serializeElement(Element elem) throws IOException 
      Deprecated!
    Called to serialize a DOM element. Equivalent to calling #startElement , #endElement and serializing everything inbetween, but better optimized.
 public  void setNamespaces(boolean namespaces) 
      Deprecated!
    This methods turns on namespace fixup algorithm during DOM serialization.
 public  void setOutputFormat(OutputFormat format) 
      Deprecated!
 protected  void startDocument(String rootTagName) throws IOException 
      Deprecated!
    Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.

    This method will check if it has not been called before (#_started ), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see #serializePreRoot ). Pre-root will be serialized even if this is not the first root element of the document.

 public  void startElement(String tagName,
    AttributeList attrs) throws SAXException 
      Deprecated!
 public  void startElement(String namespaceURI,
    String localName,
    String rawName,
    Attributes attrs) throws SAXException 
      Deprecated!