org.scalatest.matchers.dsl.ResultOfRegexWordApplication.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalatest-app_3 Show documentation

scalatest-app

The newest version!

/*
 * Copyright 2001-2013 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalatest.matchers.dsl

import scala.util.matching.Regex

/**
 * This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of
 * the matchers DSL.
 *
 * 
 * The primary constructor enables the following syntax (with a passed scala.util.matching.Regex): 
 * 
 *
 *  * "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""".r)
 *                               ^
 * 
 *
 * @author Bill Venners
 */
final class ResultOfRegexWordApplication(val regex: Regex, val groups: IndexedSeq[String]) {

  /**
   * This auxiliary constructor enables the following syntax (with a passed java.lang.String): 
   *
   *    * "eight" should not fullyMatch regex ("""(-)?(\d+)(\.\d*)?""")
   *                               ^
   * 
   */
  def this(regexString: String, groups: IndexedSeq[String]) = this(new Regex(regexString), groups)
  
  /**
   * Overrides toString to return regex and groups (if available)
   */
  override def toString: String = "regex (" + "\"" + regex.toString + "\"" + 
    (
      if (groups.isEmpty)
        ""
      else 
        (if (groups.size > 1) " withGroups (" else " withGroup (") + groups.map("\"" + _ + "\"").mkString(", ") + ")"
    ) + ")"
}