class Match extends MatchData
Provides information about a successful match.
- Source
 - Regex.scala
 
- Alphabetic
 - By Inheritance
 
- Match
 - MatchData
 - AnyRef
 - Any
 
- by any2stringadd
 - by StringFormat
 - by Ensuring
 - by ArrowAssoc
 
- Hide All
 - Show All
 
- Public
 - All
 
Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
Test two objects for inequality.
Test two objects for inequality.
- returns
 trueif !(this == that), false otherwise.
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept for boxed numeric types andnull. 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
 a hash value consistent with ==
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        +(other: String): String
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to any2stringadd[Match] performed by method any2stringadd in scala.Predef.
 - Definition Classes
 - any2stringadd
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ->[B](y: B): (Match, B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
 trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        after(i: Int): CharSequence
      
      
      
The char sequence after last character of match in group
i, ornullif nothing was matched for that group.The char sequence after last character of match in group
i, ornullif nothing was matched for that group.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        after: CharSequence
      
      
      
Returns char sequence after last character of match, or
nullif nothing was matched.Returns char sequence after last character of match, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        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 aClassCastExceptionat 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 type.- returns
 the receiver object.
- Definition Classes
 - Any
 - Exceptions thrown
 ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        before(i: Int): CharSequence
      
      
      
The char sequence before first character of match in group
i, ornullif nothing was matched for that group.The char sequence before first character of match in group
i, ornullif nothing was matched for that group.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        before: CharSequence
      
      
      
The char sequence before first character of match, or
nullif nothing was matched.The char sequence before first character of match, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
Create a copy of the receiver object.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        end(i: Int): Int
      
      
      
The index following the last matched character in group
i. - 
      
      
      
        
      
    
      
        
        val
      
      
        end: Int
      
      
      
The index following the last matched character.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Match) ⇒ Boolean, msg: ⇒ Any): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Match) ⇒ Boolean): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean, msg: ⇒ Any): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        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
eqmethod implements an equivalence relation on non-null instances ofAnyRef, and has three additional properties:- It is consistent: for any non-null instances 
xandyof typeAnyRef, multiple invocations ofx.eq(y)consistently returnstrueor consistently returnsfalse. - For any non-null instance 
xof typeAnyRef,x.eq(null)andnull.eq(x)returnsfalse. null.eq(null)returnstrue.
When overriding the
equalsorhashCodemethods, 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
 trueif the argument is a reference to the receiver object;falseotherwise.
- Definition Classes
 - AnyRef
 
 - It is consistent: for any non-null instances 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
The equality method for reference types.
 - 
      
      
      
        
      
    
      
        
        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
finalizemethod is invoked, as well as the interaction betweenfinalizeand non-local returns and exceptions, are all platform dependent. - 
      
      
      
        
      
    
      
        
        def
      
      
        force: Match.this.type
      
      
      
The match itself with matcher-dependent lazy vals forced, so that match is valid even once matcher is advanced.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        formatted(fmtstr: String): String
      
      
      
Returns string formatted according to given
formatstring.Returns string formatted according to given
formatstring. Format strings are as forString.format(@see java.lang.String.format).- Implicit
 - This member is added by an implicit conversion from Match to StringFormat[Match] performed by method StringFormat in scala.Predef.
 - Definition Classes
 - StringFormat
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
Returns the runtime class representation of the object.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        group(id: String): String
      
      
      
Returns the group with the given name.
Returns the group with the given name.
Uses explicit group names when supplied; otherwise, queries the underlying implementation for inline named groups. Not all platforms support inline group names.
- id
 The group name
- returns
 The requested group
- Definition Classes
 - MatchData
 - Exceptions thrown
 IllegalArgumentExceptionif the requested group name is not defined
 - 
      
      
      
        
      
    
      
        
        def
      
      
        group(i: Int): String
      
      
      
The matched string in group
i, ornullif nothing was matched.The matched string in group
i, ornullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        groupCount: Int
      
      
      
The number of subgroups.
 - 
      
      
      
        
      
    
      
        
        val
      
      
        groupNames: Seq[String]
      
      
      
The names of the groups, or an empty sequence if none defined
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
The hashCode method for reference types.
 - 
      
      
      
        
      
    
      
        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 returnfalse, while the expressionList(1).isInstanceOf[List[String]]will returntrue. 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
 trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        matched: String
      
      
      
The matched string, or
nullif nothing was matched.The matched string, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        val
      
      
        matcher: Matcher
      
      
      
