Class scala.collection.immutable.StringOps

Test two objects for inequality.

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

Return the current string concatenated n times.

Returns a new traversable collection containing the elements from the left hand operand followed by the elements from the right hand operand. The element type of the traversable collection is the most specific superclass encompassing the element types of the two operands.

As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

This overload exists because: for the implementation of ++: we should reuse that of ++ because many collections override it with more efficient versions.

Since TraversableOnce has no ++ method, we have to implement that directly, but Traversable and down can use the overload.

As with ++, returns a new collection containing the elements from the left operand followed by the elements from the right operand.

It differs from ++ in that the right operand determines the type of the resulting collection rather than the left one. Mnemonic: the COLon is on the side of the new COLlection type.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

A copy of the string with an element prepended.

Note that :-ending operators are right associative (see example). A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Also, the original string is not modified, so you will want to capture the result.

Example:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = 2 +: x
y: List[Int] = List(2, 1)

scala> println(x)
List(1)

Applies a binary operator to a start value and all elements of this traversable or iterator, going left to right.

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

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

A copy of this string with an element appended.

A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

Example:

scala> val a = List(1)
a: List[Int] = List(1)

scala> val b = a :+ 2
b: List[Int] = List(1, 2)

scala> println(a)
List(1)

Applies a binary operator to all elements of this traversable or iterator 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.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Examples:

Note that the folding function used to compute b is equivalent to that used to compute c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15

Returns true if this is less than that

Returns true if this is less than or equal to that.

Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

Returns true if this is greater than that.

Returns true if this is greater than or equal to that.

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

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234

Appends all elements of this traversable or iterator 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 traversable or iterator, separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4

Appends all elements of this traversable or iterator 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 traversable or iterator are separated by the string sep.

Example:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)

Aggregates the results of applying an operator to subsequent elements.

This is a more general form of fold and reduce. It is similar to foldLeft in that it doesn't require the result to be a supertype of the element type. In addition, it allows parallel collections to be processed in chunks, and then combines the intermediate results.

aggregate splits the traversable or iterator into partitions and processes each partition by sequentially applying seqop, starting with z (like foldLeft). Those intermediate results are then combined by using combop (like fold). The implementation of this operation may operate on an arbitrary number of collection partitions (even 1), so combop may be invoked an arbitrary number of times (even 0).

As an example, consider summing up the integer values of a list of chars. The initial value for the sum is 0. First, seqop transforms each input character to an Int and adds it to the sum (of the partition). Then, combop just needs to sum up the intermediate results of the partitions:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })

Return element at index n

Cast the receiver object to be of type T0.

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

Method called from equality methods, so that user-defined subclasses can refuse to be equal to other collections of the same kind.

Returns this string with first character converted to upper case. If the first character of the string is capitalized, it is returned unchanged. This method does not convert characters outside the Basic Multilingual Plane (BMP).

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

Finds the first element of the traversable or iterator for which the given partial function is defined, and applies the partial function to it.

Note: may not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Iterates over combinations. A _combination_ of length n is a subsequence of the original sequence, with the elements taken in order. Thus, "xy" and "yy" are both length-2 combinations of "xyy", but "yx" is not. If there is more than one way to generate the same subsequence, only one will be returned.

For example, "xyyy" has three different ways to generate "xy" depending on whether the first, second, or third "y" is selected. However, since all are identical, only one will be chosen. Which of the three will be taken is an implementation detail that is not defined.

Result of comparing this with operand that.

Implement this method to determine how instances of A will be sorted.

Returns x where:

x < 0 when this < that x == 0 when this == that x > 0 when this > that

Result of comparing this with operand that.

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

Note: may not terminate for infinite-sized collections.

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

Note: may not terminate for infinite-sized collections.

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

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

Copies the elements of this string to an array. Fills the given array xs with values of this string, beginning at index start. Copying will stop once either the end of the current string is reached, or the end of the target array is reached.

Copies all elements of this traversable or iterator to a buffer.

Note: will not terminate for infinite-sized collections.

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

Counts the number of elements in the traversable or iterator which satisfy a predicate.

Computes the multiset difference between this string and another sequence.

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

Note: will not terminate for infinite-sized collections.

Selects all elements except first n ones.

Selects all elements except last n ones.

Drops longest prefix of elements that satisfy a predicate.

Tests whether this sequence ends with the given sequence.

The equality method for reference types. Default implementation delegates to eq.

See also equals in scala.Any.

Tests whether a predicate holds for at least one element of this sequence.

Selects all elements of this traversable collection which satisfy a predicate.

Selects all elements of this traversable collection which do not satisfy a predicate.

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

Builds a new collection by applying a function to all elements of this string and using the elements of the resulting collections.

For example:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

