W3cubDocs

/Scala 2.13 Library

Class scala.collection.StringOps

Companion object StringOps

final class StringOps extends AnyVal

Source
StringOps.scala
Linear Supertypes
AnyVal, Any

Instance Constructors

new StringOps(s: String)

Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

true if !(this == that), false otherwise.

Definition Classes
Any

final def ##(): Int

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.

returns

a hash value consistent with ==

Definition Classes
Any

def *(n: Int): String

def +(other: String): String

Implicit
This member is added by an implicit conversion from StringOps toany2stringadd[StringOps] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

def ++(xs: String): String

def ++(suffix: IterableOnce[Char]): String

Alias for concat

Annotations
@inline()

def ++[B >: Char](suffix: Iterable[B]): immutable.IndexedSeq[B]

Alias for concat

Annotations
@inline()

def ++:(prefix: String): String

Alias for prependedAll

Annotations
@inline()

def ++:[B >: Char](prefix: IterableOnce[B]): immutable.IndexedSeq[B]

Alias for prependedAll

Annotations
@inline()

def +:(c: Char): String

Alias for prepended

Annotations
@inline()

def +:[B >: Char](elem: B): immutable.IndexedSeq[B]

Alias for prepended

Annotations
@inline()

def ->[B](y: B): (StringOps, B)

Implicit
This member is added by an implicit conversion from StringOps toArrowAssoc[StringOps] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

def :+(c: Char): String

Alias for appended

Annotations
@inline()

def :+[B >: Char](elem: B): immutable.IndexedSeq[B]

Alias for appended

Annotations
@inline()

def :++(suffix: String): String

Alias for appendedAll

Annotations
@inline()

def :++[B >: Char](suffix: IterableOnce[B]): immutable.IndexedSeq[B]

Alias for appendedAll

Annotations
@inline()

def <(that: String): Boolean

def <=(that: String): Boolean

final def ==(arg0: Any): Boolean

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 the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any

def >(that: String): Boolean

def >=(that: String): Boolean

final def addString(b: mutable.StringBuilder, start: String, sep: String, end: String): mutable.StringBuilder

final def addString(b: mutable.StringBuilder, sep: String): mutable.StringBuilder

Appends this string to a string builder using a separator string.

Annotations
@inline()

final def addString(b: mutable.StringBuilder): mutable.StringBuilder

Appends this string to a string builder.

Annotations
@inline()

def appended(c: Char): String

def appended[B >: Char](elem: B): immutable.IndexedSeq[B]

def appendedAll(suffix: String): String

A copy of the string with another string appended

Annotations
@inline()

def appendedAll[B >: Char](suffix: IterableOnce[B]): immutable.IndexedSeq[B]

A copy of the string with all elements from a collection appended

Annotations
@inline()

def apply(i: Int): Char

Get the char at the specified index.

Annotations
@inline()

final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.

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

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

ClassCastException if the receiver object is not an instance of the erasure of type T0.

def capitalize: String

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

def charStepper: IntStepper with EfficientSplit

Steps over characters in this string. Values are packed in Int for efficiency and compatibility with Java 8 Streams which have an efficient specialization for Int.

Annotations
@inline()

def codePointStepper: IntStepper with EfficientSplit

Steps over code points in this string.

Annotations
@inline()

def collect[B](pf: PartialFunction[Char, B]): immutable.IndexedSeq[B]

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

B

the element type of the returned collection.

pf

the partial function which filters and maps the String.

returns

a new collection resulting from applying the given partial function pf to each char on which it is defined and collecting the results.

def collect(pf: PartialFunction[Char, Char]): String

Builds a new String by applying a partial function to all chars of this String on which the function is defined.

pf

the partial function which filters and maps the String.

returns

a new String resulting from applying the given partial function pf to each char on which it is defined and collecting the results.

def compare(that: String): Int

def concat(suffix: String): String

Returns a new string containing the chars from this string followed by the chars from the right hand operand.

suffix

the string to append.

returns

a new string which contains all chars of this string followed by all chars of suffix.

Annotations
@inline()

def concat(suffix: IterableOnce[Char]): String

Returns a new string containing the chars from this string followed by the chars from the right hand operand.

suffix

the collection to append.

returns

