scala.xml

Text

case class Text (_data: String) extends Atom[String] with Product

The class Text implements an XML node for text (PCDATA). It is used in both non-bound and bound XML representations.

go to: companion
linear super types: Product, Atom[String], SpecialNode, XMLEvent, Node, NodeSeq, Equality, Seq[Node], Seq[Node], SeqLike[Node, NodeSeq], PartialFunction[Int, Node], (Int) ⇒ Node, Iterable[Node], Iterable[Node], IterableLike[Node, NodeSeq], Equals, Traversable[Node], Immutable, Traversable[Node], GenericTraversableTemplate[Node, Seq], TraversableLike[Node, NodeSeq], TraversableOnce[Node], FilterMonadic[Node, NodeSeq], HasNewBuilder[Node, NodeSeq], AnyRef, Any
source: Text.scala
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Text
  2. Product
  3. Atom
  4. SpecialNode
  5. XMLEvent
  6. Node
  7. NodeSeq
  8. Equality
  9. Seq
  10. Seq
  11. SeqLike
  12. PartialFunction
  13. Function1
  14. Iterable
  15. Iterable
  16. IterableLike
  17. Equals
  18. Traversable
  19. Immutable
  20. Traversable
  21. GenericTraversableTemplate
  22. TraversableLike
  23. TraversableOnce
  24. FilterMonadic
  25. HasNewBuilder
  26. AnyRef
  27. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new Text (_data: String)

Type Members

  1. type Self = NodeSeq

    The type implementing this traversable

    The type implementing this traversable

    attributes: protected
    definition classes: TraversableLike
  2. class WithFilter extends FilterMonadic[A, Repr]

    A class supporting filtered operations.