Basically, wraps a platform Matcher.
Basically, wraps a platform Matcher.
- Attributes
 - protected[scala.util.matching]
 - Definition Classes
 - Match → MatchData
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
Equivalent to
!(this eq that).Equivalent to
!(this eq that).- returns
 trueif the argument is not a reference to the receiver object;falseotherwise.
- 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
 - Annotations
 - @native()
 - 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
 - Annotations
 - @native()
 - Note
 not specified by SLS as a member of AnyRef
 - 
      
      
      
        
      
    
      
        
        val
      
      
        source: CharSequence
      
      
      
The source from which the match originated
 - 
      
      
      
        
      
    
      
        
        def
      
      
        start(i: Int): Int
      
      
      
The index of the first matched character in group
i. - 
      
      
      
        
      
    
      
        
        val
      
      
        start: Int
      
      
      
The index of the first matched character.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        subgroups: List[String]
      
      
      
All capturing groups, i.e., not including group(0).
All capturing groups, i.e., not including group(0).
- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
The matched string; equivalent to
matched.toString. - 
      
      
      
        
      
    
      
        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
 - 
      
      
      
        
      
    
      
        
        def
      
      
        →[B](y: B): (Match, B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 
 
Inherited from MatchData
Value Members
- 
      
      
      
        
      
    
      
        
        def
      
      
        after(i: Int): CharSequence
      
      
      
The char sequence after last character of match in group
i, ornullif nothing was matched for that group.The char sequence after last character of match in group
i, ornullif nothing was matched for that group.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        after: CharSequence
      
      
      
Returns char sequence after last character of match, or
nullif nothing was matched.Returns char sequence after last character of match, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        before(i: Int): CharSequence
      
      
      
The char sequence before first character of match in group
i, ornullif nothing was matched for that group.The char sequence before first character of match in group
i, ornullif nothing was matched for that group.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        before: CharSequence
      
      
      
The char sequence before first character of match, or
nullif nothing was matched.The char sequence before first character of match, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        group(id: String): String
      
      
      
Returns the group with the given name.
Returns the group with the given name.
Uses explicit group names when supplied; otherwise, queries the underlying implementation for inline named groups. Not all platforms support inline group names.
- id
 The group name
- returns
 The requested group
- Definition Classes
 - MatchData
 - Exceptions thrown
 IllegalArgumentExceptionif the requested group name is not defined
 - 
      
      
      
        
      
    
      
        
        def
      
      
        group(i: Int): String
      
      
      
The matched string in group
i, ornullif nothing was matched.The matched string in group
i, ornullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        matched: String
      
      
      
The matched string, or
nullif nothing was matched.The matched string, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        subgroups: List[String]
      
      
      
All capturing groups, i.e., not including group(0).
All capturing groups, i.e., not including group(0).
- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
The matched string; equivalent to
matched.toString. 
Inherited from AnyRef
Value Members
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
Test two objects for inequality.
Test two objects for inequality.
- returns
 trueif !(this == that), false otherwise.
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept for boxed numeric types andnull. 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
 a hash value consistent with ==
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
 trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
Create a copy of the receiver object.
 - 
      
      
      
        
      
    
      
        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
eqmethod implements an equivalence relation on non-null instances ofAnyRef, and has three additional properties:- It is consistent: for any non-null instances 
xandyof typeAnyRef, multiple invocations ofx.eq(y)consistently returnstrueor consistently returnsfalse. - For any non-null instance 
xof typeAnyRef,x.eq(null)andnull.eq(x)returnsfalse. null.eq(null)returnstrue.
When overriding the
equalsorhashCodemethods, 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
 trueif the argument is a reference to the receiver object;falseotherwise.
- Definition Classes
 - AnyRef
 
 - It is consistent: for any non-null instances 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
The equality method for reference types.
 - 
      
      
      
        
      
    
      
        
        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
finalizemethod is invoked, as well as the interaction betweenfinalizeand non-local returns and exceptions, are all platform dependent. - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
Returns the runtime class representation of the object.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
The hashCode method for reference types.
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
Equivalent to
!(this eq that).Equivalent to
!(this eq that).- returns
 trueif the argument is not a reference to the receiver object;falseotherwise.
- 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
 - Annotations
 - @native()
 - 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
 - Annotations
 - @native()
 - Note
 not specified by SLS as a member of AnyRef
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        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
 
Inherited from Any
Value Members
- 
      
      
      
        
      
    
      
        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 aClassCastExceptionat 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 type.- returns
 the receiver object.
- Definition Classes
 - Any
 - Exceptions thrown
 ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
 - 
      
      
      
        
      
    
      
        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 returnfalse, while the expressionList(1).isInstanceOf[List[String]]will returntrue. 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
 trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
 - Any
 
 
Inherited by implicit conversion any2stringadd from Match to any2stringadd[Match]
Value Members
- 
      
      
      
        
      
    
      
        
        def
      
      
        +(other: String): String
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to any2stringadd[Match] performed by method any2stringadd in scala.Predef.
 - Definition Classes
 - any2stringadd
 
 
Inherited by implicit conversion StringFormat from Match to StringFormat[Match]
Value Members
- 
      
      
      
        
      
    
      
        
        def
      
      
        formatted(fmtstr: String): String
      
      
      
Returns string formatted according to given
formatstring.Returns string formatted according to given
formatstring. Format strings are as forString.format(@see java.lang.String.format).- Implicit
 - This member is added by an implicit conversion from Match to StringFormat[Match] performed by method StringFormat in scala.Predef.
 - Definition Classes
 - StringFormat
 - Annotations
 - @inline()
 
 
Inherited by implicit conversion Ensuring from Match to Ensuring[Match]
Value Members
- 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Match) ⇒ Boolean, msg: ⇒ Any): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Match) ⇒ Boolean): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean, msg: ⇒ Any): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 
Inherited by implicit conversion ArrowAssoc from Match to ArrowAssoc[Match]
Value Members
- 
      
      
      
        
      
    
      
        
        def
      
      
        ->[B](y: B): (Match, B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        →[B](y: B): (Match, B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 
 
Ungrouped
- 
      
      
      
        
      
    
      
        final 
        def
      
      
        !=(arg0: Any): Boolean
      
      
      
Test two objects for inequality.
Test two objects for inequality.
- returns
 trueif !(this == that), false otherwise.
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ##(): Int
      
      
      
Equivalent to
x.hashCodeexcept for boxed numeric types andnull.Equivalent to
x.hashCodeexcept for boxed numeric types andnull. 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. Fornullreturns a hashcode wherenull.hashCodethrows aNullPointerException.- returns
 a hash value consistent with ==
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        +(other: String): String
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to any2stringadd[Match] performed by method any2stringadd in scala.Predef.
 - Definition Classes
 - any2stringadd
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ->[B](y: B): (Match, B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ==(arg0: Any): Boolean
      
      
      
The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).The expression
x == thatis equivalent toif (x eq null) that eq null else x.equals(that).- returns
 trueif the receiver object is equivalent to the argument;falseotherwise.
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        after(i: Int): CharSequence
      
      
      
The char sequence after last character of match in group
i, ornullif nothing was matched for that group.The char sequence after last character of match in group
i, ornullif nothing was matched for that group.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        after: CharSequence
      
      
      
Returns char sequence after last character of match, or
nullif nothing was matched.Returns char sequence after last character of match, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        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 aClassCastExceptionat 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 type.- returns
 the receiver object.
- Definition Classes
 - Any
 - Exceptions thrown
 ClassCastExceptionif the receiver object is not an instance of the erasure of typeT0.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        before(i: Int): CharSequence
      
      
      
The char sequence before first character of match in group
i, ornullif nothing was matched for that group.The char sequence before first character of match in group
i, ornullif nothing was matched for that group.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        before: CharSequence
      
      
      
The char sequence before first character of match, or
nullif nothing was matched.The char sequence before first character of match, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
Create a copy of the receiver object.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        end(i: Int): Int
      
      
      
The index following the last matched character in group
i. - 
      
      
      
        
      
    
      
        
        val
      
      
        end: Int
      
      
      
The index following the last matched character.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Match) ⇒ Boolean, msg: ⇒ Any): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: (Match) ⇒ Boolean): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean, msg: ⇒ Any): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        ensuring(cond: Boolean): Match
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to Ensuring[Match] performed by method Ensuring in scala.Predef.
 - Definition Classes
 - Ensuring
 
 - 
      
      
      
        
      
    
      
        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
