DocumentPrinterUsingDomLS

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

AbstractDocumentPrinter, DocumentPrinter, AnyRef, Any

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder
val docBuilderFactory: DocumentBuilderFactory
val domImplementation: DOMImplementationLS
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
DocumentPrinterUsingDomLS → DocumentPrinter
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
DocumentPrinterUsingDomLS → DocumentPrinter
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
DocumentPrinterUsingDomLS → DocumentPrinter
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
AbstractDocumentPrinter → DocumentPrinter
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
AbstractDocumentPrinter → DocumentPrinter
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
AbstractDocumentPrinter → DocumentPrinter
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
AbstractDocumentPrinter → DocumentPrinter
val serializerCreator: (DOMImplementationLS) ⇒ LSSerializer
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

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

Related Docs: object DocumentPrinterUsingDomLS | package print

final class DocumentPrinterUsingDomLS extends AbstractDocumentPrinter

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder

val docBuilderFactory: DocumentBuilderFactory

val domImplementation: DOMImplementationLS

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def omittingXmlDeclaration: DocumentPrinterUsingDomLS

def print(doc: Document): String

def print(doc: Document, encoding: String, outputStream: OutputStream): Unit

final def print(elm: Elem): String

final def print(elm: Elem, encoding: String, outputStream: OutputStream): Unit

final def print(elm: Elem, encoding: String): Array[Byte]

final def print(doc: Document, encoding: String): Array[Byte]

val serializerCreator: (DOMImplementationLS) ⇒ LSSerializer

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withSerializerCreator(newSerializerCreator: (DOMImplementationLS) ⇒ LSSerializer): DocumentPrinterUsingDomLS

Inherited from AbstractDocumentPrinter

Inherited from DocumentPrinter

Inherited from AnyRef

Inherited from Any

Ungrouped