The type of the resulting collection is guided by the static type of string. This might cause unexpected results sometimes. For example:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)

Folds the elements of this traversable or iterator using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

Note: will not terminate for infinite-sized collections.

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

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

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

Applies a function f to all elements of this string.

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

Uses the underlying string as a pattern (in a fashion similar to printf in C), and uses the supplied arguments to fill in the holes.

The interpretation of the formatting patterns is described in java.util.Formatter, with the addition that classes deriving from ScalaNumber (such as scala.BigInt and scala.BigDecimal) are unwrapped to pass a type which Formatter understands.

Like format(args*) but takes an initial Locale parameter which influences formatting as in java.lang.String's format.

The interpretation of the formatting patterns is described in java.util.Formatter, with the addition that classes deriving from ScalaNumber (such as scala.BigInt and scala.BigDecimal) are unwrapped to pass a type which Formatter understands.

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

Returns the runtime class representation of the object.

Partitions this traversable collection into a map of traversable collections 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 traversable collection.

Partitions elements in fixed size iterable collections.

Tests whether this traversable collection 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. Non-empty Iterators usually return false even if they were created from a collection with a known finite size.

Note: many collection methods will not work on collections of infinite sizes. The typical failure mode is an infinite loop. These methods always attempt a traversal without checking first that hasDefiniteSize returns true. However, checking hasDefiniteSize can provide an assurance that size is well-defined and non-termination is not a concern.

The hashCode method for reference types. See hashCode in scala.Any.

Selects the first element of this sequence.

Optionally selects the first element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

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

Finds index of first occurrence of some value in this string.

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

Note: may not terminate for infinite-sized collections.

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

Note: may not terminate for infinite-sized collections.

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

Finds index of first element satisfying some predicate.

Note: may not terminate for infinite-sized collections.

Produces the range of all indices of this sequence.

Selects all elements except the last.

Iterates over the inits of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of init.

Computes the multiset intersection between this string and another sequence.

Tests whether this general sequence contains given index.

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

Tests whether this sequence is empty.

Test whether the dynamic type of the receiver object is T0.

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

Tests whether this traversable collection can be repeatedly traversed.

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

Selects the last element.

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

Finds index of last occurrence of some value in this string.

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

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

Note: will not terminate for infinite-sized collections.

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

Finds index of last element satisfying some predicate.

Note: will not terminate for infinite-sized collections.

Optionally selects the last element.

Note: might return different results for different runs, unless the underlying collection type is ordered.

The length of the string.

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

Compares the length of this sequence to a test value.

Return all lines in this string in an iterator, excluding trailing line end characters; i.e., apply .stripLineEnd to all lines returned by linesWithSeparators.

Return all lines in this string in an iterator, excluding trailing line end characters; i.e., apply .stripLineEnd to all lines returned by linesWithSeparators.

Return all lines in this string in an iterator, including trailing line end characters.

This method is analogous to s.split(EOL).toIterator, except that any existing line endings are preserved in the result strings, and the empty string yields an empty iterator.

A line end character is one of

LF - line feed (0x0A) FF - form feed (0x0C)

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

Finds the largest element.

Finds the first element which yields the largest value measured by function f.

Finds the smallest element.

Finds the first element which yields the smallest value measured by function f.

Displays all elements of this string in a string.

Displays all elements of this traversable or iterator in a string using a separator string.

Displays all elements of this traversable or iterator in a string using start, end, and separator strings.

Creates a string builder buffer as builder for this class

Tests whether the traversable or iterator is not empty.

A copy of this string with an element value appended until a given target length is reached.

Returns a parallel implementation of this collection.

For most collection types, this method creates a new parallel collection by copying all the elements. For these collection, par takes linear time. Mutable collections in this category do not produce a mutable parallel collection that has the same underlying dataset, so changes in one collection will not be reflected in the other one.

Specific collections (e.g. ParArray or mutable.ParHashMap) override this default behaviour by creating a parallel collection which shares the same underlying dataset. For these collections, par takes constant or sublinear time.

All parallel collections return a reference to themselves.

The default par implementation uses the combiner provided by this method to create a new parallel collection.

Partitions this traversable collection in two traversable collections according to a predicate.

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

Iterates over distinct permutations.

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

Note: may not terminate for infinite-sized collections.

Multiplies up the elements of this collection.

You can follow a string with .r(g1, ... , gn), turning it into a Regex, with group names g1 through gn.

"""(\d\d)-(\d\d)-(\d\d\d\d)""".r("month", "day", "year") matches dates and provides its subcomponents through groups named "month", "day" and "year".

You can follow a string with .r, turning it into a Regex. E.g.

"""A\w*""".r is the regular expression for identifiers starting with A.

Reduces the elements of this traversable or iterator using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

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