a new string which contains all chars of this string followed by all chars of suffix.

def concat[B >: Char](suffix: IterableOnce[B]): immutable.IndexedSeq[B]

Returns a new collection containing the chars from this string followed by the elements from the right hand operand.

suffix

the collection to append.

returns

a new collection which contains all chars of this string followed by all elements of suffix.

def contains(elem: Char): Boolean

Tests whether this string contains the given character.

elem

the character to test.

returns

true if this string has an element that is equal (as determined by ==) to elem, false otherwise.

def copyToArray(xs: Array[Char], start: Int, len: Int): Int

Copy chars of this string to an array. Fills the given array xs starting at index start with at most len chars. Copying will stop once either the entire string has been copied, or the end of the array is reached or len chars have been copied.

xs

the array to fill.

start

the starting index.

len

the maximal number of elements to copy.

def copyToArray(xs: Array[Char], start: Int): Int

Copy chars of this string to an array. Fills the given array xs starting at index start. Copying will stop once either the entire string has been copied or the end of the array is reached

xs

the array to fill.

start

the starting index.

Annotations
@inline()

def copyToArray(xs: Array[Char]): Int

Copy chars of this string to an array. Fills the given array xs starting at index 0. Copying will stop once either the entire string has been copied or the end of the array is reached

xs

the array to fill.

Annotations
@inline()

def count(p: (Char) => Boolean): Int

def drop(n: Int): String

def dropRight(n: Int): String

def dropWhile(p: (Char) => Boolean): String

Drops longest prefix of chars that satisfy a predicate.

p

The predicate used to test elements.

returns

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

def ensuring(cond: (StringOps) => Boolean, msg: => Any): StringOps

Implicit
This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (StringOps) => Boolean): StringOps

Implicit
This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: => Any): StringOps

Implicit
This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): StringOps

Implicit
This member is added by an implicit conversion from StringOps toEnsuring[StringOps] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def exists(p: (Char) => Boolean): Boolean

def filter(pred: (Char) => Boolean): String

def filterNot(pred: (Char) => Boolean): String

Selects all chars of this string which do not satisfy a predicate.

Annotations
@inline()

def find(p: (Char) => Boolean): Option[Char]

Finds the first char of the string satisfying a predicate, if any.

p

the predicate used to test elements.

returns

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

def flatMap(f: (Char) => String): String

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

f

the function to apply to each char.

returns

a new string resulting from applying the given string-valued function f to each char of this string and concatenating the results.

def flatMap[B](f: (Char) => IterableOnce[B]): immutable.IndexedSeq[B]

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

f

the function to apply to each char.

returns

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

def fold[A1 >: Char](z: A1)(op: (A1, A1) => A1): A1

Folds the chars of this string using the specified associative binary operator.

A1

a type parameter for the binary operator, a supertype of Char.

z

a neutral element for the fold operation; may be added to the result an arbitrary number of times, and must not change the result (e.g., Nil for list concatenation, 0 for addition, or 1 for multiplication).

op

a binary operator that must be associative.

returns

the result of applying the fold operator op between all the chars and z, or z if this string is empty.

Annotations
@inline()

def foldLeft[B](z: B)(op: (B, Char) => B): B

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

B

the result type of the binary operator.

z

the start value.

op

the binary operator.

returns

the result of inserting op between consecutive chars of this string, going left to right with the start value z on the left:

op(...op(z, x_1), x_2, ..., x_n)

where x1, ..., xn are the chars of this string. Returns z if this string is empty.

def foldRight[B](z: B)(op: (Char, B) => B): B

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

B

the result type of the binary operator.

z

the start value.

op

the binary operator.

returns

the result of inserting op between consecutive chars of this string, going right to left with the start value z on the right:

op(x_1, op(x_2, ... op(x_n, z)...))

where x1, ..., xn are the chars of this string. Returns z if this string is empty.

def forall(f: (Char) => Boolean): Boolean

Tests whether a predicate holds for all chars of this string.

returns

true if this string is empty or the given predicate p holds for all chars of this string, otherwise false.

def foreach[U](f: (Char) => U): Unit

Apply f to each element for its side effects. Note: [U] parameter needed to help scalac's type inference.

def format(args: Any*): String

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.

args

