scala.xml.Utility

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Utility
TokenTests
AnyRef
Any

Visibility

Public
All

Value Members

def != (arg0: AnyRef): Boolean

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

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Attributes
final
Definition Classes
Any
def ## (): Int

Equivalent to x.hashCode except for boxed numeric types.
Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.
returns
a hash value consistent with ==

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

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

Test two objects for equality.
Test two objects for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Attributes
final
Definition Classes
Any
object Escapes extends AnyRef
val SU : Char(\'\032\')

Attributes
final
def appendEscapedQuoted (s: String, sb: StringBuilder): StringBuilder

Appends "s" and escapes and " i s with \"
Appends "s" and escapes and " i s with \"
s
...
sb
...
returns
...
def appendQuoted (s: String, sb: StringBuilder): StringBuilder

Appends "s" if string s does not contain ", 's' otherwise.
Appends "s" if string s does not contain ", 's' otherwise.
s
...
sb
...
returns
...
def appendQuoted (s: String): String
def asInstanceOf [T0] : T0

Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.

Attributes
final
Definition Classes
Any
def checkAttributeValue (value: String): String

Returns null if the value is a correct attribute value, error message if it isn't.
Returns null if the value is a correct attribute value, error message if it isn't.
value
...
returns
...
def checkPubID (s: String): Boolean

Definition Classes
TokenTests
def checkSysID (s: String): Boolean

Definition Classes
TokenTests
def clone (): AnyRef

Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def collectNamespaces (n: Node, set: Set[String]): Unit

Adds all namespaces in node to set.
Adds all namespaces in node to set.
n
...
set
...
def collectNamespaces (nodes: Seq[Node]): Set[String]

Returns a set of all namespaces used in a sequence of nodes and all their descendants, including the empty namespaces.
Returns a set of all namespaces used in a sequence of nodes and all their descendants, including the empty namespaces.
nodes
...
returns
...
def eq (arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.

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

The equality method for reference types.
The equality method for reference types. See equals in Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def escape (text: String, s: StringBuilder): StringBuilder

Appends escaped string to s.
Appends escaped string to s.
text
...
s
...
returns
...

Attributes
final
def escape (text: String): String

Escapes the characters < > & and " from string.
Escapes the characters < > & and " from string.
text
...
returns
...

Attributes
final
def finalize (): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.

Attributes
final
Definition Classes
AnyRef → Any
def getName (s: String, index: Int): String

s
...
index
...
returns
...
def hashCode (pre: String, label: String, attribHashCode: Int, scpeHash: Int, children: Seq[Node]): Int

Returns a hashcode for the given constituents of a node
Returns a hashcode for the given constituents of a node
label
attribHashCode
children
def hashCode (): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in Any.
returns
the hash code value for this object.

Definition Classes
AnyRef → Any
implicit def implicitSbToString (sb: StringBuilder): String

Attributes
implicit
def isAlpha (c: Char): Boolean

These are 99% sure to be redundant but refactoring on the safe side.
These are 99% sure to be redundant but refactoring on the safe side.

Definition Classes
TokenTests
def isAlphaDigit (c: Char): Boolean

Definition Classes
TokenTests
def isInstanceOf [T0] : Boolean

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Attributes
final
Definition Classes
Any
def isName (s: String): Boolean

Name ::= ( Letter | '_' ) (NameChar)*
Name ::= ( Letter | '_' ) (NameChar)*
see [5] of XML 1.0 specification

Definition Classes
TokenTests
def isNameChar (ch: Char): Boolean

NameChar ::= Letter | Digit | '.
NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender
see [4] and Appendix B of XML 1.0 specification

Definition Classes
TokenTests
def isNameStart (ch: Char): Boolean

NameStart ::= ( Letter | '_' ) where Letter means in one of the Unicode general categories { Ll, Lu, Lo, Lt, Nl }
NameStart ::= ( Letter | '_' ) where Letter means in one of the Unicode general categories { Ll, Lu, Lo, Lt, Nl }
We do not allow a name to start with ':'. see [3] and Appendix B of XML 1.0 specification

Definition Classes
TokenTests
def isPubIDChar (ch: Char): Boolean

Definition Classes
TokenTests
def isSpace (cs: Seq[Char]): Boolean

(#x20 | #x9 | #xD | #xA)+
(#x20 | #x9 | #xD | #xA)+

Attributes
final
Definition Classes
TokenTests
def isSpace (ch: Char): Boolean

(#x20 | #x9 | #xD | #xA)
(#x20 | #x9 | #xD | #xA)

Attributes
final
Definition Classes
TokenTests
def isValidIANAEncoding (ianaEncoding: Seq[Char]): Boolean

Returns true if the encoding name is a valid IANA encoding.
Returns true if the encoding name is a valid IANA encoding. This method does not verify that there is a decoder available for this encoding, only that the characters are valid for an IANA encoding name.
ianaEncoding
The IANA encoding name.

Definition Classes
TokenTests
def ne (arg0: AnyRef): Boolean

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def parseAttributeValue (value: String): Seq[Node]

new
new
value
...
returns
...

def parseCharRef (ch: () ⇒ Char, nextch: () ⇒ Unit, reportSyntaxError: (String) ⇒ Unit, reportTruncatedError: (String) ⇒ Unit): String

  CharRef ::= "&#" '0'..'9' {'0'..'9'} ";"
            | "&#x" '0'..'9'|'A'..'F'|'a'..'f' { hexdigit } ";"

  CharRef ::= "&#" '0'..'9' {'0'..'9'} ";"
            | "&#x" '0'..'9'|'A'..'F'|'a'..'f' { hexdigit } ";"

see [66]

ch: ...
nextch: ...
reportSyntaxError: ...
returns: ...

def prefix (name: String): Option[String]

Returns prefix of qualified name if any.
Returns prefix of qualified name if any.
name
...
returns
...

Attributes
final
def sequenceToXML (children: Seq[Node], pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: Boolean = false): Unit
def sort (n: Node): Node

returns the node with its attribute list sorted alphabetically (prefixes are ignored)
def sort (md: MetaData): MetaData

returns a sorted attribute list
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def toString (): String

Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.

Definition Classes
AnyRef → Any
def toXML (x: Node, pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: Boolean = false): StringBuilder
def trim (x: Node): Node

trims an element - call this method, when you know that it is an element (and not a text node) so you know that it will not be trimmed away.
trims an element - call this method, when you know that it is an element (and not a text node) so you know that it will not be trimmed away. With this assumption, the function can return a Node, rather than a Seq[Node]. If you don't know, call trimProper and account for the fact that you may get back an empty sequence of nodes.
precondition: node is not a text node (it might be trimmed)
def trimProper (x: Node): Seq[Node]

trim a child of an element.
trim a child of an element. Attribute values and Atom nodes that are not Text nodes are unaffected.
def unescape (ref: String, s: StringBuilder): StringBuilder

Appends unescaped string to s, amp becomes & lt becomes < etc.
Appends unescaped string to s, amp becomes & lt becomes < etc..
ref
...
s
...
returns
null if ref was not a predefined entity.

Attributes
final
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

Inherited from TokenTests

Value Members

def checkPubID (s: String): Boolean

Definition Classes
TokenTests
def checkSysID (s: String): Boolean

Definition Classes
TokenTests
def isAlpha (c: Char): Boolean

These are 99% sure to be redundant but refactoring on the safe side.
These are 99% sure to be redundant but refactoring on the safe side.

Definition Classes
TokenTests
def isAlphaDigit (c: Char): Boolean

Definition Classes
TokenTests
def isName (s: String): Boolean

Name ::= ( Letter | '_' ) (NameChar)*
Name ::= ( Letter | '_' ) (NameChar)*
see [5] of XML 1.0 specification

Definition Classes
TokenTests
def isNameChar (ch: Char): Boolean

NameChar ::= Letter | Digit | '.
NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender
see [4] and Appendix B of XML 1.0 specification

Definition Classes
TokenTests
def isNameStart (ch: Char): Boolean

NameStart ::= ( Letter | '_' ) where Letter means in one of the Unicode general categories { Ll, Lu, Lo, Lt, Nl }
NameStart ::= ( Letter | '_' ) where Letter means in one of the Unicode general categories { Ll, Lu, Lo, Lt, Nl }
We do not allow a name to start with ':'. see [3] and Appendix B of XML 1.0 specification

Definition Classes
TokenTests
def isPubIDChar (ch: Char): Boolean

Definition Classes
TokenTests
def isSpace (cs: Seq[Char]): Boolean

(#x20 | #x9 | #xD | #xA)+
(#x20 | #x9 | #xD | #xA)+

Attributes
final
Definition Classes
TokenTests
def isSpace (ch: Char): Boolean

(#x20 | #x9 | #xD | #xA)
(#x20 | #x9 | #xD | #xA)

Attributes
final
Definition Classes
TokenTests
def isValidIANAEncoding (ianaEncoding: Seq[Char]): Boolean

Returns true if the encoding name is a valid IANA encoding.
Returns true if the encoding name is a valid IANA encoding. This method does not verify that there is a decoder available for this encoding, only that the characters are valid for an IANA encoding name.
ianaEncoding
The IANA encoding name.

Definition Classes
TokenTests

Inherited from AnyRef

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def ## (): Int

Equivalent to x.hashCode except for boxed numeric types.
Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.
returns
a hash value consistent with ==

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

Attributes
final
Definition Classes
AnyRef
def clone (): AnyRef

Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def eq (arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.

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

The equality method for reference types.
The equality method for reference types. See equals in Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def finalize (): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.

Attributes
final
Definition Classes
AnyRef → Any
def hashCode (): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in Any.
returns
the hash code value for this object.

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

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def toString (): String

Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.

Definition Classes
AnyRef → Any
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

Inherited from Any

Value Members

def != (arg0: Any): Boolean

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Attributes
final
Definition Classes
Any
def == (arg0: Any): Boolean

Test two objects for equality.
Test two objects for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Attributes
final
Definition Classes
Any
def asInstanceOf [T0] : T0

Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.

Attributes
final
Definition Classes
Any
def isInstanceOf [T0] : Boolean

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Attributes
final
Definition Classes
Any

Utility

object Utility extends TokenTests

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

object Escapes extends AnyRef

val SU : Char(\'\032\')

def appendEscapedQuoted (s: String, sb: StringBuilder): StringBuilder

def appendQuoted (s: String, sb: StringBuilder): StringBuilder

def appendQuoted (s: String): String

def asInstanceOf [T0] : T0

def checkAttributeValue (value: String): String

def checkPubID (s: String): Boolean

def checkSysID (s: String): Boolean

def clone (): AnyRef

def collectNamespaces (n: Node, set: Set[String]): Unit

def collectNamespaces (nodes: Seq[Node]): Set[String]

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def escape (text: String, s: StringBuilder): StringBuilder

def escape (text: String): String

def finalize (): Unit

def getClass (): java.lang.Class[_]

def getName (s: String, index: Int): String

def hashCode (pre: String, label: String, attribHashCode: Int, scpeHash: Int, children: Seq[Node]): Int

def hashCode (): Int

implicit def implicitSbToString (sb: StringBuilder): String

def isAlpha (c: Char): Boolean

def isAlphaDigit (c: Char): Boolean

def isInstanceOf [T0] : Boolean

def isName (s: String): Boolean

def isNameChar (ch: Char): Boolean

def isNameStart (ch: Char): Boolean

def isPubIDChar (ch: Char): Boolean

def isSpace (cs: Seq[Char]): Boolean

def isSpace (ch: Char): Boolean

def isValidIANAEncoding (ianaEncoding: Seq[Char]): Boolean

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

def parseAttributeValue (value: String): Seq[Node]

def parseCharRef (ch: () ⇒ Char, nextch: () ⇒ Unit, reportSyntaxError: (String) ⇒ Unit, reportTruncatedError: (String) ⇒ Unit): String

def prefix (name: String): Option[String]

def sequenceToXML (children: Seq[Node], pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: Boolean = false): Unit

def sort (n: Node): Node

def sort (md: MetaData): MetaData

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

def toString (): String

def toXML (x: Node, pscope: NamespaceBinding = TopScope, sb: StringBuilder = new StringBuilder, stripComments: Boolean = false, decodeEntities: Boolean = true, preserveWhitespace: Boolean = false, minimizeTags: Boolean = false): StringBuilder

def trim (x: Node): Node

def trimProper (x: Node): Seq[Node]

def unescape (ref: String, s: StringBuilder): StringBuilder

def wait (): Unit

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

def wait (arg0: Long): Unit

Inherited from TokenTests

Value Members

def checkPubID (s: String): Boolean

def checkSysID (s: String): Boolean

def isAlpha (c: Char): Boolean

def isAlphaDigit (c: Char): Boolean

def isName (s: String): Boolean

def isNameChar (ch: Char): Boolean

def isNameStart (ch: Char): Boolean

def isPubIDChar (ch: Char): Boolean

def isSpace (cs: Seq[Char]): Boolean

def isSpace (ch: Char): Boolean

def isValidIANAEncoding (ianaEncoding: Seq[Char]): Boolean

Inherited from AnyRef

Value Members

def != (arg0: AnyRef): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def clone (): AnyRef

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit