eu.cdevreeze.yaidom.print

DocumentPrinterUsingDomLS

Related Docs: object DocumentPrinterUsingDomLS | package print

final class DocumentPrinterUsingDomLS extends AbstractDocumentPrinter

DOM-LS-based Document printer.

To pretty-print a Document, create a DocumentPrinterUsingDomLS instance as follows:

val printer = DocumentPrinterUsingDomLS.newInstance() withSerializerCreator { domImpl =>
  val writer = domImpl.createLSSerializer()
  writer.getDomConfig.setParameter("format-pretty-print", java.lang.Boolean.TRUE)
  writer
}

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

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

Self Type
DocumentPrinterUsingDomLS
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocumentPrinterUsingDomLS
  2. AbstractDocumentPrinter
  3. DocumentPrinter
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentPrinterUsingDomLS(docBuilderFactory: DocumentBuilderFactory, docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder, domImplementation: DOMImplementationLS, serializerCreator: (DOMImplementationLS) ⇒ LSSerializer)

Value Members

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

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

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

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

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder

  7. val docBuilderFactory: DocumentBuilderFactory

  8. val domImplementation: DOMImplementationLS

  9. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. def omittingXmlDeclaration: DocumentPrinterUsingDomLS

    Returns a copy of this DocumentPrinter that omits XML declarations

    Returns a copy of this DocumentPrinter that omits XML declarations

    Definition Classes
    DocumentPrinterUsingDomLSDocumentPrinter
  19. def print(doc: Document): String

    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
    DocumentPrinterUsingDomLSDocumentPrinter
  20. def print(doc: Document, encoding: String, outputStream: OutputStream): Unit

    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
    DocumentPrinterUsingDomLSDocumentPrinter
  21. final def print(elm: Elem): String

    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
  22. final def print(elm: Elem, encoding: String, outputStream: OutputStream): Unit

    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
  23. final def print(elm: Elem, encoding: String): Array[Byte]

    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
  24. final def print(doc: Document, encoding: String): Array[Byte]

    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
  25. val serializerCreator: (DOMImplementationLS) ⇒ LSSerializer

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

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withSerializerCreator(newSerializerCreator: (DOMImplementationLS) ⇒ LSSerializer): DocumentPrinterUsingDomLS

Inherited from AbstractDocumentPrinter

Inherited from DocumentPrinter

Inherited from AnyRef

Inherited from Any

Ungrouped