the arguments used to instantiating the pattern.

Exceptions thrown

def formatLocal(l: Locale, args: Any*): String

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.

l

an instance of java.util.Locale

args

the arguments used to instantiating the pattern.

Exceptions thrown

def formatted(fmtstr: String): String

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

Implicit
This member is added by an implicit conversion from StringOps toStringFormat[StringOps] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def getClass(): Class[_ <: AnyVal]

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
AnyValAny

def grouped(size: Int): Iterator[String]

Partitions elements in fixed size strings.

size

the number of elements per group

returns

An iterator producing strings of size size, except the last will be less than size size if the elements don't divide evenly.

See also

scala.collection.Iterator, method grouped

Selects the first char of this string.

returns

the first char of this string.

Exceptions thrown

NoSuchElementException if the string is empty.

def headOption: Option[Char]

Optionally selects the first char.

returns

the first char of this string if it is nonempty, None if it is empty.

def indexWhere(p: (Char) => Boolean, from: Int = 0): Int

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

p

the predicate used to test elements.

from

the start index

returns

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

def indices: Range

Produces the range of all indices of this string.

returns

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

def init: String

def inits: Iterator[String]

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

returns

an iterator over all the inits of this string

final def isInstanceOf[T0]: Boolean

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

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

returns

true if the receiver object is an instance of erasure of type T0; false otherwise.

Definition Classes
Any

def iterator: Iterator[Char]

def knownSize: Int

Annotations
@inline()

def last: Char

Selects the last char of this string.

returns

the last char of this string.

Exceptions thrown

NoSuchElementException if the string is empty.

def lastIndexWhere(p: (Char) => Boolean, end: Int = Int.MaxValue): Int

Finds index of the last char satisfying some predicate before or at some end index.

p

the predicate used to test elements.

end

the end index

returns

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

def lastOption: Option[Char]

Optionally selects the last char.

returns

the last char of this string if it is nonempty, None if it is empty.

def lazyZip[B](that: Iterable[B]): LazyZip2[Char, B, String]

Analogous to zip except that the elements in each collection are not consumed until a strict operation is invoked on the returned LazyZip2 decorator.

Calls to lazyZip can be chained to support higher arities (up to 4) without incurring the expense of constructing and deconstructing intermediary tuples.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
B

the type of the second element in each eventual pair

that

the iterable providing the second element of each eventual pair

returns

a decorator LazyZip2 that allows strict operations to be performed on the lazily evaluated pairs or chained calls to lazyZip. Implicit conversion to Iterable[(A, B)] is also supported.

def lengthCompare(len: Int): Int

def lengthIs: Int

def linesIterator: Iterator[String]

Lines in this string, where a line is terminated by "\n", "\r", "\r\n", or the end of the string. A line may be empty. Line terminators are removed.

def linesWithSeparators: Iterator[String]

Return an iterator of all lines embedded in this string, including trailing line separator characters.

The empty string yields an empty iterator.

def map(f: (Char) => Char): String

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

f

the function to apply to each char.

returns

a new string resulting from applying the given function f to each char of this string and collecting the results.

def map[B](f: (Char) => B): immutable.IndexedSeq[B]

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

f

the function to apply to each char.

returns

a new collection resulting from applying the given function f to each char of this string and collecting the results.

final def mkString: String

Returns this string

Annotations
@inline()

final def mkString(sep: String): String

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

sep

the separator string.

returns

In the resulting string the chars of this string are separated by the string sep.

Annotations
@inline()

final def mkString(start: String, sep: String, end: String): String

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

start

the starting string.

sep

the separator string.

end

the ending string.

returns

The resulting string begins with the string start and ends with the string end. Inside, the string chars of this string are separated by the string sep.

def nonEmpty: Boolean

Tests whether the string is not empty.

Annotations
@inline()

def padTo(len: Int, elem: Char): String

Returns a string with a char appended until a given target length is reached.

len

the target length

elem

the padding value

returns

a string consisting of this string followed by the minimal number of occurrences of elem so that the resulting string has a length of at least len.

def padTo[B >: Char](len: Int, elem: B): immutable.IndexedSeq[B]

Returns a collection with an element appended until a given target length is reached.

len

the target length

elem

the padding value

returns

