Packages

class Match extends MatchData

Provides information about a successful match.

Source
Regex.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Match
  2. MatchData
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

Value Members

  1. 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
  2. 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
  3. 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
  4. 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()
  5. 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
  6. 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
  7. 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
  8. 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.

  9. 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
  10. 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
  11. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
    Note

    not specified by SLS as a member of AnyRef

  12. 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
    MatchMatchData
  13. val end: Int

    The index following the last matched character.

    The index following the last matched character.

    Definition Classes
    MatchMatchData
  14. 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
  15. 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
  16. 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
  17. 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
  18. 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
  19. 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
  20. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  21. def force: Match.this.type

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

  22. final def getClass(): Class[_]

    Returns the runtime class representation of the object.

    Returns the runtime class representation of the object.

    returns

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

    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. 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

    IllegalArgumentException if the requested group name is not defined

  24. 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
  25. def groupCount: Int

    The number of subgroups.

    The number of subgroups.

    Definition Classes
    MatchMatchData
  26. val groupNames: Seq[String]

    The names of the groups, or an empty sequence if none defined

    The names of the groups, or an empty sequence if none defined

    Definition Classes
    MatchMatchData
  27. 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
    Annotations
    @native()
  28. 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
  29. def matched: String

    The matched string, or null if nothing was matched.

    The matched string, or null if nothing was matched.

    Definition Classes
    MatchData
  30. val matcher: Matcher

    Basically, wraps a platform Matcher.

    Basically, wraps a platform Matcher.

    Attributes
    protected[matching]
    Definition Classes
    MatchMatchData
  31. 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
  32. 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

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

  34. val source: CharSequence

    The source from which the match originated

    The source from which the match originated

    Definition Classes
    MatchMatchData
  35. 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
    MatchMatchData
  36. val start: Int

    The index of the first matched character.

    The index of the first matched character.

    Definition Classes
    MatchMatchData
  37. 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
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. 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
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. 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

Deprecated Value Members

  1. 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
    This member is added by an implicit conversion from Match to StringFormat[Match] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from MatchData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Match to any2stringadd[Match]

Inherited by implicit conversion StringFormat from Match to StringFormat[Match]

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

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

Ungrouped