Class/Object

eu.cdevreeze.yaidom.print

DocumentPrinterUsingSax

Related Docs: object DocumentPrinterUsingSax | package print

Permalink

final class DocumentPrinterUsingSax extends AbstractDocumentPrinter

SAX-based Document printer. It should be the fastest of the DocumentPrinter implementations, and use the least memory.

See http://blogger.ziesemer.com/2007/06/xml-generation-in-java.html#SAXMethod.

If more flexibility is needed in configuring the DocumentPrinter than offered by this class, consider writing a wrapper DocumentPrinter which wraps a DocumentPrinterUsingSax, but adapts the print method. This would make it possible to adapt the generation of SAX events, for example.

A DocumentPrinterUsingSax instance can be re-used multiple times, from the same thread. If the SAXTransformerFactory is thread-safe, it can even be re-used from multiple threads. Typically a SAXTransformerFactory cannot be trusted to be thread-safe, however. In a web application, one (safe) way to deal with that is to use one SAXTransformerFactory instance per request.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentPrinterUsingSax
  2. AbstractDocumentPrinter
  3. DocumentPrinter
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentPrinterUsingSax(saxTransformerFactory: SAXTransformerFactory, transformerHandlerCreator: (SAXTransformerFactory) ⇒ TransformerHandler, documentConverter: DocumentConverter[SaxEventsProducer])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val documentConverter: DocumentConverter[SaxEventsProducer]

    Permalink
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def omittingXmlDeclaration: DocumentPrinterUsingSax

    Permalink

    Returns a copy of this DocumentPrinter that omits XML declarations

    Returns a copy of this DocumentPrinter that omits XML declarations

    Definition Classes
    DocumentPrinterUsingSaxDocumentPrinter
  17. def print(doc: Document): String

    Permalink

    Converts the Document to a String.

    Converts the Document to a String. May use a lot of memory for large XML documents.

    To have more control over the character encoding of the output, when converting the String to bytes (and of the encoding mentioned in the XML declaration, if any), consider using one of the other overloaded print methods taking a Document.

    Definition Classes
    DocumentPrinterUsingSaxDocumentPrinter
  18. def print(doc: Document, encoding: String, outputStream: OutputStream): Unit

    Permalink

    Serializes the Document to an output stream, using the given encoding.

    Serializes the Document to an output stream, using the given encoding. This method should close the output stream afterwards.

    May use a lot of memory for large XML documents, although not as much as the print method that returns a byte array.

    Definition Classes
    DocumentPrinterUsingSaxDocumentPrinter
  19. final def print(elm: Elem): String

    Permalink

    Converts the Elem to a String, omitting the XML declaration.

    Converts the Elem to a String, omitting the XML declaration. May use a lot of memory for large XML documents.

    To have more control over the character encoding of the output, when converting the String to bytes (and of the encoding mentioned in the XML declaration, if any), consider using one of the other overloaded print methods taking an Elem.

    Definition Classes
    AbstractDocumentPrinterDocumentPrinter
  20. final def print(elm: Elem, encoding: String, outputStream: OutputStream): Unit

    Permalink

    Serializes the Elem to an output stream, omitting the XML declaration.

    Serializes the Elem to an output stream, omitting the XML declaration. This method should close the output stream afterwards.

    Definition Classes
    AbstractDocumentPrinterDocumentPrinter
  21. final def print(elm: Elem, encoding: String): Array[Byte]

    Permalink

    Converts the Elem to a byte array, omitting the XML declaration

    Converts the Elem to a byte array, omitting the XML declaration

    Definition Classes
    AbstractDocumentPrinterDocumentPrinter
  22. final def print(doc: Document, encoding: String): Array[Byte]

    Permalink

    Converts the Document to a byte array, using the given encoding.

    Converts the Document to a byte array, using the given encoding. May use a lot of memory for large XML documents.

    Definition Classes
    AbstractDocumentPrinterDocumentPrinter
  23. val saxTransformerFactory: SAXTransformerFactory

    Permalink
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  26. val transformerHandlerCreator: (SAXTransformerFactory) ⇒ TransformerHandler

    Permalink
  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def withDocumentConverter(newDocumentConverter: DocumentConverter[SaxEventsProducer]): DocumentPrinterUsingSax

    Permalink

    Returns an adapted copy having the passed DocumentConverter.

    Returns an adapted copy having the passed DocumentConverter. This method makes it possible to use an adapted document converter, which may be needed depending on the JAXP implementation used.

Inherited from AbstractDocumentPrinter

Inherited from DocumentPrinter

Inherited from AnyRef

Inherited from Any

Ungrouped