eqmethod implements an equivalence relation on non-null instances ofAnyRef, and has three additional properties:- It is consistent: for any non-null instances 
xandyof typeAnyRef, multiple invocations ofx.eq(y)consistently returnstrueor consistently returnsfalse. - For any non-null instance 
xof typeAnyRef,x.eq(null)andnull.eq(x)returnsfalse. null.eq(null)returnstrue.
When overriding the
equalsorhashCodemethods, 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
 trueif the argument is a reference to the receiver object;falseotherwise.
- Definition Classes
 - AnyRef
 
 - It is consistent: for any non-null instances 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
The equality method for reference types.
 - 
      
      
      
        
      
    
      
        
        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
finalizemethod is invoked, as well as the interaction betweenfinalizeand non-local returns and exceptions, are all platform dependent. - 
      
      
      
        
      
    
      
        
        def
      
      
        force: Match.this.type
      
      
      
The match itself with matcher-dependent lazy vals forced, so that match is valid even once matcher is advanced.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        formatted(fmtstr: String): String
      
      
      
Returns string formatted according to given
formatstring.Returns string formatted according to given
formatstring. Format strings are as forString.format(@see java.lang.String.format).- Implicit
 - This member is added by an implicit conversion from Match to StringFormat[Match] performed by method StringFormat in scala.Predef.
 - Definition Classes
 - StringFormat
 - Annotations
 - @inline()
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
Returns the runtime class representation of the object.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        group(id: String): String
      
      
      
