scala.xml.Utility

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Utility
TokenTests
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def == (arg0: AnyRef) : Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
object Escapes extends AnyRef
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

This method is used to cast the receiver object to be of type T0.

This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(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 typed.
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

This method creates and returns a copy of the receiver object.

This method creates and returns 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
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

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other 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).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals (arg0: Any) : Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
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

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected[lang]
definition classes: AnyRef
def getClass () : java.lang.Class[_ <: java.lang.Object]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns 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
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

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the 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

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.
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

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true 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) : String

  CharRef ::= "&amp;#" '0'.
            
  CharRef ::= "&amp;#" '0'..'9' {'0'..'9'} ";"
            | "&amp;#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 = ..., sb: 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)

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

returns a sorted attribute list

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

attributes: final
definition classes: AnyRef
def toString () : String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
def toXML (x: Node, pscope: NamespaceBinding = ..., sb: 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
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef

Utility

object Utility extends TokenTests

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

object Escapes extends AnyRef

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[_ <: java.lang.Object]

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) : String

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

def sequenceToXML (children: Seq[Node], pscope: NamespaceBinding = ..., sb: 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 = ..., sb: 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

Inherited from AnyRef

Inherited from Any