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

/*
 * 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 org.scalactic.Prettifier
import org.scalatest.matchers.{MatchResult, Matcher}

/**
 * This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of
 * the matchers DSL.
 *
 * @author Bill Venners
 * @author Chee Seng
 */
final class MatchPatternWord {

  /**
   * This method enables the following syntax:
   *
   *    * result should matchPattern { case Person("Bob", _) => }
   *               ^
   * 
   */
  inline def apply(right: PartialFunction[Any, _]) =
    ${ org.scalatest.matchers.MatchPatternMacro.matchPatternMatcher('{right}) }

  /**
   * Overrides toString to return "matchPattern"
   */
  override def toString: String = "matchPattern"
}