Value Members

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

    attributes: final
    definition classes: AnyRef
  2. 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
  3. def ## () : Int

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

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

    attributes: final
    definition classes: AnyRef
  6. def ++ (that: TraversableOnce[Node]) : immutable.Seq[Node]

    [use case] Concatenates this immutable sequence with the elements of a traversable collection.

    [use case]

    Concatenates this immutable sequence with the elements of a traversable collection.

    that

    the traversable to append.

    returns

    a new immutable sequence which contains all elements of this immutable sequence followed by all elements of that.

    attributes: abstract
    definition classes: TraversableLike
  7. def ++ [B >: A, That] (that: TraversableOnce[B])(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Concatenates this immutable sequence with the elements of a traversable collection.

    Concatenates this immutable sequence with the elements of a traversable collection.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the traversable to append.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That which contains all elements of this immutable sequence followed by all elements of that.

    definition classes: TraversableLike
  8. def +: (elem: Node) : immutable.Seq[Node]

    [use case] Prepends an element to this immutable sequence

    [use case]

    Prepends an element to this immutable sequence

    elem

    the prepended element

    returns

    a new immutable sequence consisting of elem followed by all elements of this immutable sequence.

    attributes: abstract
    definition classes: SeqLike
  9. def +: [B >: A, That] (elem: B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Prepends an element to this immutable sequence

    Prepends an element to this immutable sequence

    B

    the element type of the returned immutable sequence.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    elem

    the prepended element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That consisting of elem followed by all elements of this immutable sequence.

    definition classes: SeqLike
  10. def /: [B] (z: B)(op: (B, Node) ⇒ B) : B

    Applies a binary operator to a start value and all elements of this immutable sequence, going left to right.

    Applies a binary operator to a start value and all elements of this immutable sequence, going left to right.

    Note: /: is alternate syntax for foldLeft; z /: xs is the same as xs foldLeft z.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable sequence, going left to right with the start value z on the left: op(...op(op(z, x1), x2), ..., xn) where x,,1,,, ..., x,,n,, are the elements of this immutable sequence.

    definition classes: TraversableOnce
  11. def :+ (elem: Node) : immutable.Seq[Node]

    [use case] Appends an element to this immutable sequence

    [use case]

    Appends an element to this immutable sequence

    Note: will not terminate for infinite-sized collections.

    elem

    the appended element

    returns

    a new immutable sequence consisting of all elements of this immutable sequence followed by elem.

    attributes: abstract
    definition classes: SeqLike
  12. def :+ [B >: A, That] (elem: B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Appends an element to this immutable sequence

    Appends an element to this immutable sequence

    Note: will not terminate for infinite-sized collections.

    B

    the element type of the returned immutable sequence.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    elem

    the appended element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That consisting of all elements of this immutable sequence followed by elem.

    definition classes: SeqLike
  13. def :\ [B] (z: B)(op: (Node, B) ⇒ B) : B

    Applies a binary operator to all elements of this immutable sequence and a start value, going right to left.

    Applies a binary operator to all elements of this immutable sequence and a start value, going right to left.

    Note: :\ is alternate syntax for foldRight; xs :\ z is the same as xs foldRight z.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    z

    the start value

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this immutable sequence, going right to left with the start value z on the right: op(x1, op(x2, ... op(xn, z)...)) where x,,1,,, ..., x,,n,, are the elements of this immutable sequence.

    definition classes: TraversableOnce
  14. 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
  15. 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
  16. def \ (that: String) : NodeSeq

    Projection function, which returns elements of this sequence based on the string that.

    Projection function, which returns elements of this sequence based on the string that. Use:

    • this \ "foo" to get a list of all elements that are labelled with "foo";
    • \ "_" to get a list of all elements (wildcard);
    • ns \ "@foo" to get the unprefixed attribute "foo";
    • ns \ "@{uri}foo" to get the prefixed attribute "pre:foo" whose prefix "pre" is resolved to the namespace "uri".

    For attribute projections, the resulting NodeSeq attribute values are wrapped in a Group.

    There is no support for searching a prefixed attribute by its literal prefix.

    The document order is preserved.

    that

    ...

    returns

    ...

    definition classes: NodeSeq
  17. def \\ (that: String) : NodeSeq

    Projection function, which returns elements of this sequence and of all its subsequences, based on the string that.

    Projection function, which returns elements of this sequence and of all its subsequences, based on the string that. Use:

    • this \\ 'foo to get a list of all elements that are labelled with "foo";
    • \\ "_" to get a list of all elements (wildcard);
    • ns \\ "@foo" to get the unprefixed attribute "foo";
    • ns \\ "@{uri}foo" to get each prefixed attribute "pre:foo" whose prefix "pre" is resolved to the namespace "uri".

    For attribute projections, the resulting NodeSeq attribute values are wrapped in a Group.

    There is no support for searching a prefixed attribute by its literal prefix.

    The document order is preserved.

    that

    ...

    returns

    ...

    definition classes: NodeSeq
  18. val _data : String

  19. def addString (b: StringBuilder) : StringBuilder

    Appends all elements of this immutable sequence to a string builder.

    Appends all elements of this immutable sequence to a string builder. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable sequence without any separator string.

    b

    the string builder to which elements are appended.

    returns

    the string builder b to which elements were appended.

    definition classes: TraversableOnce
  20. def addString (b: StringBuilder, sep: String) : StringBuilder

    Appends all elements of this immutable sequence to a string builder using a separator string.

    Appends all elements of this immutable sequence to a string builder using a separator string. The written text consists of the string representations (w.r.t. the method toString) of all elements of this immutable sequence, separated by the string sep.

    b

    the string builder to which elements are appended.

    sep

    the separator string.

    returns

    the string builder b to which elements were appended.

    definition classes: TraversableOnce
  21. def addString (b: StringBuilder, start: String, sep: String, end: String) : StringBuilder

    Appends all elements of this immutable sequence to a string builder using start, end, and separator strings.

    Appends all elements of this immutable sequence to a string builder using start, end, and separator strings. The written text begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this immutable sequence are separated by the string sep.

    b

    the string builder to which elements are appended.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    the string builder b to which elements were appended.

    definition classes: TraversableOnce
  22. def andThen [C] (k: (Node) ⇒ C) : PartialFunction[Int, C]

    Composes this partial function with a transformation function that gets applied to results of this partial function.

    Composes this partial function with a transformation function that gets applied to results of this partial function.

    C

    the result type of the transformation function.

    k

    the transformation function

    returns

    a partial function with the same domain as this partial function, which maps arguments x to k(this(x)).

    definition classes: PartialFunctionFunction1
  23. def apply (f: (Node) ⇒ Boolean) : NodeSeq

    definition classes: NodeSeq
  24. def apply (i: Int) : Node

    Selects an element by its index in the immutable sequence.

    Selects an element by its index in the immutable sequence.

    returns

    the element of this immutable sequence at index idx, where 0 indicates the first element.

    definition classes: NodeSeqSeqLikeFunction1
  25. 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
  26. def attribute (uri: String, key: String) : Option[Seq[Node]]

    Convenience method, looks up a prefixed attribute in attributes of this node.

    Convenience method, looks up a prefixed attribute in attributes of this node. Same as attributes.getValue(uri, this, key)

    uri

    namespace of queried attribute (may not be null).

    key

    of queried attribute.

    returns

    value of PrefixedAttribute with given namespace and given key, otherwise null.

    attributes: final
    definition classes: Node
  27. def attribute (key: String) : Option[Seq[Node]]

    Convenience method, looks up an unprefixed attribute in attributes of this node.

    Convenience method, looks up an unprefixed attribute in attributes of this node. Same as attributes.getValue(key)

    key

    of queried attribute.

    returns

    value of UnprefixedAttribute with given key in attributes, if it exists, otherwise null.

    attributes: final
    definition classes: Node
  28. def attributes : Null

    always empty@return all attributes of this node

    always empty@return all attributes of this node

    attributes: final
    definition classes: SpecialNodeNode
  29. def basisForHashCode : Seq[Any]

    definition classes: AtomNodeNodeSeq → Equality
  30. def buildString (sb: StringBuilder) : StringBuilder

    Returns text, with some characters escaped according to the XML specification.

    Returns text, with some characters escaped according to the XML specification.

    sb

    ...

    returns

    ...

    definition classes: TextAtomSpecialNode
  31. def buildString (stripComments: Boolean) : String

    String representation of this node

    String representation of this node

    returns

    ...

    definition classes: Node
  32. def canEqual (other: Any) : Boolean

    We insist we're only equal to other xml.

    We insist we're only equal to other xml.Equality implementors, which heads off a lot of inconsistency up front.

    definition classes: AtomNodeNodeSeq → Equality → IterableLikeEquals
  33. def child : Nil

    always empty@return all children of this node

    always empty@return all children of this node

    attributes: final
    definition classes: SpecialNodeNode
  34. 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
    definition classes: AnyRef
  35. def collect [B] (pf: PartialFunction[Node, B]) : immutable.Seq[B]

    [use case] Builds a new collection by applying a partial function to all elements of this immutable sequence on which the function is defined.

    [use case]

    Builds a new collection by applying a partial function to all elements of this immutable sequence on which the function is defined.

    B

    the element type of the returned collection.

    pf

    the partial function which filters and maps the immutable sequence.

    returns

    a new immutable sequence resulting from applying the given partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

    attributes: abstract
    definition classes: TraversableLike
  36. def collect [B, That] (pf: PartialFunction[Node, B])(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Builds a new collection by applying a partial function to all elements of this immutable sequence on which the function is defined.

    Builds a new collection by applying a partial function to all elements of this immutable sequence on which the function is defined.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    pf

    the partial function which filters and maps the immutable sequence.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That resulting from applying the partial function pf to each element on which it is defined and collecting the results. The order of the elements is preserved.

    definition classes: TraversableLike
  37. def companion : GenericCompanion[Seq]

    The factory companion object that builds instances of class immutable.

    The factory companion object that builds instances of class immutable.Seq. (or its Iterable superclass where class immutable.Seq is not a Seq.)

    definition classes: SeqSeqIterableIterableTraversableTraversableGenericTraversableTemplate
  38. def compose [A] (g: (A) ⇒ Int) : (A) ⇒ Node

    (f compose g)(x) == f(g(x))

    (f compose g)(x) == f(g(x))

    definition classes: Function1
  39. def contains (elem: Any) : Boolean

    Tests whether this immutable sequence contains a given value as an element.

    Tests whether this immutable sequence contains a given value as an element.

    Note: may not terminate for infinite-sized collections.

    elem

    the element to test.

    returns

    true if this immutable sequence has an element that is is equal (wrt ==) to elem, false otherwise.

    definition classes: SeqLike
  40. def containsSlice [B] (that: Seq[B]) : Boolean

    Tests whether this immutable sequence contains a given sequence as a slice.

    Tests whether this immutable sequence contains a given sequence as a slice.

    Note: may not terminate for infinite-sized collections.

    that

    the sequence to test

    returns

    true if this immutable sequence contains a slice with the same elements as that, otherwise false.

    definition classes: SeqLike
  41. def copyToArray (xs: Array[Node], start: Int, len: Int) : Unit

    [use case] Copies elements of this immutable sequence to an array.

    [use case]

    Copies elements of this immutable sequence to an array. Fills the given array xs with at most len elements of this immutable sequence, starting at position start. Copying will stop once either the end of the current immutable sequence is reached, or the end of the array is reached, or len elements have been copied.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    attributes: abstract
    definition classes: TraversableLike
  42. def copyToArray [B >: A] (xs: Array[B], start: Int, len: Int) : Unit

    Copies elements of this immutable sequence to an array.

    Copies elements of this immutable sequence to an array. Fills the given array xs with at most len elements of this immutable sequence, starting at position start. Copying will stop once either the end of the current immutable sequence is reached, or the end of the array is reached, or len elements have been copied.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index.

    len

    the maximal number of elements to copy.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  43. def copyToArray (xs: Array[Node]) : Unit

    [use case] Copies values of this immutable sequence to an array.

    [use case]

    Copies values of this immutable sequence to an array. Fills the given array xs with values of this immutable sequence. Copying will stop once either the end of the current immutable sequence is reached, or the end of the array is reached.

    xs

    the array to fill.

    attributes: abstract
    definition classes: TraversableOnce
  44. def copyToArray [B >: A] (xs: Array[B]) : Unit

    Copies values of this immutable sequence to an array.

    Copies values of this immutable sequence to an array. Fills the given array xs with values of this immutable sequence. Copying will stop once either the end of the current immutable sequence is reached, or the end of the array is reached.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    definition classes: TraversableOnce
  45. def copyToArray (xs: Array[Node], start: Int) : Unit

    [use case] Copies values of this immutable sequence to an array.

    [use case]

    Copies values of this immutable sequence to an array. Fills the given array xs with values of this immutable sequence, after skipping start values. Copying will stop once either the end of the current immutable sequence is reached, or the end of the array is reached.

    xs

    the array to fill.

    start

    the starting index.

    attributes: abstract
    definition classes: TraversableOnce
  46. def copyToArray [B >: A] (xs: Array[B], start: Int) : Unit

    Copies values of this immutable sequence to an array.

    Copies values of this immutable sequence to an array. Fills the given array xs with values of this immutable sequence, after skipping start values. Copying will stop once either the end of the current immutable sequence is reached, or the end of the array is reached.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array.

    xs

    the array to fill.

    start

    the starting index.

    definition classes: TraversableOnce
  47. def copyToBuffer [B >: A] (dest: Buffer[B]) : Unit

    Copies all elements of this immutable sequence to a buffer.

    Copies all elements of this immutable sequence to a buffer.

    Note: will not terminate for infinite-sized collections.

    dest

    The buffer to which elements are copied.

    definition classes: TraversableOnce
  48. def corresponds [B] (that: Seq[B])(p: (Node, B) ⇒ Boolean) : Boolean

    Tests whether every element of this immutable sequence relates to the corresponding element of another sequence by satisfying a test predicate.

    Tests whether every element of this immutable sequence relates to the corresponding element of another sequence by satisfying a test predicate.

    B

    the type of the elements of that

    that

    the other sequence

    p

    the test predicate, which relates elements from both sequences

    returns

    true if both sequences have the same length and p(x, y) is true for all corresponding elements x of this immutable sequence and y of that, otherwise false.

    definition classes: SeqLike
  49. def count (p: (Node) ⇒ Boolean) : Int

    Counts the number of elements in the immutable sequence which satisfy a predicate.

    Counts the number of elements in the immutable sequence which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

    definition classes: TraversableOnce
  50. val data : String

    definition classes: Atom
  51. def descendant : List[Node]

    Descendant axis (all descendants of this node, not including node itself) includes all text nodes, element nodes, comments and processing instructions.

    Descendant axis (all descendants of this node, not including node itself) includes all text nodes, element nodes, comments and processing instructions.

    definition classes: Node
  52. def descendant_or_self : List[Node]

    Descendant axis (all descendants of this node, including thisa node) includes all text nodes, element nodes, comments and processing instructions.

    Descendant axis (all descendants of this node, including thisa node) includes all text nodes, element nodes, comments and processing instructions.

    definition classes: Node
  53. def diff (that: Seq[Node]) : immutable.Seq[Node]

    [use case] Computes the multiset difference between this immutable sequence and another sequence.

    [use case]

    Computes the multiset difference between this immutable sequence and another sequence.

    Note: will not terminate for infinite-sized collections.

    that

    the sequence of elements to remove

    returns

    a new immutable sequence which contains all elements of this immutable sequence except some of occurrences of elements that also appear in that. If an element value x appears n times in that, then the first n occurrences of x will not form part of the result, but any following occurrences will.

    attributes: abstract
    definition classes: SeqLike
  54. def diff [B >: A] (that: Seq[B]) : NodeSeq

    Computes the multiset difference between this immutable sequence and another sequence.

    Computes the multiset difference between this immutable sequence and another sequence.

    Note: will not terminate for infinite-sized collections.

    B

    the element type of the returned immutable sequence.

    that

    the sequence of elements to remove

    returns

    a new collection of type That which contains all elements of this immutable sequence except some of occurrences of elements that also appear in that. If an element value x appears n times in that, then the first n occurrences of x will not form part of the result, but any following occurrences will.

    definition classes: SeqLike
  55. def distinct : NodeSeq

    Builds a new immutable sequence from this immutable sequence without any duplicate elements.

    Builds a new immutable sequence from this immutable sequence without any duplicate elements.

    Note: will not terminate for infinite-sized collections.

    returns

    A new immutable sequence which contains the first occurrence of every element of this immutable sequence.

    definition classes: SeqLike
  56. def doCollectNamespaces : Boolean

    The logic formerly found in typeTag$, as best I could infer it.

    The logic formerly found in typeTag$, as best I could infer it.

    attributes: final
    definition classes: AtomNode
  57. def doTransform : Boolean

    attributes: final
    definition classes: AtomNode
  58. def drop (n: Int) : NodeSeq

    Selects all elements except first n ones.

    Selects all elements except first n ones.

    n

    the number of elements to drop from this immutable sequence.

    returns

    a immutable sequence consisting of all elements of this immutable sequence except the first n ones, or else the empty immutable sequence, if this immutable sequence has less than n elements.

    definition classes: TraversableLike
  59. def dropRight (n: Int) : NodeSeq

    Selects all elements except last n ones.

    Selects all elements except last n ones.

    n

    The number of elements to take

    returns

    a immutable sequence consisting of all elements of this immutable sequence except the first n ones, or else the empty immutable sequence, if this immutable sequence has less than n elements.

    definition classes: IterableLike
  60. def dropWhile (p: (Node) ⇒ Boolean) : NodeSeq

    Drops longest prefix of elements that satisfy a predicate.

    Drops longest prefix of elements that satisfy a predicate.

    p

    The predicate used to test elements.

    returns

    the longest suffix of this immutable sequence whose first element does not satisfy the predicate p.

    definition classes: TraversableLike
  61. def elements : Iterator[Node]

    definition classes: IterableLike
      deprecated:
    1. use iterator' instead

  62. def endsWith [B] (that: Seq[B]) : Boolean

    Tests whether this immutable sequence ends with the given sequence.

    Tests whether this immutable sequence ends with the given sequence.

    Note: will not terminate for infinite-sized collections.

    that

    the sequence to test

    returns

    true if this immutable sequence has that as a suffix, false otherwise.

    definition classes: SeqLike
  63. 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
  64. def equals (other: Any) : Boolean

    The equality method defined in AnyRef.

    The equality method defined in AnyRef.@return true if the receiver object is equivalent to the argument; false otherwise. */

    definition classes: Equality → Equals → AnyRef → Any
  65. def equalsWith [B] (that: Seq[B])(f: (Node, B) ⇒ Boolean) : Boolean

    Tests whether every element of this immutable sequence relates to the corresponding element of another sequence by satisfying a test predicate.

    Tests whether every element of this immutable sequence relates to the corresponding element of another sequence by satisfying a test predicate.

    B

    the type of the elements of that

    that

    the other sequence

    returns

    true if both sequences have the same length and p(x, y) is true for all corresponding elements x of this immutable sequence and y of that, otherwise false.

    definition classes: SeqLike
      deprecated:
    1. use corresponds instead

  66. def exists (p: (Node) ⇒ Boolean) : Boolean

    Tests whether a predicate holds for some of the elements of this immutable sequence.

    Tests whether a predicate holds for some of the elements of this immutable sequence.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for some of the elements of this immutable sequence, otherwise false.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  67. def filter (p: (Node) ⇒ Boolean) : NodeSeq

    Selects all elements of this immutable sequence which satisfy a predicate.

    Selects all elements of this immutable sequence which satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    a new immutable sequence consisting of all elements of this immutable sequence that satisfy the given predicate p. The order of the elements is preserved.

    definition classes: TraversableLike
  68. def filterNot (p: (Node) ⇒ Boolean) : NodeSeq

    Selects all elements of this immutable sequence which do not satisfy a predicate.

    Selects all elements of this immutable sequence which do not satisfy a predicate.

    p

    the predicate used to test elements.

    returns

    a new immutable sequence consisting of all elements of this immutable sequence that do not satisfy the given predicate p. The order of the elements is preserved.

    definition classes: TraversableLike
  69. 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
    definition classes: AnyRef
  70. def find (p: (Node) ⇒ Boolean) : Option[Node]

    Finds the first element of the immutable sequence satisfying a predicate, if any.

    Finds the first element of the immutable sequence satisfying a predicate, if any.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    an option value containing the first element in the immutable sequence that satisfies p, or None if none exists.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  71. def findIndexOf (p: (Node) ⇒ Boolean) : Int

    Returns index of the first element satisfying a predicate, or -1.

    Returns index of the first element satisfying a predicate, or -1.

    definition classes: SeqLike
  72. def findLastIndexOf (p: (Node) ⇒ Boolean) : Int

    Returns index of the last element satisfying a predicate, or -1.

    Returns index of the last element satisfying a predicate, or -1.

    definition classes: SeqLike
      deprecated:
    1. use lastIndexWhere instead

  73. def first : Node

    definition classes: IterableLike
      deprecated:
    1. use head' instead

  74. def firstOption : Option[Node]

    None if iterable is empty.

    None if iterable is empty.

    definition classes: IterableLike
      deprecated:
    1. use headOption' instead

  75. def flatMap [B] (f: (Node) ⇒ Traversable[B]) : immutable.Seq[B]

    [use case] Builds a new collection by applying a function to all elements of this immutable sequence and concatenating the results.

    [use case]

    Builds a new collection by applying a function to all elements of this immutable sequence and concatenating the results.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new immutable sequence resulting from applying the given collection-valued function f to each element of this immutable sequence and concatenating the results.

    attributes: abstract
    definition classes: TraversableLike
  76. def flatMap [B, That] (f: (Node) ⇒ Traversable[B])(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Builds a new collection by applying a function to all elements of this immutable sequence and concatenating the results.

    Builds a new collection by applying a function to all elements of this immutable sequence and concatenating the results.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That resulting from applying the given collection-valued function f to each element of this immutable sequence and concatenating the results.

    definition classes: TraversableLikeFilterMonadic
  77. def flatten [B] : immutable.Seq[B]

    [use case] Converts this immutable sequence of traversable collections into a immutable sequence in which all element collections are concatenated.

    [use case]

    Converts this immutable sequence of traversable collections into a immutable sequence in which all element collections are concatenated.

    B

    the type of the elements of each traversable collection.

    returns

    a new immutable sequence resulting from concatenating all element immutable sequences.

    attributes: abstract
    definition classes: GenericTraversableTemplate
  78. def flatten [B] (implicit asTraversable: (Node) ⇒ Traversable[B]) : Seq[B]

    Converts this immutable sequence of traversable collections into a immutable sequence in which all element collections are concatenated.

    Converts this immutable sequence of traversable collections into a immutable sequence in which all element collections are concatenated.

    B

    the type of the elements of each traversable collection.

    asTraversable

    an implicit conversion which asserts that the element type of this immutable sequence is a Traversable.

    returns

    a new immutable sequence resulting from concatenating all element immutable sequences.

    definition classes: GenericTraversableTemplate
  79. def foldLeft [B] (z: B)(op: (B, Node) ⇒ B) : B

    Applies a binary operator to a start value and all elements of this immutable sequence, going left to right.

    Applies a binary operator to a start value and all elements of this immutable sequence, going left to right.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable sequence, going left to right with the start value z on the left: op(...op(z, x1), x2, ..., xn) where x,,1,,, ..., x,,n,, are the elements of this immutable sequence.

    definition classes: TraversableOnce
  80. def foldRight [B] (z: B)(op: (Node, B) ⇒ B) : B

    Applies a binary operator to all elements of this immutable sequence and a start value, going right to left.

    Applies a binary operator to all elements of this immutable sequence and a start value, going right to left.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    z

    the start value.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable sequence, going right to left with the start value z on the right: op(x1, op(x2, ... op(xn, z)...)) where x,,1,,, ..., x,,n,, are the elements of this immutable sequence.

    definition classes: IterableLikeTraversableOnce
  81. def forall (p: (Node) ⇒ Boolean) : Boolean

    Tests whether a predicate holds for all elements of this immutable sequence.

    Tests whether a predicate holds for all elements of this immutable sequence.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    true if the given predicate p holds for all elements of this immutable sequence, otherwise false.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  82. def foreach (f: (Node) ⇒ Unit) : Unit

    [use case] Applies a function f to all elements of this immutable sequence.

    [use case]

    Applies a function f to all elements of this immutable sequence.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    attributes: abstract
    definition classes: IterableLike
  83. def foreach [U] (f: (Node) ⇒ U) : Unit

    Applies a function f to all elements of this immutable sequence.

    Applies a function f to all elements of this immutable sequence.

    Note: this method underlies the implementation of most other bulk operations. Subclasses should re-implement this method if a more efficient implementation exists.

    U

    the type parameter describing the result of function f. This result will always be ignored. Typically U is Unit, but this is not necessary.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    definition classes: IterableLikeTraversableLikeTraversableOnceFilterMonadic
  84. def genericBuilder [B] : Builder[B, Seq[B]]

    The generic builder that builds instances of immutable.

    The generic builder that builds instances of immutable.Seq at arbitrary element types.

    definition classes: GenericTraversableTemplate
  85. 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
  86. def getNamespace (pre: String) : String

    Convenience method, same as scope.getURI(pre) but additionally checks if scope is null.

    Convenience method, same as scope.getURI(pre) but additionally checks if scope is null.

    pre

    the prefix whose namespace name we would like to obtain

    returns

    the namespace if scope != null and prefix was found, else null

    definition classes: Node
  87. def groupBy [K] (f: (Node) ⇒ K) : Map[K, NodeSeq]

    Partitions this immutable sequence into a map of immutable sequences according to some discriminator function.

    Partitions this immutable sequence into a map of immutable sequences according to some discriminator function.

    Note: this method is not re-implemented by views. This means when applied to a view it will always force the view and return a new immutable sequence.

    K

    the type of keys returned by the discriminator function.

    f

    the discriminator function.

    returns

    A map from keys to immutable sequences such that the following invariant holds: (xs partition f)(k) = xs filter (x => f(x) == k) That is, every key k is bound to a immutable sequence of those elements x for which f(x) equals k.

    definition classes: TraversableLike
  88. def grouped (size: Int) : Iterator[NodeSeq]

    Partitions elements in fixed size immutable sequences.

    Partitions elements in fixed size immutable sequences.

    size

    the number of elements per group

    returns

    An iterator producing immutable sequences of size size, except the last will be truncated if the elements don't divide evenly.

    definition classes: IterableLike
      see also:
    1. Iterator#grouped

  89. def hasDefiniteSize : Boolean

    Tests whether this immutable sequence is known to have a finite size.

    Tests whether this immutable sequence is known to have a finite size. All strict collections are known to have finite size. For a non-strict collection such as Stream, the predicate returns true if all elements have been computed. It returns false if the stream is not yet evaluated to the end.

    Note: many collection methods will not work on collections of infinite sizes.

    returns

    true if this collection is known to have finite size, false otherwise.

    definition classes: TraversableLikeTraversableOnce
  90. def hashCode () : Int

    It's be nice to make these final, but there are probably people out there subclassing the XML types, especially when it comes to equals.

    It's be nice to make these final, but there are probably people out there subclassing the XML types, especially when it comes to equals. However WE at least can pretend they are final since clearly individual classes cannot be trusted to maintain a semblance of order.@return the hash code value for the object. */

    definition classes: Equality → AnyRef → Any
  91. def head : Node

    Selects the first element of this immutable sequence.

    Selects the first element of this immutable sequence.

    returns

    the first element of this immutable sequence.

    definition classes: IterableLikeTraversableLike
  92. def headOption : Option[Node]

    Optionally selects the first element.

    Optionally selects the first element.

    returns

    the first element of this immutable sequence if it is nonempty, None if it is empty.

    definition classes: TraversableLike
  93. def indexOf (elem: Node, from: Int) : Int

    [use case] Finds index of first occurrence of some value in this immutable sequence after or at some start index.

    [use case]

    Finds index of first occurrence of some value in this immutable sequence after or at some start index.

    elem

    the element value to search for.

    from

    the start index

    returns

    the index >= from of the first element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    attributes: abstract
    definition classes: SeqLike
  94. def indexOf [B >: A] (elem: B, from: Int) : Int

    Finds index of first occurrence of some value in this immutable sequence after or at some start index.

    Finds index of first occurrence of some value in this immutable sequence after or at some start index.

    Note: may not terminate for infinite-sized collections.

    B

    the type of the element elem.

    elem

    the element value to search for.

    from

    the start index

    returns

    the index >= from of the first element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    definition classes: SeqLike
  95. def indexOf (elem: Node) : Int

    [use case] Finds index of first occurrence of some value in this immutable sequence.

    [use case]

    Finds index of first occurrence of some value in this immutable sequence.

    elem

    the element value to search for.

    returns

    the index of the first element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    attributes: abstract
    definition classes: SeqLike
  96. def indexOf [B >: A] (elem: B) : Int

    Finds index of first occurrence of some value in this immutable sequence.

    Finds index of first occurrence of some value in this immutable sequence.

    Note: may not terminate for infinite-sized collections.

    B

    the type of the element elem.

    elem

    the element value to search for.

    returns

    the index of the first element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    definition classes: SeqLike
  97. def indexOfSlice [B >: A] (that: Seq[B], from: Int) : Int

    Finds first index after or at a start index where this immutable sequence contains a given sequence as a slice.

    Finds first index after or at a start index where this immutable sequence contains a given sequence as a slice.

    Note: may not terminate for infinite-sized collections.

    that

    the sequence to test

    from

    the start index

    returns

    the first index >= from such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 of no such subsequence exists.

    definition classes: SeqLike
  98. def indexOfSlice [B >: A] (that: Seq[B]) : Int

    Finds first index where this immutable sequence contains a given sequence as a slice.

    Finds first index where this immutable sequence contains a given sequence as a slice.

    Note: may not terminate for infinite-sized collections.

    that

    the sequence to test

    returns

    the first index such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 of no such subsequence exists.

    definition classes: SeqLike
  99. def indexWhere (p: (Node) ⇒ Boolean, from: Int) : Int

    Finds index of the first element satisfying some predicate after or at some start index.

    Finds index of the first element satisfying some predicate after or at some start index.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    from

    the start index

    returns

    the index >= from of the first element of this immutable sequence that satisfies the predicate p, or -1, if none exists.

    definition classes: SeqLike
  100. def indexWhere (p: (Node) ⇒ Boolean) : Int

    Finds index of first element satisfying some predicate.

    Finds index of first element satisfying some predicate.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    the index of the first element of this immutable sequence that satisfies the predicate p, or -1, if none exists.

    definition classes: SeqLike
  101. def indices : Range

    Produces the range of all indices of this sequence.

    Produces the range of all indices of this sequence.

    returns

    a Range value from 0 to one less than the length of this immutable sequence.

    definition classes: SeqLike
  102. def init : NodeSeq

    Selects all elements except the last.

    Selects all elements except the last.

    returns

    a immutable sequence consisting of all elements of this immutable sequence except the last one.

    definition classes: TraversableLike
  103. def intersect (that: Seq[Node]) : immutable.Seq[Node]

    [use case] Computes the multiset intersection between this immutable sequence and another sequence.

    [use case]

    Computes the multiset intersection between this immutable sequence and another sequence.

    Note: may not terminate for infinite-sized collections.

    that

    the sequence of elements to intersect with.

    returns

    a new immutable sequence which contains all elements of this immutable sequence which also appear in that. If an element value x appears n times in that, then the first n occurrences of x will be retained in the result, but any following occurrences will be omitted.

    attributes: abstract
    definition classes: SeqLike
  104. def intersect [B >: A] (that: Seq[B]) : NodeSeq

    Computes the multiset intersection between this immutable sequence and another sequence.

    Computes the multiset intersection between this immutable sequence and another sequence.

    Note: may not terminate for infinite-sized collections.

    B

    the element type of the returned immutable sequence.

    that

    the sequence of elements to intersect with.

    returns

    a new collection of type That which contains all elements of this immutable sequence which also appear in that. If an element value x appears n times in that, then the first n occurrences of x will be retained in the result, but any following occurrences will be omitted.

    definition classes: SeqLike
  105. def isAtom : Boolean

    used internally.

    used internally. Atom/Molecule = -1 PI = -2 Comment = -3 EntityRef = -5

    definition classes: Node
  106. def isDefinedAt (idx: Int) : Boolean

    Tests whether this immutable sequence contains given index.

    Tests whether this immutable sequence contains given index.

    The implementations of methods apply and isDefinedAt turn a Seq[A] into a PartialFunction[Int, A].

    idx

    the index to test

    returns

    true if this immutable sequence contains an element at position idx, false otherwise.

    definition classes: SeqLike
  107. def isEmpty : Boolean

    Tests whether this immutable sequence is empty.

    Tests whether this immutable sequence is empty.

    returns

    true if the immutable sequence contain no elements, false otherwise.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  108. 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
  109. def isTraversableAgain : Boolean

    Tests whether this immutable sequence can be repeatedly traversed.

    Tests whether this immutable sequence can be repeatedly traversed.

    returns

    true

    attributes: final
    definition classes: TraversableLikeTraversableOnce
  110. def iterator : Iterator[Node]

    Creates a new iterator over all elements contained in this iterable object.

    Creates a new iterator over all elements contained in this iterable object.

    returns

    the new iterator

    definition classes: NodeSeqIterableLike
  111. def label : String

    label of this node.

    label of this node. I.e. "foo" for &lt;foo/&gt;)

    definition classes: AtomNode
  112. def last : Node

    Selects the last element.

    Selects the last element.

    returns

    The last element of this immutable sequence.

    definition classes: TraversableLike
  113. def lastIndexOf (elem: Node, end: Int) : Int

    [use case] Finds index of last occurrence of some value in this immutable sequence before or at a given end index.

    [use case]

    Finds index of last occurrence of some value in this immutable sequence before or at a given end index.

    elem

    the element value to search for.

    end

    the end index.

    returns

    the index <= end of the last element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    attributes: abstract
    definition classes: SeqLike
  114. def lastIndexOf [B >: A] (elem: B, end: Int) : Int

    Finds index of last occurrence of some value in this immutable sequence before or at a given end index.

    Finds index of last occurrence of some value in this immutable sequence before or at a given end index.

    B

    the type of the element elem.

    elem

    the element value to search for.

    end

    the end index.

    returns

    the index <= end of the last element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    definition classes: SeqLike
  115. def lastIndexOf (elem: Node) : Int

    [use case] Finds index of last occurrence of some value in this immutable sequence.

    [use case]

    Finds index of last occurrence of some value in this immutable sequence.

    elem

    the element value to search for.

    returns

    the index of the last element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    attributes: abstract
    definition classes: SeqLike
  116. def lastIndexOf [B >: A] (elem: B) : Int

    Finds index of last occurrence of some value in this immutable sequence.

    Finds index of last occurrence of some value in this immutable sequence.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the element elem.

    elem

    the element value to search for.

    returns

    the index of the last element of this immutable sequence that is equal (wrt ==) to elem, or -1, if none exists.

    definition classes: SeqLike
  117. def lastIndexOfSlice [B >: A] (that: Seq[B], end: Int) : Int

    Finds last index before or at a given end index where this immutable sequence contains a given sequence as a slice.

    Finds last index before or at a given end index where this immutable sequence contains a given sequence as a slice.

    that

    the sequence to test

    end

    the end index

    returns

    the last index <= end such that the elements of this immutable sequence starting at this index match the elements of sequence that, or -1 of no such subsequence exists.

    definition classes: SeqLike
  118. def lastIndexOfSlice [B >: A] (that: Seq[B]) : Int

    Finds last index where this immutable sequence contains a given sequence as a slice.

    Finds last index where this immutable sequence contains a given sequence as a slice.

    Note: will not terminate for infinite-sized collections.

    that

    the sequence to test

    returns

    the last index such that the elements of this immutable sequence starting a this index match the elements of sequence that, or -1 of no such subsequence exists.

    definition classes: SeqLike
  119. def lastIndexWhere (p: (Node) ⇒ Boolean, end: Int) : Int

    Finds index of last element satisfying some predicate before or at given end index.

    Finds index of last element satisfying some predicate before or at given end index.

    p

    the predicate used to test elements.

    returns

    the index <= end of the last element of this immutable sequence that satisfies the predicate p, or -1, if none exists.

    definition classes: SeqLike
  120. def lastIndexWhere (p: (Node) ⇒ Boolean) : Int

    Finds index of last element satisfying some predicate.

    Finds index of last element satisfying some predicate.

    Note: will not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    the index of the last element of this immutable sequence that satisfies the predicate p, or -1, if none exists.

    definition classes: SeqLike
  121. def lastOption : Option[Node]

    Optionally selects the last element.

    Optionally selects the last element.

    returns

    the last element of this immutable sequence$ if it is nonempty, None if it is empty.

    definition classes: TraversableLike
  122. def length : Int

    The length of the immutable sequence.

    The length of the immutable sequence.

    Note: will not terminate for infinite-sized collections.

    Note: xs.length and xs.size yield the same result.

    returns

    the number of elements in this immutable sequence.

    definition classes: NodeSeqSeqLike
  123. def lengthCompare (len: Int) : Int

    Compares the length of this immutable sequence to a test value.

    Compares the length of this immutable sequence to a test value.

    len

    the test value that gets compared with the length.

    returns

    A value x where x < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len The method as implemented here does not call length directly; its running time is O(length min len) instead of O(length). The method should be overwritten if computing length is cheap.

    definition classes: SeqLike
  124. def lift : (Int) ⇒ Option[Node]

    Turns this partial function into an plain function returning an Option result.

    Turns this partial function into an plain function returning an Option result.

    returns

    a function that takes an argument x to Some(this(x)) if this is defined for x, and to None otherwise.

    definition classes: PartialFunction
  125. def map [B] (f: (Node) ⇒ B) : immutable.Seq[B]

    [use case] Builds a new collection by applying a function to all elements of this immutable sequence.

    [use case]

    Builds a new collection by applying a function to all elements of this immutable sequence.

    B

    the element type of the returned collection.

    f

    the function to apply to each element.

    returns

    a new immutable sequence resulting from applying the given function f to each element of this immutable sequence and collecting the results.

    attributes: abstract
    definition classes: TraversableLike
  126. def map [B, That] (f: (Node) ⇒ B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Builds a new collection by applying a function to all elements of this immutable sequence.

    Builds a new collection by applying a function to all elements of this immutable sequence.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That resulting from applying the given function f to each element of this immutable sequence and collecting the results.

    definition classes: TraversableLikeFilterMonadic
  127. def max : Node

    [use case] Finds the largest element.

    [use case]

    Finds the largest element.

    returns

    the largest element of this immutable sequence.

    attributes: abstract
    definition classes: TraversableOnce
  128. def max [B >: A] (implicit cmp: Ordering[B]) : Node

    Finds the largest element.

    Finds the largest element.

    B

    The type over which the ordering is defined.

    cmp

    An ordering to be used for comparing elements.

    returns

    the largest element of this immutable sequence with respect to the ordering cmp.

    definition classes: TraversableOnce
  129. def min : Node

    [use case] Finds the smallest element.

    [use case]

    Finds the smallest element.

    returns

    the smallest element of this immutable sequence

    attributes: abstract
    definition classes: TraversableOnce
  130. def min [B >: A] (implicit cmp: Ordering[B]) : Node

    Finds the smallest element.

    Finds the smallest element.

    B

    The type over which the ordering is defined.

    cmp

    An ordering to be used for comparing elements.

    returns

    the smallest element of this immutable sequence with respect to the ordering cmp.

    definition classes: TraversableOnce
  131. def mkString : String

    Displays all elements of this immutable sequence in a string.

    Displays all elements of this immutable sequence in a string.

    returns

    a string representation of this immutable sequence. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable sequence follow each other without any separator string.

    definition classes: TraversableOnce
  132. def mkString (sep: String) : String

    Displays all elements of this immutable sequence in a string using a separator string.

    Displays all elements of this immutable sequence in a string using a separator string.

    sep

    the separator string.

    returns

    a string representation of this immutable sequence. In the resulting string the string representations (w.r.t. the method toString) of all elements of this immutable sequence are separated by the string sep.

    definition classes: TraversableOnce
  133. def mkString (start: String, sep: String, end: String) : String

    Displays all elements of this immutable sequence in a string using start, end, and separator strings.

    Displays all elements of this immutable sequence in a string using start, end, and separator strings.

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    a string representation of this immutable sequence. The resulting string begins with the string start and ends with the string end. Inside, the string representations (w.r.t. the method toString) of all elements of this immutable sequence are separated by the string sep.

    definition classes: TraversableOnce
  134. def nameToString (sb: StringBuilder) : StringBuilder

    Appends qualified name of this node to StringBuilder.

    Appends qualified name of this node to StringBuilder.

    sb

    ...

    returns

    ...

    definition classes: Node
  135. def namespace : Null

    always Node.

    always Node.EmptyNamespace

    attributes: final
    definition classes: SpecialNodeNode
  136. 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
  137. def newBuilder : Builder[Node, NodeSeq]

    Creates a list buffer as builder for this class

    Creates a list buffer as builder for this class

    attributes: protected[this]
  138. def nonEmpty : Boolean

    Tests whether the immutable sequence is not empty.

    Tests whether the immutable sequence is not empty.

    returns

    true if the immutable sequence contains at least one element, false otherwise.

    definition classes: TraversableOnce
  139. def nonEmptyChildren : Seq[Node]

    Children which do not stringify to "" (needed for equality)

    Children which do not stringify to "" (needed for equality)

    definition classes: Node
  140. 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
  141. 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
  142. def orElse [A1 <: A, B1 >: B] (that: PartialFunction[A1, B1]) : PartialFunction[A1, B1]

    Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

    Composes this partial function with a fallback partial function which gets applied where this partial function is not defined.

    A1

    the argument type of the fallback function

    B1

    the result type of the fallback function

    that

    the fallback function

    returns

    a partial function which has as domain the union of the domains of this partial function and that. The resulting partial function takes x to this(x) where this is defined, and to that(x) where it is not.

    definition classes: PartialFunction
  143. def padTo (len: Int, elem: Node) : immutable.Seq[Node]

    [use case] Appends an element value to this immutable sequence until a given target length is reached.

    [use case]

    Appends an element value to this immutable sequence until a given target length is reached.

    len

    the target length

    elem

    the padding value

    returns

    a new immutable sequence consisting of all elements of this immutable sequence followed by the minimal number of occurrences of elem so that the resulting immutable sequence has a length of at least len.

    attributes: abstract
    definition classes: SeqLike
  144. def padTo [B >: A, That] (len: Int, elem: B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Appends an element value to this immutable sequence until a given target length is reached.

    Appends an element value to this immutable sequence until a given target length is reached.

    B

    the element type of the returned immutable sequence.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    len

    the target length

    elem

    the padding value

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That consisting of all elements of this immutable sequence followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.

    definition classes: SeqLike
  145. def partition (p: (Node) ⇒ Boolean) : (NodeSeq, NodeSeq)

    Partitions this immutable sequence in two immutable sequences according to a predicate.

    Partitions this immutable sequence in two immutable sequences according to a predicate.

    p

    the predicate on which to partition.

    returns

    a pair of immutable sequences: the first immutable sequence consists of all elements that satisfy the predicate p and the second immutable sequence consists of all elements that don't. The relative order of the elements in the resulting immutable sequences is the same as in the original immutable sequence.

    definition classes: TraversableLike
  146. def patch (from: Int, that: Seq[Node], replaced: Int) : immutable.Seq[Node]

    [use case] Produces a new immutable sequence where a slice of elements in this immutable sequence is replaced by another sequence.

    [use case]

    Produces a new immutable sequence where a slice of elements in this immutable sequence is replaced by another sequence.

    from

    the index of the first replaced element

    replaced

    the number of elements to drop in the original immutable sequence

    returns

    a new immutable sequence consisting of all elements of this immutable sequence except that replaced elements starting from from are replaced by patch.

    attributes: abstract
    definition classes: SeqLike
  147. def patch [B >: A, That] (from: Int, patch: Seq[B], replaced: Int)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Produces a new immutable sequence where a slice of elements in this immutable sequence is replaced by another sequence.

    Produces a new immutable sequence where a slice of elements in this immutable sequence is replaced by another sequence.

    B

    the element type of the returned immutable sequence.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    from

    the index of the first replaced element

    patch

    the replacement sequence

    replaced

    the number of elements to drop in the original immutable sequence

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new immutable sequence consisting of all elements of this immutable sequence except that replaced elements starting from from are replaced by patch.

    definition classes: SeqLike
  148. def prefix : String

    prefix of this node

    prefix of this node

    definition classes: Node
  149. def prefixLength (p: (Node) ⇒ Boolean) : Int

    Returns the length of the longest prefix whose elements all satisfy some predicate.

    Returns the length of the longest prefix whose elements all satisfy some predicate.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    returns

    the length of the longest prefix of this immutable sequence such that every element of the segment satisfies the predicate p.

    definition classes: SeqLike
  150. def product : Node

    [use case] Multiplies up the elements of this collection.

    [use case]

    Multiplies up the elements of this collection.

    returns

    the product of all elements in this immutable sequence of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the immutable sequence and as result type of product. Examples of such types are: Long, Float, Double, BigInt.

    attributes: abstract
    definition classes: TraversableOnce
  151. def product [B >: A] (implicit num: Numeric[B]) : B

    Multiplies up the elements of this collection.

    Multiplies up the elements of this collection.

    B

    the result type of the * operator.

    num

    an implicit parameter defining a set of numeric operations which includes the * operator to be used in forming the product.

    returns

    the product of all elements of this immutable sequence with respect to the * operator in num.

    definition classes: TraversableOnce
  152. def productArity : Int

    return k for a product A(x_1,...,x_k)

    return k for a product A(x_1,...,x_k)

    definition classes: TextProduct
  153. def productElement (arg0: Int) : Any

    For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k

    For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k

    returns

    The element n elements after the first element

    definition classes: TextProduct
  154. def productElements : Iterator[Any]

    definition classes: Product
      deprecated:
    1. use productIterator instead

  155. def productIterator : Iterator[Any]

    An iterator that returns all fields of this product

    An iterator that returns all fields of this product

    definition classes: Product
  156. def productPrefix : String

    By default the empty string.

    By default the empty string. Implementations may override this method in order to prepend a string prefix to the result of the toString methods.

    definition classes: TextProduct
  157. def projection : SeqView[Node, NodeSeq]

    returns a projection that can be used to call non-strict filter,map, and flatMap methods that build projections of the collection.

    returns a projection that can be used to call non-strict filter,map, and flatMap methods that build projections of the collection.

    definition classes: SeqLikeIterableLike
      deprecated:
    1. use view' instead

  158. def reduceLeft [B >: A] (op: (B, Node) ⇒ B) : B

    Applies a binary operator to all elements of this immutable sequence, going left to right.

    Applies a binary operator to all elements of this immutable sequence, going left to right.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable sequence, going left to right: op(...(op(x1, x2), ... ) , xn) where x,,1,,, ..., x,,n,, are the elements of this immutable sequence.

    definition classes: TraversableOnce
  159. def reduceLeftOption [B >: A] (op: (B, Node) ⇒ B) : Option[B]

    Optionally applies a binary operator to all elements of this immutable sequence, going left to right.

    Optionally applies a binary operator to all elements of this immutable sequence, going left to right.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    an option value containing the result of reduceLeft(op) is this immutable sequence is nonempty, None otherwise.

    definition classes: TraversableOnce
  160. def reduceRight [B >: A] (op: (Node, B) ⇒ B) : B

    Applies a binary operator to all elements of this immutable sequence, going right to left.

    Applies a binary operator to all elements of this immutable sequence, going right to left.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this immutable sequence, going right to left: op(x1, op(x2, ..., op(xn-1, xn)...)) where x,,1,,, ..., x,,n,, are the elements of this immutable sequence.

    definition classes: IterableLikeTraversableOnce
  161. def reduceRightOption [B >: A] (op: (Node, B) ⇒ B) : Option[B]

    Optionally applies a binary operator to all elements of this immutable sequence, going right to left.

    Optionally applies a binary operator to all elements of this immutable sequence, going right to left.

    Note: will not terminate for infinite-sized collections.

    B

    the result type of the binary operator.

    op

    the binary operator.

    returns

    an option value containing the result of reduceRight(op) is this immutable sequence is nonempty, None otherwise.

    definition classes: TraversableOnce
  162. def repr : NodeSeq

    The collection of type immutable sequence underlying this TraversableLike object.

    The collection of type immutable sequence underlying this TraversableLike object. By default this is implemented as the TraversableLike object itself, but this can be overridden.

    definition classes: TraversableLike
  163. def reverse : NodeSeq

    Returns new immutable sequence wih elements in reversed order.

    Returns new immutable sequence wih elements in reversed order.

    Note: will not terminate for infinite-sized collections.

    returns

    A new immutable sequence with all elements of this immutable sequence in reversed order.

    definition classes: SeqLike
  164. def reverseIterator : Iterator[Node]

    An iterator yielding elements in reversed order.

    An iterator yielding elements in reversed order.

    Note: will not terminate for infinite-sized collections.

    Note: xs.reverseIterator is the same as xs.reverse.iterator but might be more efficient.

    returns

    an iterator yielding the elements of this immutable sequence in reversed order

    definition classes: SeqLike
  165. def reverseMap [B] (f: (Node) ⇒ B) : immutable.Seq[B]

    [use case] Builds a new collection by applying a function to all elements of this immutable sequence and collecting the results in reversed order.

    [use case]

    Builds a new collection by applying a function to all elements of this immutable sequence and collecting the results in reversed order.

    B

    the element type of the returned collection.

    Note: xs.reverseMap(f) is the same as xs.reverse.map(f) but might be more efficient.

    f

    the function to apply to each element.

    returns

    a new immutable sequence resulting from applying the given function f to each element of this immutable sequence and collecting the results in reversed order.

    attributes: abstract
    definition classes: SeqLike
  166. def reverseMap [B, That] (f: (Node) ⇒ B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Builds a new collection by applying a function to all elements of this immutable sequence and collecting the results in reversed order.

    Builds a new collection by applying a function to all elements of this immutable sequence and collecting the results in reversed order.

    Note: will not terminate for infinite-sized collections.

    Note: xs.reverseMap(f) is the same as xs.reverse.map(f) but might be more efficient.

    B

    the element type of the returned collection.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    f

    the function to apply to each element.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That resulting from applying the given function f to each element of this immutable sequence and collecting the results in reversed order.

    definition classes: SeqLike
  167. def reversed : List[Node]

    attributes: protected[this]
    definition classes: TraversableOnce
  168. def reversedElements : Iterator[Node]

    definition classes: SeqLike
      deprecated:
    1. use reverseIterator' instead

  169. def sameElements (that: Iterable[Node]) : Boolean

    [use case] Checks if the other iterable collection contains the same elements in the same order as this immutable sequence.

    [use case]

    Checks if the other iterable collection contains the same elements in the same order as this immutable sequence.

    that

    the collection to compare with.

    returns

    true, if both collections contain the same elements in the same order, false otherwise.

    attributes: abstract
    definition classes: IterableLike
  170. def sameElements [B >: A] (that: Iterable[B]) : Boolean

    Checks if the other iterable collection contains the same elements in the same order as this immutable sequence.

    Checks if the other iterable collection contains the same elements in the same order as this immutable sequence.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of collection that.

    that

    the collection to compare with.

    returns

    true, if both collections contain the same elements in the same order, false otherwise.

    definition classes: IterableLike
  171. def scanLeft [B, That] (z: B)(op: (B, Node) ⇒ B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Produces a collection containing cummulative results of applying the operator going left to right.

    Produces a collection containing cummulative results of applying the operator going left to right.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    collection with intermediate results

    definition classes: TraversableLike
  172. def scanRight [B, That] (z: B)(op: (Node, B) ⇒ B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Produces a collection containing cummulative results of applying the operator going right to left.

    Produces a collection containing cummulative results of applying the operator going right to left.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements in the resulting collection

    That

    the actual type of the resulting collection

    z

    the initial value

    op

    the binary operator applied to the intermediate result and the element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    collection with intermediate results

    definition classes: TraversableLike
  173. def scope : NamespaceBinding

    method returning the namespace bindings of this node.

    method returning the namespace bindings of this node. by default, this is TopScope, which means there are no namespace bindings except the predefined one for "xml".

    definition classes: Node
  174. def segmentLength (p: (Node) ⇒ Boolean, from: Int) : Int

    Computes length of longest segment whose elements all satisfy some predicate.

    Computes length of longest segment whose elements all satisfy some predicate.

    Note: may not terminate for infinite-sized collections.

    p

    the predicate used to test elements.

    from

    the index where the search starts.

    returns

    the length of the longest segment of this immutable sequence starting from index from such that every element of the segment satisfies the predicate p.

    definition classes: SeqLike
  175. def size : Int

    The size of this immutable sequence, equivalent to length.

    The size of this immutable sequence, equivalent to length.

    Note: will not terminate for infinite-sized collections.@return the number of elements in this immutable sequence.

    definition classes: SeqLikeTraversableOnce
  176. def slice (from: Int, until: Int) : NodeSeq

    Selects an interval of elements.

    Selects an interval of elements.

    Note: c.slice(from, to) is equivalent to (but possibly more efficient than) c.drop(from).take(to - from)

    from

    the index of the first returned element in this immutable sequence.

    until

    the index one past the last returned element in this immutable sequence.

    returns

    a immutable sequence containing the elements starting at index from and extending up to (but not including) index until of this immutable sequence.

    definition classes: IterableLikeTraversableLike
  177. def sliding [B >: A] (size: Int, step: Int) : Iterator[NodeSeq]

    definition classes: IterableLike
  178. def sliding [B >: A] (size: Int) : Iterator[NodeSeq]

    Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.

    Groups elements in fixed size blocks by passing a "sliding window" over them (as opposed to partitioning them, as is done in grouped.)

    size

    the number of elements per group

    returns

    An iterator producing immutable sequences of size size, except the last and the only element will be truncated if there are fewer elements than size.

    definition classes: IterableLike
      see also:
    1. Iterator#sliding

  179. def sortBy [B] (f: (Node) ⇒ B)(implicit ord: Ordering[B]) : NodeSeq

    Sorts this immutable.

    Sorts this immutable.Seq according to the Ordering which results from transforming an implicitly given Ordering with a transformation function.

    B

    the target type of the transformation f, and the type where the ordering ord is defined.

    f

    the transformation function mapping elements to some other domain B.

    ord

    the ordering assumed on domain B.

    returns

    a immutable sequence consisting of the elements of this immutable sequence sorted according to the ordering where x < y if ord.lt(f(x), f(y)).

    definition classes: SeqLike
      see also:
    1. scala.math.Ordering

      Note: will not terminate for infinite-sized collections.

  180. def sortWith (lt: (Node, Node) ⇒ Boolean) : NodeSeq

    Sorts this immutable sequence according to a comparison function.

    Sorts this immutable sequence according to a comparison function.

    Note: will not terminate for infinite-sized collections.

    The sort is stable. That is, elements that are equal wrt lt appear in the same order in the sorted sequence as in the original.

    lt

    the comparison function which tests whether its first argument precedes its second argument in the desired ordering.

    returns

    a immutable sequence consisting of the elements of this immutable sequence sorted according to the comparison function lt.

    definition classes: SeqLike
  181. def sorted [B >: A] (implicit ord: Ordering[B]) : NodeSeq

    Sorts this immutable sequence according to an Ordering.

    Sorts this immutable sequence according to an Ordering.

    The sort is stable. That is, elements that are equal wrt lt appear in the same order in the sorted sequence as in the original.

    ord

    the ordering to be used to compare elements.

    returns

    a immutable sequence consisting of the elements of this immutable sequence sorted according to the ordering ord.

    definition classes: SeqLike
      see also:
    1. scala.math.Ordering

  182. def span (p: (Node) ⇒ Boolean) : (NodeSeq, NodeSeq)

    Splits this immutable sequence into a prefix/suffix pair according to a predicate.

    Splits this immutable sequence into a prefix/suffix pair according to a predicate.

    Note: c span p is equivalent to (but possibly more efficient than) (c takeWhile p, c dropWhile p), provided the evaluation of the predicate p does not cause any side-effects.

    p

    the test predicate

    returns

    a pair consisting of the longest prefix of this immutable sequence whose elements all satisfy p, and the rest of this immutable sequence.

    definition classes: TraversableLike
  183. def splitAt (n: Int) : (NodeSeq, NodeSeq)

    Splits this immutable sequence into two at a given position.

    Splits this immutable sequence into two at a given position. Note: c splitAt n is equivalent to (but possibly more efficient than) (c take n, c drop n).

    n

    the position at which to split.

    returns

    a pair of immutable sequences consisting of the first n elements of this immutable sequence, and the other elements.

    definition classes: TraversableLike
  184. def startsWith [B] (that: Seq[B]) : Boolean

    Tests whether this immutable sequence starts with the given sequence.

    Tests whether this immutable sequence starts with the given sequence.

    that

    the sequence to test

    returns

    true if this collection has that as a prefix, false otherwise.

    definition classes: SeqLike
  185. def startsWith [B] (that: Seq[B], offset: Int) : Boolean

    Tests whether this immutable sequence contains the given sequence at a given index.

    Tests whether this immutable sequence contains the given sequence at a given index.

    If the both the receiver object, this and the argument, that are infinite sequences this method may not terminate.

    that

    the sequence to test

    offset

    the index where the sequence is searched.

    returns

    true if the sequence that is contained in this immutable sequence at index offset, otherwise false.

    definition classes: SeqLike
  186. def strict_!= (other: Equality) : Boolean

    definition classes: Equality
  187. def strict_== (other: Equality) : Boolean

    definition classes: AtomNodeNodeSeq → Equality
  188. def stringPrefix : String

    Defines the prefix of this object's toString representation.

    Defines the prefix of this object's toString representation.

    returns

    a string representation which starts the result of toString applied to this immutable sequence. By default the string prefix is the simple name of the collection class immutable sequence.

    definition classes: TraversableLike
  189. def sum : Node

    [use case] Sums up the elements of this collection.

    [use case]

    Sums up the elements of this collection.

    returns

    the sum of all elements in this immutable sequence of numbers of type Int. Instead of Int, any other type T with an implicit Numeric[T] implementation can be used as element type of the immutable sequence and as result type of sum. Examples of such types are: Long, Float, Double, BigInt.

    attributes: abstract
    definition classes: TraversableOnce
  190. def sum [B >: A] (implicit num: Numeric[B]) : B

    Sums up the elements of this collection.

    Sums up the elements of this collection.

    B

    the result type of the + operator.

    num

    an implicit parameter defining a set of numeric operations which includes the + operator to be used in forming the sum.

    returns

    the sum of all elements of this immutable sequence with respect to the + operator in num.

    definition classes: TraversableOnce
  191. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  192. def tail : NodeSeq

    Selects all elements except the first.

    Selects all elements except the first.

    returns

    a immutable sequence consisting of all elements of this immutable sequence except the first one.

    definition classes: TraversableLike
  193. def take (n: Int) : NodeSeq

    Selects first n elements.

    Selects first n elements.

    n

    Tt number of elements to take from this immutable sequence.

    returns

    a immutable sequence consisting only of the first n elements of this immutable sequence, or else the whole immutable sequence, if it has less than n elements.

    definition classes: IterableLikeTraversableLike
  194. def takeRight (n: Int) : NodeSeq

    Selects last n elements.

    Selects last n elements.

    n

    the number of elements to take

    returns

    a immutable sequence consisting only of the last n elements of this immutable sequence, or else the whole immutable sequence, if it has less than n elements.

    definition classes: IterableLike
  195. def takeWhile (p: (Node) ⇒ Boolean) : NodeSeq

    Takes longest prefix of elements that satisfy a predicate.

    Takes longest prefix of elements that satisfy a predicate.

    p

    The predicate used to test elements.

    returns

    the longest prefix of this immutable sequence whose elements all satisfy the predicate p.

    definition classes: IterableLikeTraversableLike
  196. def text : String

    Returns a text representation of this node.

    Returns a text representation of this node. Note that this is not equivalent to the XPath node-test called text(), it is rather an implementation of the XPath function string() Martin to Burak: to do: if you make this method abstract, the compiler will now complain if there's no implementation in a subclass. Is this what we want? Note that this would break doc/DocGenator and doc/ModelToXML, with an error message like:

    doc\DocGenerator.scala:1219: error: object creation impossible, since there is a deferred declaration of method text in class Node of type => String which is not implemented in a subclass
    new SpecialNode {
    ^
    
    definition classes: AtomNodeNodeSeq
  197. def theSeq : Seq[Node]

    returns a sequence consisting of only this node

    returns a sequence consisting of only this node

    definition classes: NodeNodeSeq
  198. def thisCollection : Seq[Node]

    The underlying collection seen as an instance of immutable.Seq.

    The underlying collection seen as an instance of immutable.Seq. By default this is implemented as the current collection object itself, but this can be overridden.

    attributes: protected[this]
    definition classes: SeqLikeIterableLikeTraversableLike
  199. def toArray : Array[Node]

    [use case] Converts this immutable sequence to an array.

    [use case]

    Converts this immutable sequence to an array.

    Note: will not terminate for infinite-sized collections.

    returns

    an array containing all elements of this immutable sequence. A ClassManifest must be available for the element type of this immutable sequence.

    attributes: abstract
    definition classes: TraversableOnce
  200. def toArray [B >: A] (implicit arg0: ClassManifest[B]) : Array[B]

    Converts this immutable sequence to an array.

    Converts this immutable sequence to an array.

    Note: will not terminate for infinite-sized collections.

    B

    the type of the elements of the array. A ClassManifest for this type must be available.

    returns

    an array containing all elements of this immutable sequence.

    definition classes: TraversableOnce
  201. def toBuffer [B >: A] : Buffer[B]

    Converts this immutable sequence to a mutable buffer.

    Converts this immutable sequence to a mutable buffer.

    Note: will not terminate for infinite-sized collections.

    returns

    a buffer containing all elements of this immutable sequence.

    definition classes: TraversableOnce
  202. def toCollection (repr: NodeSeq) : Seq[Node]

    A conversion from collections of type Repr to immutable.Seq objects.

    A conversion from collections of type Repr to immutable.Seq objects. By default this is implemented as just a cast, but this can be overridden.

    attributes: protected[this]
    definition classes: SeqLikeIterableLikeTraversableLike
  203. def toIndexedSeq [B >: A] : IndexedSeq[B]

    Converts this immutable sequence to an indexed sequence.

    Converts this immutable sequence to an indexed sequence.

    Note: will not terminate for infinite-sized collections.

    returns

    an indexed sequence containing all elements of this immutable sequence.

    definition classes: TraversableOnce
  204. def toIterable : Iterable[Node]

    Converts this immutable sequence to an iterable collection.

    Converts this immutable sequence to an iterable collection. Note that the choice of target Iterable is lazy in this default implementation as this TraversableOnce may be lazy and unevaluated (i.e. it may be an iterator which is only traversable once).

    Note: will not terminate for infinite-sized collections.

    returns

    an Iterable containing all elements of this immutable sequence.

    definition classes: IterableLikeTraversableOnce
  205. def toIterator : Iterator[Node]

    Returns an Iterator over the elements in this immutable sequence.

    Returns an Iterator over the elements in this immutable sequence. Will return the same Iterator if this instance is already an Iterator.

    Note: will not terminate for infinite-sized collections.

    returns

    an Iterator containing all elements of this immutable sequence.

    definition classes: TraversableLikeTraversableOnce
  206. def toList : List[Node]

    Converts this immutable sequence to a list.

    Converts this immutable sequence to a list.

    Note: will not terminate for infinite-sized collections.

    returns

    a list containing all elements of this immutable sequence.

    definition classes: TraversableOnce
  207. def toMap [T, U] (implicit ev: <:<[Node, (T, U)]) : Map[T, U]

    Converts this immutable sequence to a map.

    Converts this immutable sequence to a map. This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys: if this is an unordered collection, which key is in the resulting map is undefined.

    Note: will not terminate for infinite-sized collections.

    returns

    a map containing all elements of this immutable sequence.

    definition classes: TraversableOnce
  208. def toSeq : Seq[Node]

    Converts this immutable sequence to a sequence.

    Converts this immutable sequence to a sequence.

    Note: will not terminate for infinite-sized collections.

    Overridden for efficiency.@return a sequence containing all the elements of this immutable sequence.

    definition classes: SeqLikeIterableLikeTraversableOnce
  209. def toSet [B >: A] : Set[B]

    Converts this immutable sequence to a set.

    Converts this immutable sequence to a set.

    Note: will not terminate for infinite-sized collections.

    returns

    a set containing all elements of this immutable sequence.

    definition classes: TraversableOnce
  210. def toStream : Stream[Node]

    Converts this immutable sequence to a stream.

    Converts this immutable sequence to a stream.

    Note: will not terminate for infinite-sized collections.

    returns

    a stream containing all elements of this immutable sequence.

    definition classes: IterableLikeTraversableLikeTraversableOnce
  211. def toString () : String

    Same as toString(false).

    Same as toString(false).

    definition classes: NodeNodeSeqSeqLikeFunction1TraversableLike → AnyRef → Any
      see also:
    1. toString(Boolean)@return a string representation of this collection. By default this string consists of the stringPrefix of this immutable sequence, followed by all elements separated by commas and enclosed in parentheses.

  212. def toTraversable : Traversable[Node]

    Converts this immutable sequence to an unspecified Traversable.

    Converts this immutable sequence to an unspecified Traversable. Will return the same collection if this instance is already Traversable.

    Note: will not terminate for infinite-sized collections.

    returns

    a Traversable containing all elements of this immutable sequence.

    definition classes: TraversableLikeTraversableOnce
  213. def transpose [B] (implicit asTraversable: (Node) ⇒ Traversable[B]) : Seq[Seq[B]]

    Transposes this immutable sequence of traversable collections into a immutable sequence of immutable sequences.

    Transposes this immutable sequence of traversable collections into a immutable sequence of immutable sequences.

    B

    the type of the elements of each traversable collection.

    asTraversable

    an implicit conversion which asserts that the element type of this immutable sequence is a Traversable.

    returns

    a two-dimensional immutable sequence of immutable sequences which has as nth row the nth column of this immutable sequence.

    definition classes: GenericTraversableTemplate
  214. def union (that: Seq[Node]) : immutable.Seq[Node]

    [use case] Produces a new sequence which contains all elements of this immutable sequence and also all elements of a given sequence.

    [use case]

    Produces a new sequence which contains all elements of this immutable sequence and also all elements of a given sequence. xs union ys is equivalent to xs ++ ys.

    Note: will not terminate for infinite-sized collections.

    that

    the sequence to add.

    returns

    a new immutable sequence which contains all elements of this immutable sequence followed by all elements of that.

    attributes: abstract
    definition classes: SeqLike
  215. def union [B >: A, That] (that: Seq[B])(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    Produces a new sequence which contains all elements of this immutable sequence and also all elements of a given sequence.

    Produces a new sequence which contains all elements of this immutable sequence and also all elements of a given sequence. xs union ys is equivalent to xs ++ ys.

    Note: will not terminate for infinite-sized collections.

    Another way to express this is that xs union ys computes the order-presevring multi-set union of xs and ys. union is hence a counter-part of diff and intersect which also work on multi-sets.

    Note: will not terminate for infinite-sized collections.

    B

    the element type of the returned immutable sequence.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    that

    the sequence to add.

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new collection of type That which contains all elements of this immutable sequence followed by all elements of that.

    definition classes: SeqLike
  216. def unzip [A1, A2] (implicit asPair: (Node) ⇒ (A1, A2)) : (Seq[A1], Seq[A2])

    Converts this immutable sequence of pairs into two collections of the first and second halfs of each pair.

    Converts this immutable sequence of pairs into two collections of the first and second halfs of each pair.

    asPair

    an implicit conversion which asserts that the element type of this immutable sequence is a pair.

    returns

    a pair immutable sequences, containing the first, respectively second half of each element pair of this immutable sequence.

    definition classes: GenericTraversableTemplate
  217. def updated (index: Int, elem: Node) : immutable.Seq[Node]

    [use case] A copy of this immutable sequence with one single replaced element.

    [use case]

    A copy of this immutable sequence with one single replaced element.

    index

    the position of the replacement

    elem

    the replacing element

    returns

    a copy of this immutable sequence with the element at position index replaced by elem.

    attributes: abstract
    definition classes: SeqLike
  218. def updated [B >: A, That] (index: Int, elem: B)(implicit bf: CanBuildFrom[NodeSeq, B, That]) : That

    A copy of this immutable sequence with one single replaced element.

    A copy of this immutable sequence with one single replaced element.

    B

    the element type of the returned immutable sequence.

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type B being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, B, That] is found.

    index

    the position of the replacement

    elem

    the replacing element

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type B.

    returns

    a new immutable sequence which is a copy of this immutable sequence with the element at position index replaced by elem.

    definition classes: SeqLike
  219. def view (from: Int, until: Int) : SeqView[Node, NodeSeq]

    Creates a non-strict view of a slice of this immutable sequence.

    Creates a non-strict view of a slice of this immutable sequence.

    Note: the difference between view and slice is that view produces a view of the current immutable sequence, whereas slice produces a new immutable sequence.

    Note: view(from, to) is equivalent to view.slice(from, to)

    from

    the index of the first element of the view

    until

    the index of the element following the view

    returns

    a non-strict view of a slice of this immutable sequence, starting at index from and extending up to (but not including) index until.

    definition classes: SeqLikeIterableLikeTraversableLike
  220. def view : SeqView[Node, NodeSeq]

    Creates a non-strict view of this immutable sequence.

    Creates a non-strict view of this immutable sequence.

    returns

    a non-strict view of this immutable sequence.

    definition classes: SeqLikeIterableLikeTraversableLike
  221. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  222. def wait (arg0: Long, arg1: Int) : Unit

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

    attributes: final
    definition classes: AnyRef
  224. def withFilter (p: (Node) ⇒ Boolean) : FilterMonadic[Node, NodeSeq]

    Creates a non-strict filter of this immutable sequence.

    Creates a non-strict filter of this immutable sequence.

    Note: the difference between c filter p and c withFilter p is that the former creates a new collection, whereas the latter only restricts the domain of subsequent map, flatMap, foreach, and withFilter operations.

    p

    the predicate used to test elements.

    returns

    an object of class WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those elements of this immutable sequence which satisfy the predicate p.

    definition classes: TraversableLikeFilterMonadic
  225. def xmlType () : TypeSymbol

    Returns a type symbol (e.

    Returns a type symbol (e.g. DTD, XSD), default null.

    definition classes: Node
  226. def xml_!= (other: Any) : Boolean

    attributes: final
    definition classes: Equality
  227. def xml_== (other: Any) : Boolean

    attributes: final
    definition classes: Equality
  228. def xml_sameElements [A] (that: Iterable[A]) : Boolean

    definition classes: NodeSeq
  229. def zip [B] (that: Iterable[B]) : immutable.Seq[(Node, B)]

    [use case] Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs.

    [use case]

    Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    returns

    a new immutable sequence containing pairs consisting of corresponding elements of this immutable sequence and that. The length of the returned collection is the minimum of the lengths of this immutable sequence and that.

    attributes: abstract
    definition classes: IterableLike
  230. def zip [A1 >: A, B, That] (that: Iterable[B])(implicit bf: CanBuildFrom[NodeSeq, (A1, B), That]) : That

    Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs.

    Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs. If one of the two collections is longer than the other, its remaining elements are ignored.

    A1

    the type of the first half of the returned pairs (this is always a supertype of the collection's element type A).

    B

    the type of the second half of the returned pairs

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, B) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, B), That]. is found.

    that

    The iterable providing the second half of each result pair

    bf

    an implicit value of class CanBuildFrom which determines the result class That from the current representation type Repr and the new element type (A1, B).

    returns

    a new collection of type That containing pairs consisting of corresponding elements of this immutable sequence and that. The length of the returned collection is the minimum of the lengths of this immutable sequence and that.

    definition classes: IterableLike
  231. def zipAll [B] (that: Iterable[B], thisElem: Node, thatElem: B) : immutable.Seq[(Node, B)]

    [use case] Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs.

    [use case]

    Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

    B

    the type of the second half of the returned pairs

    that

    The iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this immutable sequence is shorter than that.

    thatElem

    the element to be used to fill up the result if that is shorter than this immutable sequence.

    returns

    a new immutable sequence containing pairs consisting of corresponding elements of this immutable sequence and that. The length of the returned collection is the maximum of the lengths of this immutable sequence and that. If this immutable sequence is shorter than that, thisElem values are used to pad the result. If that is shorter than this immutable sequence, thatElem values are used to pad the result.

    attributes: abstract
    definition classes: IterableLike
  232. def zipAll [B, A1 >: A, That] (that: Iterable[B], thisElem: A1, thatElem: B)(implicit bf: CanBuildFrom[NodeSeq, (A1, B), That]) : That

    Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs.

    Returns a immutable sequence formed from this immutable sequence and another iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements are used to extend the shorter collection to the length of the longer.

    that

    the iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this immutable sequence is shorter than that.

    thatElem

    the element to be used to fill up the result if that is shorter than this immutable sequence.

    returns

    a new collection of type That containing pairs consisting of corresponding elements of this immutable sequence and that. The length of the returned collection is the maximum of the lengths of this immutable sequence and that. If this immutable sequence is shorter than that, thisElem values are used to pad the result. If that is shorter than this immutable sequence, thatElem values are used to pad the result.

    definition classes: IterableLike
  233. def zipWithIndex : immutable.Seq[(Node, Int)]

    [use case] Zips this immutable sequence with its indices.

    [use case]

    Zips this immutable sequence with its indices.

    returns

    A new immutable sequence containing pairs consisting of all elements of this immutable sequence paired with their index. Indices start at 0. @example List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))

    attributes: abstract
    definition classes: IterableLike
  234. def zipWithIndex [A1 >: A, That] (implicit bf: CanBuildFrom[NodeSeq, (A1, Int), That]) : That

    Zips this immutable sequence with its indices.

    Zips this immutable sequence with its indices.

    A1

    the type of the first half of the returned pairs (this is always a supertype of the collection's element type A).

    That

    the class of the returned collection. Where possible, That is the same class as the current collection class Repr, but this depends on the element type (A1, Int) being admissible for that class, which means that an implicit instance of type CanBuildFrom[Repr, (A1, Int), That]. is found.

    returns

    A new collection of type That containing pairs consisting of all elements of this immutable sequence paired with their index. Indices start at 0.

    definition classes: IterableLike

Inherited from Product

Inherited from Atom[String]

Inherited from SpecialNode

Inherited from XMLEvent

Inherited from Node

Inherited from NodeSeq

Inherited from Equality

Inherited from Seq[Node]

Inherited from Seq[Node]

Inherited from SeqLike[Node, NodeSeq]

Inherited from PartialFunction[Int, Node]

Inherited from (Int) ⇒ Node

Inherited from Iterable[Node]

Inherited from Iterable[Node]

Inherited from IterableLike[Node, NodeSeq]

Inherited from Equals

Inherited from Traversable[Node]

Inherited from Immutable

Inherited from Traversable[Node]

Inherited from GenericTraversableTemplate[Node, Seq]

Inherited from TraversableLike[Node, NodeSeq]

Inherited from TraversableOnce[Node]

Inherited from FilterMonadic[Node, NodeSeq]

Inherited from HasNewBuilder[Node, NodeSeq]

Inherited from AnyRef

Inherited from Any