Optionally applies a binary operator to all elements of this traversable or iterator, going left to right.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Reduces the elements of this traversable or iterator, if any, using the specified associative binary operator.

The order in which operations are performed on elements is unspecified and may be nondeterministic.

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

Optionally applies a binary operator to all elements of this traversable or iterator, going right to left.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered or the operator is associative and commutative.

Replace all literal occurrences of literal with the literal string replacement. This method is equivalent to java.lang.String#replace.

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

Returns new sequence with elements in reversed order.

An iterator yielding elements in reversed order.

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

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

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

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

Computes a prefix scan of the elements of the collection.

Note: The neutral element z may be applied more than once.

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

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Produces a collection containing cumulative results of applying the operator going right to left. The head of the collection is the last cumulative result.

Note: will not terminate for infinite-sized collections.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Example:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)

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

A version of this collection with all of the operations implemented sequentially (i.e., in a single-threaded manner).

This method returns a reference to this collection. In parallel collections, it is redefined to return a sequential implementation of this collection. In both cases, it has O(1) complexity.

The size of this sequence, equivalent to length.

Note: will not terminate for infinite-sized collections.

The size of this sequence, if it can be cheaply computed

Selects an interval of elements. The returned collection is made up of all elements x which satisfy the invariant:

from <= indexOf(x) < until

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.) The "sliding window" step is set to one.

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

Sorts this sequence according to a comparison function.

Note: will not terminate for infinite-sized collections.

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

Sorts this sequence according to an Ordering.

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

Splits this 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.

Split this string around the separator character

If this string is the empty string, returns an array of strings that contains a single empty string.

If this string is not the empty string, returns an array containing the substrings terminated by the start of the string, the end of the string or the separator character, excluding empty trailing substrings

If the separator character is a surrogate character, only split on matching surrogate characters if they are not part of a surrogate pair

The behaviour follows, and is implemented in terms of String.split(re: String)

Splits this 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).

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

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

Tests whether this general sequence starts with the given sequence.

Defines the prefix of this object's toString representation.

Strip trailing line end character from this string if it has one.

A line end character is one of

LF - line feed (0x0A hex) FF - form feed (0x0C hex)

If a line feed character LF is preceded by a carriage return CR (0x0D hex), the CR character is also stripped (Windows convention).

For every line in this string:

Strip a leading prefix consisting of blanks or control characters followed by | from the line.

For every line in this string:

Strip a leading prefix consisting of blanks or control characters followed by marginChar from the line.

Returns this string with the given prefix stripped. If this string does not start with prefix, it is returned unchanged.

Returns this string with the given suffix stripped. If this string does not end with suffix, it is returned unchanged.

Sums up the elements of this collection.

Selects all elements except the first.

Iterates over the tails of this traversable collection. The first value will be this traversable collection and the final one will be an empty traversable collection, with the intervening values the results of successive applications of tail.

Selects first n elements.

Selects last n elements.

Takes longest prefix of elements that satisfy a predicate.

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

Converts this string into another by copying all elements.

Converts this string to an array.

Uses the contents of this sequence to create a new mutable buffer.

Parse as a Byte (string must contain only decimal digits and optional leading -).

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

Parse as a Double (surrounding whitespace is removed with a trim).

Parse as a Float (surrounding whitespace is removed with a trim).

Converts this traversable or iterator to an indexed sequence.

Note: will not terminate for infinite-sized collections.

Parse as an Int (string must contain only decimal digits and optional leading -).

Returns this iterable collection as an iterable collection.

A new collection will not be built; lazy collections will stay lazy.

Note: will not terminate for infinite-sized collections.

Returns an Iterator over the elements in this iterable collection. Produces the same result as iterator.

Note: will not terminate for infinite-sized collections.

Converts this sequence to a list.

Parse as a Long (string must contain only decimal digits and optional leading -).

Converts this string to a map. This method is unavailable unless the elements are members of Tuple2, each ((T, U)) 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.

Converts this sequence to a sequence.

Note: will not terminate for infinite-sized collections.

A new collection will not be built; in particular, lazy sequences will stay lazy.

Converts this traversable or iterator to a set.

Note: will not terminate for infinite-sized collections.

Parse as a Short (string must contain only decimal digits and optional leading -).

Converts this iterable collection to a stream.

Converts this string to a string.

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

Note: will not terminate for infinite-sized collections.

Converts this traversable or iterator to a Vector.

Note: will not terminate for infinite-sized collections.

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

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

A copy of this string with one single replaced element.

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

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

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

Creates a non-strict view of this sequence.

Creates a non-strict filter of this traversable collection.

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.

Note: might return different results for different runs, unless the underlying collection type is ordered.

Returns a string formed from this string 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.

Returns a string formed from this string 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.

Zips this string with its indices.

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