a collection consisting of this string followed by the minimal number of occurrences of elem so that the resulting collection has a length of at least len.

def partition(p: (Char) => Boolean): (String, String)

def partitionMap(f: (Char) => Either[Char, Char]): (String, String)

Applies a function f to each character of the string and returns a pair of strings: the first one made of those characters returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

Example:

val xs = "1one2two3three" partitionMap { c =>
  if (c > 'a') Left(c) else Right(c)
}
// xs == ("onetwothree", "123")
f

the 'split function' mapping the elements of this string to an scala.util.Either

returns

a pair of strings: the first one made of those characters returned by f that were wrapped in scala.util.Left, and the second one made of those wrapped in scala.util.Right.

def patch(from: Int, other: String, replaced: Int): String

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

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original string appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.

from

the index of the first replaced char

other

the replacement string

replaced

the number of chars to drop in the original string

returns

a new string consisting of all chars of this string except that replaced chars starting from from are replaced by other.

def patch(from: Int, other: IterableOnce[Char], replaced: Int): String

Produces a new collection where a slice of characters in this string is replaced by another collection.

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original string appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.

from

the index of the first replaced char

other

the replacement string

replaced

the number of chars to drop in the original string

returns

a new string consisting of all chars of this string except that replaced chars starting from from are replaced by other.

def patch[B >: Char](from: Int, other: IterableOnce[B], replaced: Int): immutable.IndexedSeq[B]

Produces a new collection where a slice of characters in this string is replaced by another collection.

Patching at negative indices is the same as patching starting at 0. Patching at indices at or larger than the length of the original string appends the patch to the end. If more values are replaced than actually exist, the excess is ignored.

from

the index of the first replaced char

other

the replacement collection

replaced

the number of chars to drop in the original string

returns

a new collection consisting of all chars of this string except that replaced chars starting from from are replaced by other.

def prepended(c: Char): String

def prepended[B >: Char](elem: B): immutable.IndexedSeq[B]

def prependedAll(prefix: String): String

def prependedAll[B >: Char](prefix: IterableOnce[B]): immutable.IndexedSeq[B]

def r(groupNames: String*): Regex

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".

groupNames

The names of the groups in the pattern, in the order they appear.

def r: Regex

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.

def replaceAllLiterally(literal: String, replacement: String): String

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

literal

the string which should be replaced everywhere it occurs

replacement

the replacement string

returns

the resulting string

def reverse: String

def reverseIterator: Iterator[Char]

An iterator yielding chars in reversed order.

Note: xs.reverseIterator is the same as xs.reverse.iterator but implemented more efficiently.

returns

an iterator yielding the chars of this string in reversed order

def size: Int

Annotations
@inline()

def sizeCompare(otherSize: Int): Int

def sizeIs: Int

def slice(from: Int, until: Int): String

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

from <= indexOf(x) < until
from

the lowest index to include from this string.

until

the lowest index to EXCLUDE from this string.

returns

a string containing the elements greater than or equal to index from extending up to (but not including) index until of this string.

def span(p: (Char) => Boolean): (String, String)

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

Note: c span p is equivalent to (but 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 string whose chars all satisfy p, and the rest of this string.

def split(separators: Array[Char]): Array[String]

Annotations
@throws(classOf[java.util.regex.PatternSyntaxException])

def split(separator: Char): Array[String]

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)

separator

the character used as a delimiter

Example:
    "a.b".split('.') //returns Array("a", "b")
    
    //splitting the empty string always returns the array with a single
    //empty string
    "".split('.') //returns Array("")
    
    //only trailing empty substrings are removed
    "a.".split('.') //returns Array("a")
    ".a.".split('.') //returns Array("", "a")
    "..a..".split('.') //returns Array("", "", "a")
    
    //all parts are empty and trailing
    ".".split('.') //returns Array()
    "..".split('.') //returns Array()
    
    //surrogate pairs
    val high = 0xD852.toChar
    val low = 0xDF62.toChar
    val highstring = high.toString
    val lowstring = low.toString
    
    //well-formed surrogate pairs are not split
    val highlow = highstring + lowstring
    highlow.split(high) //returns Array(highlow)
    
    //bare surrogate characters are split
    val bare = "_" + highstring + "_"
    bare.split(high) //returns Array("_", "_")

