Regex

Type Members

class Match extends MatchData

Provides information about a successful match.
trait MatchData extends AnyRef

This class provides methods to access the details of a match.
class MatchIterator extends AbstractIterator[String] with Iterator[String] with MatchData

A class to step through a sequence of regex matches.
A class to step through a sequence of regex matches.
All methods inherited from scala.util.matching.Regex.MatchData will throw a java.lang.IllegalStateException until the matcher is initialized. The matcher can be initialized by calling hasNext or next() or causing these methods to be called, such as by invoking toString or iterating through the iterator's elements.

See also
java.util.regex.Matcher

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ##(): Int

Equivalent to x.hashCode except for boxed numeric types and null.
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
AnyRef → Any
final def ==(arg0: Any): Boolean

The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
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
AnyRef → Any

object Groups

An extractor object that yields the groups in the match.

An extractor object that yields the groups in the match. Using this extractor rather than the original Regex ensures that the match is not recomputed.

import scala.util.matching.Regex.Groups

val date = """(\d\d\d\d)-(\d\d)-(\d\d)""".r
val text = "The doc spree happened on 2011-07-15."
val day = date replaceAllIn(text, _ match { case Groups(_, month, day) => s"$month/$day" })

object Match

An extractor object for Matches, yielding the matched string.
An extractor object for Matches, yielding the matched string.
This can be used to help writing replacer functions when you are not interested in match data. For example:
```
import scala.util.matching.Regex.Match
"""\w+""".r replaceAllIn ("A simple example.", _ match { case Match(s) => s.toUpperCase })
```
final def asInstanceOf[T0]: T0

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

Definition Classes
Any
Exceptions thrown
ClassCastException if the receiver object is not an instance of the erasure of type T0.
def clone(): AnyRef

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
Note
not specified by SLS as a member of AnyRef
final def eq(arg0: AnyRef): Boolean

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

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note
not specified by SLS as a member of AnyRef
final def getClass(): Class[_]

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

Definition Classes
AnyRef → Any
Note
not specified by SLS as a member of AnyRef
def hashCode(): Int

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

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

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

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

Definition Classes
AnyRef
final 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.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
final 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.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
def quote(text: String): String

Quotes strings to be used literally in regex patterns.
Quotes strings to be used literally in regex patterns.
All regex metacharacters in the input match themselves literally in the output.
Example:
1. List("US$", "CAN$").map(Regex.quote).mkString("|").r
def quoteReplacement(text: String): String

Quotes replacement strings to be used in replacement methods.
Quotes replacement strings to be used in replacement methods.
Replacement methods give special meaning to backslashes (\) and dollar signs ($) in replacement strings, so they are not treated as literals. This method escapes these characters so the resulting string can be used as a literal replacement representing the input string.
text
The string one wishes to use as literal replacement.
returns
A string that can be used to replace matches with text.
Example:
1. "CURRENCY".r.replaceAllIn(input, Regex quoteReplacement "US$")
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Ungrouped

class Match extends MatchData

Provides information about a successful match.
trait MatchData extends AnyRef

This class provides methods to access the details of a match.
class MatchIterator extends AbstractIterator[String] with Iterator[String] with MatchData

A class to step through a sequence of regex matches.
A class to step through a sequence of regex matches.
All methods inherited from scala.util.matching.Regex.MatchData will throw a java.lang.IllegalStateException until the matcher is initialized. The matcher can be initialized by calling hasNext or next() or causing these methods to be called, such as by invoking toString or iterating through the iterator's elements.

See also
java.util.regex.Matcher

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
final def ##(): Int

Equivalent to x.hashCode except for boxed numeric types and null.
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
AnyRef → Any
final def ==(arg0: Any): Boolean

The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
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
AnyRef → Any

object Groups

An extractor object that yields the groups in the match.

An extractor object that yields the groups in the match. Using this extractor rather than the original Regex ensures that the match is not recomputed.

import scala.util.matching.Regex.Groups

val date = """(\d\d\d\d)-(\d\d)-(\d\d)""".r
val text = "The doc spree happened on 2011-07-15."
val day = date replaceAllIn(text, _ match { case Groups(_, month, day) => s"$month/$day" })

object Match

An extractor object for Matches, yielding the matched string.
An extractor object for Matches, yielding the matched string.
This can be used to help writing replacer functions when you are not interested in match data. For example:
```
import scala.util.matching.Regex.Match
"""\w+""".r replaceAllIn ("A simple example.", _ match { case Match(s) => s.toUpperCase })
```
final def asInstanceOf[T0]: T0

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

Definition Classes
Any
Exceptions thrown
ClassCastException if the receiver object is not an instance of the erasure of type T0.
def clone(): AnyRef

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
Note
not specified by SLS as a member of AnyRef
final def eq(arg0: AnyRef): Boolean

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

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note
not specified by SLS as a member of AnyRef
final def getClass(): Class[_]

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

Definition Classes
AnyRef → Any
Note
not specified by SLS as a member of AnyRef
def hashCode(): Int

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

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

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

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

Definition Classes
AnyRef
final 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.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
final 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.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
def quote(text: String): String

Quotes strings to be used literally in regex patterns.
Quotes strings to be used literally in regex patterns.
All regex metacharacters in the input match themselves literally in the output.
Example:
1. List("US$", "CAN$").map(Regex.quote).mkString("|").r
def quoteReplacement(text: String): String

Quotes replacement strings to be used in replacement methods.
Quotes replacement strings to be used in replacement methods.
Replacement methods give special meaning to backslashes (\) and dollar signs ($) in replacement strings, so they are not treated as literals. This method escapes these characters so the resulting string can be used as a literal replacement representing the input string.
text
The string one wishes to use as literal replacement.
returns
A string that can be used to replace matches with text.
Example:
1. "CURRENCY".r.replaceAllIn(input, Regex quoteReplacement "US$")
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class Regex | package matching

object Regex extends Serializable

Type Members

class Match extends MatchData

trait MatchData extends AnyRef

class MatchIterator extends AbstractIterator[String] with Iterator[String] with MatchData

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Groups

object Match

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def quote(text: String): String

def quoteReplacement(text: String): String

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

class Match extends MatchData

trait MatchData extends AnyRef

class MatchIterator extends AbstractIterator[String] with Iterator[String] with MatchData

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Groups

object Match

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def quote(text: String): String

def quoteReplacement(text: String): String

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit