scala.xml

PrettyPrinter

class PrettyPrinter extends AnyRef

Class for pretty printing. After instantiating, you can use the format() and formatNode() methods to convert XML to a formatted string. The class can be reused to pretty print any number of XML nodes.

Source
PrettyPrinter.scala
Version

1.0

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PrettyPrinter
  2. AnyRef
  3. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PrettyPrinter(width: Int, step: Int)

    width

    the width to fit the output into

    step

    indentation

Type Members

  1. case class Box(col: Int, s: String) extends Item with Product with Serializable

  2. class BrokenException extends java.lang.Exception

  3. class Item extends AnyRef

  4. case class Para(s: String) extends Item with Product with Serializable

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to StringAdd[PrettyPrinter] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (PrettyPrinter, B)

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to ArrowAssoc[PrettyPrinter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. object Break extends Item with Product with Serializable

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def childrenAreLeaves(n: Node): Boolean

    Attributes
    protected
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. var cur: Int

    Attributes
    protected
  13. def cut(s: String, ind: Int): List[Item]

    Try to cut at whitespace.

    Try to cut at whitespace.

    Attributes
    protected
  14. def endTag(n: Node): String

    Attributes
    protected
  15. def ensuring(cond: (PrettyPrinter) ⇒ Boolean, msg: ⇒ Any): PrettyPrinter

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to Ensuring[PrettyPrinter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (PrettyPrinter) ⇒ Boolean): PrettyPrinter

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to Ensuring[PrettyPrinter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): PrettyPrinter

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to Ensuring[PrettyPrinter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): PrettyPrinter

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to Ensuring[PrettyPrinter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  22. def fits(test: String): Boolean

    Attributes
    protected
  23. def format(n: Node, pscope: NamespaceBinding = null): String

    Returns a formatted string containing well-formed XML with given namespace to prefix mapping.

    Returns a formatted string containing well-formed XML with given namespace to prefix mapping.

    n

    the node to be serialized

    pscope

    the namespace to prefix mapping

    returns

    the formatted string

  24. def format(n: Node, pscope: NamespaceBinding, sb: StringBuilder): Unit

  25. def format(n: Node, sb: StringBuilder): Unit

    Appends a formatted string containing well-formed XML with given namespace to prefix mapping to the given string buffer.

    Appends a formatted string containing well-formed XML with given namespace to prefix mapping to the given string buffer.

    n

    the node to be serialized

    sb

    the stringbuffer to append to

  26. def formatNodes(nodes: Seq[Node], pscope: NamespaceBinding, sb: StringBuilder): Unit

    Appends a formatted string containing well-formed XML with the given namespace to prefix mapping to the given stringbuffer.

    Appends a formatted string containing well-formed XML with the given namespace to prefix mapping to the given stringbuffer.

    nodes

    the nodes to be serialized

    pscope

    the namespace to prefix mapping

    sb

    the string buffer to which to append to

  27. def formatNodes(nodes: Seq[Node], pscope: NamespaceBinding = null): String

    Returns a formatted string containing well-formed XML.

    Returns a formatted string containing well-formed XML.

    nodes

    the sequence of nodes to be serialized

    pscope

    the namespace to prefix mapping

  28. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to StringFormat[PrettyPrinter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  29. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  32. var items: List[Item]

    Attributes
    protected
  33. def leafTag(n: Node): String

    Attributes
    protected
  34. def makeBox(ind: Int, s: String): Unit

    Try to make indented box, if possible, else para.

    Try to make indented box, if possible, else para.

    Attributes
    protected
  35. def makeBreak(): Unit

    Attributes
    protected
  36. def makePara(ind: Int, s: String): Unit

    Attributes
    protected
  37. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  40. def reset(): Unit

    Attributes
    protected
  41. def startTag(n: Node, pscope: NamespaceBinding): (String, Int)

    Attributes
    protected
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  43. def toString(): String

    Definition Classes
    AnyRef → Any
  44. def traverse(it: Iterator[Node], scope: NamespaceBinding, ind: Int): Unit

    Attributes
    protected
  45. def traverse(node: Node, pscope: NamespaceBinding, ind: Int): Unit

    Attributes
    protected
  46. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  49. def [B](y: B): (PrettyPrinter, B)

    Implicit information
    This member is added by an implicit conversion from PrettyPrinter to ArrowAssoc[PrettyPrinter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from PrettyPrinter to StringAdd[PrettyPrinter]

Inherited by implicit conversion StringFormat from PrettyPrinter to StringFormat[PrettyPrinter]

Inherited by implicit conversion Ensuring from PrettyPrinter to Ensuring[PrettyPrinter]

Inherited by implicit conversion ArrowAssoc from PrettyPrinter to ArrowAssoc[PrettyPrinter]

Ungrouped