def splitAt(n: Int): (String, String)

Splits this string into two at a given position. Note: c splitAt n is equivalent to (c take n, c drop n).

n

the position at which to split.

returns

a pair of strings consisting of the first n chars of this string, and the other chars.

def stepper: IntStepper with EfficientSplit

Stepper can be used with Java 8 Streams. This method is equivalent to a call to charStepper. See also codePointStepper.

Annotations
@inline()

def stripLineEnd: String

Strip the trailing line separator from this string if there is one. The line separator is taken as "\n", "\r", or "\r\n".

def stripMargin: String

For every line in this string:

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

def stripMargin(marginChar: Char): String

For every line in this string:

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

def stripPrefix(prefix: String): String

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

def stripSuffix(suffix: String): String

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

def tail: String

def tails: Iterator[String]

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

returns

an iterator over all the tails of this string

def take(n: Int): String

def takeRight(n: Int): String

def takeWhile(p: (Char) => Boolean): String

def toArray[B >: Char](implicit tag: ClassTag[B]): Array[B]

def toBoolean: Boolean

Exceptions thrown

java.lang.IllegalArgumentException If the string does not contain a parsable Boolean.

def toBooleanOption: Option[Boolean]

Try to parse as a Boolean

returns

Some(true) if the string is "true" case insensitive, Some(false) if the string is "false" case insensitive, and None if the string is anything else

Exceptions thrown

java.lang.NullPointerException if the string is null

def toByte: Byte

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

Exceptions thrown

java.lang.NumberFormatException If the string does not contain a parsable Byte.

def toByteOption: Option[Byte]

Try to parse as a Byte

returns

Some(value) if the string contains a valid byte value, otherwise None

Exceptions thrown

java.lang.NullPointerException if the string is null

def toDouble: Double

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

Exceptions thrown

java.lang.NullPointerException If the string is null.

java.lang.NumberFormatException If the string does not contain a parsable Double.

def toDoubleOption: Option[Double]

Try to parse as a Double

returns

Some(value) if the string is a parsable Double, None otherwise

Exceptions thrown

java.lang.NullPointerException If the string is null

def toFloat: Float

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

Exceptions thrown

java.lang.NullPointerException If the string is null.

java.lang.NumberFormatException If the string does not contain a parsable Float.

def toFloatOption: Option[Float]

Try to parse as a Float

returns

Some(value) if the string is a parsable Float, None otherwise

Exceptions thrown

java.lang.NullPointerException If the string is null

def toInt: Int

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

Exceptions thrown

java.lang.NumberFormatException If the string does not contain a parsable Int.

def toIntOption: Option[Int]

Try to parse as an Int

returns

Some(value) if the string contains a valid Int value, otherwise None

Exceptions thrown

java.lang.NullPointerException if the string is null

def toLong: Long

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

Exceptions thrown

java.lang.NumberFormatException If the string does not contain a parsable Long.

def toLongOption: Option[Long]

Try to parse as a Long

returns

Some(value) if the string contains a valid long value, otherwise None

Exceptions thrown

java.lang.NullPointerException if the string is null

def toShort: Short

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

Exceptions thrown

java.lang.NumberFormatException If the string does not contain a parsable Short.

def toShortOption: Option[Short]

Try to parse as a Short

returns

Some(value) if the string contains a valid short value, otherwise None

Exceptions thrown

java.lang.NullPointerException if the string is null

def toString(): String

Returns a string representation of the object.

The default representation is platform dependent.

returns

a string representation of the object.

Definition Classes
Any

def updated(index: Int, elem: Char): String

A copy of this string with one single replaced element.

index

the position of the replacement

elem

the replacing element

returns

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

Exceptions thrown

IndexOutOfBoundsException if index does not satisfy 0 <= index < length.

def view: StringView

Annotations
@inline()

def withFilter(p: (Char) => Boolean): StringOps.WithFilter

Creates a non-strict filter of this string.

Note: the difference between c filter p and c withFilter p is that the former creates a new string, 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 stringOps.WithFilter, which supports map, flatMap, foreach, and withFilter operations. All these operations apply to those chars of this string which satisfy the predicate p.

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/StringOps.html