Returns the group with the given name.
Returns the group with the given name.
Uses explicit group names when supplied; otherwise, queries the underlying implementation for inline named groups. Not all platforms support inline group names.
- id
 The group name
- returns
 The requested group
- Definition Classes
 - MatchData
 - Exceptions thrown
 IllegalArgumentExceptionif the requested group name is not defined
 - 
      
      
      
        
      
    
      
        
        def
      
      
        group(i: Int): String
      
      
      
The matched string in group
i, ornullif nothing was matched.The matched string in group
i, ornullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        groupCount: Int
      
      
      
The number of subgroups.
 - 
      
      
      
        
      
    
      
        
        val
      
      
        groupNames: Seq[String]
      
      
      
The names of the groups, or an empty sequence if none defined
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
The hashCode method for reference types.
 - 
      
      
      
        
      
    
      
        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 returnfalse, while the expressionList(1).isInstanceOf[List[String]]will returntrue. 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
 trueif the receiver object is an instance of erasure of typeT0;falseotherwise.
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        matched: String
      
      
      
The matched string, or
nullif nothing was matched.The matched string, or
nullif nothing was matched.- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        
        val
      
      
        matcher: Matcher
      
      
      
Basically, wraps a platform Matcher.
Basically, wraps a platform Matcher.
- Attributes
 - protected[scala.util.matching]
 - Definition Classes
 - Match → MatchData
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
Equivalent to
!(this eq that).Equivalent to
!(this eq that).- returns
 trueif the argument is not a reference to the receiver object;falseotherwise.
- 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
 - Annotations
 - @native()
 - 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
 - Annotations
 - @native()
 - Note
 not specified by SLS as a member of AnyRef
 - 
      
      
      
        
      
    
      
        
        val
      
      
        source: CharSequence
      
      
      
The source from which the match originated
 - 
      
      
      
        
      
    
      
        
        def
      
      
        start(i: Int): Int
      
      
      
The index of the first matched character in group
i. - 
      
      
      
        
      
    
      
        
        val
      
      
        start: Int
      
      
      
The index of the first matched character.
 - 
      
      
      
        
      
    
      
        
        def
      
      
        subgroups: List[String]
      
      
      
All capturing groups, i.e., not including group(0).
All capturing groups, i.e., not including group(0).
- Definition Classes
 - MatchData
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
The matched string; equivalent to
matched.toString. - 
      
      
      
        
      
    
      
        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
 - 
      
      
      
        
      
    
      
        
        def
      
      
        →[B](y: B): (Match, B)
      
      
      
- Implicit
 - This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method ArrowAssoc in scala.Predef.
 - Definition Classes
 - ArrowAssoc
 
 
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int,Float,ArrayorOptionwhich are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collectionand its sub-packages contain Scala's collections frameworkscala.collection.immutable- Immutable, sequential data-structures such asVector,List,Range,HashMaporHashSetscala.collection.mutable- Mutable, sequential data-structures such asArrayBuffer,StringBuilder,HashMaporHashSetscala.collection.concurrent- Mutable, concurrent data-structures such asTrieMapscala.collection.parallel.immutable- Immutable, parallel data-structures such asParVector,ParRange,ParHashMaporParHashSetscala.collection.parallel.mutable- Mutable, parallel data-structures such asParArray,ParHashMap,ParTrieMaporParHashSetscala.concurrent- Primitives for concurrent programming such asFuturesandPromisesscala.io- Input and output operationsscala.math- Basic math functions and additional numeric types likeBigIntandBigDecimalscala.sys- Interaction with other processes and the operating systemscala.util.matching- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect- Scala's reflection API (scala-reflect.jar)scala.xml- XML parsing, manipulation, and serialization (scala-xml.jar)scala.swing- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)scala.util.parsing- Parser combinators (scala-parser-combinators.jar)Automatic imports
Identifiers in the scala package and the
scala.Predefobject are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
Listis an alias forscala.collection.immutable.List.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
Stringis an alias forjava.lang.String.