scala.util.matching.Regex

# Match

#### class Match extends MatchData

Provides information about a succesful match.

Source
  Regex.scala

Linear Supertypes
MatchData, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Match
2. MatchData
3. AnyRef
4. Any

Implicitly

1. by any2stringadd
2. by any2stringfmt
3. by any2ArrowAssoc
4. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new Match(source: CharSequence, matcher: Matcher, groupNames: Seq[String])

### Value Members

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

   Definition Classes
     AnyRef

2. #### final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

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

   Definition Classes
     Any

3. #### 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

4. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from Match to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

5. #### def ->[B](y: B): (Match, B)

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

6. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

7. #### final def ==(arg0: Any): Boolean

   Test two objects for equality.

   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

8. #### def after(i: Int): CharSequence

   The char sequence after last character of match in group `i`, or `null` if nothing was matched for that group

   The char sequence after last character of match in group `i`, or `null` if nothing was matched for that group

   Definition Classes
     MatchData

9. #### def after: CharSequence

   Returns char sequence after last character of match, or `null` if nothing was matched

   Returns char sequence after last character of match, or `null` if nothing was matched

   Definition Classes
     MatchData

10. #### 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`.

11. #### def before(i: Int): CharSequence

    The char sequence before first character of match in group `i`, or `null` if nothing was matched for that group

    The char sequence before first character of match in group `i`, or `null` if nothing was matched for that group

    Definition Classes
      MatchData

12. #### def before: CharSequence

    The char sequence before first character of match, or `null` if nothing was matched

    The char sequence before first character of match, or `null` if nothing was matched

    Definition Classes
      MatchData

13. #### 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

14. #### def end(i: Int): Int

    The index following the last matched character in group `i`

    The index following the last matched character in group `i`

    Definition Classes
      Match → MatchData

15. #### val end: Int

    The index following the last matched character

    The index following the last matched character

    Definition Classes
      Match → MatchData

16. #### def ensuring(cond: (Match) ⇒ Boolean, msg: ⇒ Any): Match

    Implicit information
      This member is added by an implicit conversion from Match to Ensuring[Match] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

17. #### def ensuring(cond: (Match) ⇒ Boolean): Match

    Implicit information
      This member is added by an implicit conversion from Match to Ensuring[Match] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

18. #### def ensuring(cond: Boolean, msg: ⇒ Any): Match

    Implicit information
      This member is added by an implicit conversion from Match to Ensuring[Match] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

19. #### def ensuring(cond: Boolean): Match

    Implicit information
      This member is added by an implicit conversion from Match to Ensuring[Match] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

20. #### final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

    Tests whether the argument (`arg0`) 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

21. #### 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

22. #### 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()
    Note

      not specified by SLS as a member of AnyRef

23. #### def force: Match.this.type

    The match itself with matcher-dependent lazy vals forced, so that match is valid even once matcher is advanced

24. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

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

    Implicit information
      This member is added by an implicit conversion from Match to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

25. #### 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

26. #### def group(id: String): String

    Returns the group with given name

    Returns the group with given name

    id

      The group name

    returns

      The requested group

    Definition Classes
      MatchData
    Exceptions thrown
      NoSuchElementException

      if the requested group name is not defined

27. #### def group(i: Int): String

    The matched string in group `i`, or `null` if nothing was matched

    The matched string in group `i`, or `null` if nothing was matched

    Definition Classes
      MatchData

28. #### def groupCount: Int

    The number of subgroups

    The number of subgroups

    Definition Classes
      Match → MatchData

29. #### val groupNames: Seq[String]

    The names of the groups, or some empty sequence if one defined

    The names of the groups, or some empty sequence if one defined

    Definition Classes
      Match → MatchData

30. #### 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

31. #### 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

32. #### def matched: String

    The matched string, or `null` if nothing was matched

    The matched string, or `null` if nothing was matched

    Definition Classes
      MatchData

33. #### 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

34. #### 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

35. #### 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

36. #### val source: CharSequence

    The source from where the match originated

    The source from where the match originated

    Definition Classes
      Match → MatchData

37. #### def start(i: Int): Int

    The index of the first matched character in group `i`

    The index of the first matched character in group `i`

    Definition Classes
      Match → MatchData

38. #### val start: Int

    The index of the first matched character

    The index of the first matched character

    Definition Classes
      Match → MatchData

39. #### def subgroups: List[String]

    All matched subgroups, i.

    All matched subgroups, i.e. not including group(0)

    Definition Classes
      MatchData

40. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

41. #### def toString(): String

    The matched string; equivalent to `matched.toString`

    The matched string; equivalent to `matched.toString`

    returns

      a String representation of the object.

    Definition Classes
      MatchData → AnyRef → Any

42. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

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

    Definition Classes
      AnyRef
    Annotations
      @throws()

44. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

45. #### def →[B](y: B): (Match, B)

    Implicit information
      This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implict Value Members

1. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Match to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (match: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Match to StringFormat performed by method any2stringfmt in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (match: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: Match

   Implicit information
     This member is added by an implicit conversion from Match to ArrowAssoc[Match] performed by method any2ArrowAssoc in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (match: ArrowAssoc[Match]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: Match

   Implicit information
     This member is added by an implicit conversion from Match to Ensuring[Match] performed by method any2Ensuring in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (match: Ensuring[Match]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from MatchData

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from Match to StringAdd

### Inherited by implicit conversion any2stringfmt from Match to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from Match to ArrowAssoc[Match]

### Inherited by implicit conversion any2Ensuring from Match to Ensuring[Match]

### Ungrouped